java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Client<I,O>>

com.linecorp.armeria.client.UserClient<I,O>

Type Parameters:: I - the request type; O - the response type

All Implemented Interfaces:: ClientBuilderParams, Unwrappable

public abstract class UserClient<I extends Request,O extends Response>
extends AbstractUnwrappable<Client<I,O>>
implements ClientBuilderParams

A base class for implementing a user's entry point for sending a Request.

It provides the utility methods for easily forwarding a Request from a user to a Client.

Note that this class is not a subtype of Client, although its name may mislead.

Constructor Summary

Constructors

Modifier Constructor Description

protected UserClient(ClientBuilderParams params, Client<I,O> delegate, MeterRegistry meterRegistry)
Creates a new instance.

Method Summary

Modifier and Type	Method	Description
`String`	`absolutePathRef()`	Returns the `String` that consists of path, query string and fragment.
`Class<?>`	`clientType()`	Returns the type of the client.
`EndpointGroup`	`endpointGroup()`	Returns the `EndpointGroup` of the client.
`protected O`	`execute(EndpointGroup endpointGroup, HttpMethod method, String path, String query, String fragment, I req, BiFunction<ClientRequestContext,Throwable,O> fallbackResponseFactory)`	Executes the specified `Request` via `AbstractUnwrappable.delegate()`.
`protected O`	`execute(HttpMethod method, String path, String query, String fragment, I req, BiFunction<ClientRequestContext,Throwable,O> fallbackResponseFactory)`	Executes the specified `Request` via `AbstractUnwrappable.delegate()`.
`ClientOptions`	`options()`	Returns the options of the client.
`Scheme`	`scheme()`	Returns the `Scheme` of the client.
`URI`	`uri()`	Returns the endpoint URI of the client.

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, delegate, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- UserClient
  
  protected UserClient(ClientBuilderParams params, Client<I,O> delegate, MeterRegistry meterRegistry)
  
  Creates a new instance.
  
  Parameters:
  
  params - the parameters used for constructing the client
  
  delegate - the Client that will process Requests
  
  meterRegistry - the MeterRegistry that collects various stats
Method Details
- scheme
  
  public final Scheme scheme()
  
  Description copied from interface: ClientBuilderParams
  
  Returns the Scheme of the client.
  
  Specified by:
  
  scheme in interface ClientBuilderParams
- endpointGroup
  
  public final EndpointGroup endpointGroup()
  
  Description copied from interface: ClientBuilderParams
  
  Returns the EndpointGroup of the client.
  
  Specified by:
  
  endpointGroup in interface ClientBuilderParams
- absolutePathRef
  
  public final String absolutePathRef()
  
  Description copied from interface: ClientBuilderParams
  
  Returns the String that consists of path, query string and fragment.
  
  Specified by:
  
  absolutePathRef in interface ClientBuilderParams
- uri
  
  public final URI uri()
  
  Description copied from interface: ClientBuilderParams
  
  Returns the endpoint URI of the client.
  
  Specified by:
  
  uri in interface ClientBuilderParams
- clientType
  
  public final Class<?> clientType()
  
  Description copied from interface: ClientBuilderParams
  
  Returns the type of the client.
  
  Specified by:
  
  clientType in interface ClientBuilderParams
- options
  
  public final ClientOptions options()
  
  Description copied from interface: ClientBuilderParams
  
  Returns the options of the client.
  
  Specified by:
  
  options in interface ClientBuilderParams
- execute
  
  protected final O execute(HttpMethod method, String path, @Nullable String query, @Nullable String fragment, I req, BiFunction<ClientRequestContext,Throwable,O> fallbackResponseFactory)
  
  Executes the specified Request via AbstractUnwrappable.delegate().
  
  Parameters:
  
  method - the method of the Request
  
  path - the path part of the Request URI
  
  query - the query part of the Request URI
  
  fragment - the fragment part of the Request URI
  
  req - the Request
  
  fallbackResponseFactory - the fallback response BiFunction to use when Client.execute(ClientRequestContext, Request) of AbstractUnwrappable.delegate() throws an exception instead of returning an error response
- execute
  
  protected final O execute(EndpointGroup endpointGroup, HttpMethod method, String path, @Nullable String query, @Nullable String fragment, I req, BiFunction<ClientRequestContext,Throwable,O> fallbackResponseFactory)
  
  Executes the specified Request via AbstractUnwrappable.delegate().
  
  Parameters:
  
  endpointGroup - the EndpointGroup of the Request
  
  method - the method of the Request
  
  path - the path part of the Request URI
  
  query - the query part of the Request URI
  
  fragment - the fragment part of the Request URI
  
  req - the Request
  
  fallbackResponseFactory - the fallback response BiFunction to use when Client.execute(ClientRequestContext, Request) of AbstractUnwrappable.delegate() throws an exception instead of returning an error response

Class UserClient<I extends Request,​O extends Response>

Constructor Summary

Method Summary

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

Methods inherited from class java.lang.Object

Constructor Details

Method Details

Class UserClient<I extends Request,O extends Response>