Package com.linecorp.armeria.client

Class UserClient<I extends Request,O extends Response>

java.lang.Object

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

Type Parameters:

I - the request type

O - the response type

All Implemented Interfaces:

ClientBuilderParams

public abstract class UserClient<I extends Request,O extends Response>
extends Object
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, SessionProtocol sessionProtocol, Endpoint endpoint)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Class<?>	clientType()	Returns the type of the client.
protected <U extends Client<I,O>> U	delegate()	Returns the Client that will process Requests.
protected Endpoint	endpoint()	Returns the Endpoint of the delegate().
protected O	execute(HttpMethod method, String path, String query, String fragment, I req, BiFunction<ClientRequestContext,Throwable,O> fallback)	Executes the specified Request via delegate().
protected O	execute(EventLoop eventLoop, HttpMethod method, String path, String query, String fragment, I req, BiFunction<ClientRequestContext,Throwable,O> fallback)	Executes the specified Request via delegate().
ClientFactory	factory()	Returns the ClientFactory who created the client.
ClientOptions	options()	Returns the options of the client.
protected SessionProtocol	sessionProtocol()	Returns the SessionProtocol of the delegate().
URI	uri()	Returns the endpoint URI of the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserClient

protected UserClient(ClientBuilderParams params,
                     Client<I,O> delegate,
                     MeterRegistry meterRegistry,
                     SessionProtocol sessionProtocol,
                     Endpoint endpoint)

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

sessionProtocol - the SessionProtocol of the Client

endpoint - the Endpoint of the Client

Method Detail

factory

public ClientFactory factory()

Description copied from interface: ClientBuilderParams

Returns the ClientFactory who created the client.

Specified by:

factory in interface ClientBuilderParams

uri

public URI uri()

Description copied from interface: ClientBuilderParams

Returns the endpoint URI of the client.

Specified by:

uri in interface ClientBuilderParams

clientType

public 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

delegate

protected final <U extends Client<I,O>> U delegate()

Returns the Client that will process Requests.

sessionProtocol

protected final SessionProtocol sessionProtocol()

Returns the SessionProtocol of the delegate().

endpoint

protected final Endpoint endpoint()

Returns the Endpoint of the delegate().

execute

protected final O execute(HttpMethod method,
                          String path,
                          @Nullable
                          String query,
                          @Nullable
                          String fragment,
                          I req,
                          BiFunction<ClientRequestContext,Throwable,O> fallback)

Executes the specified Request via 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

fallback - the fallback response BiFunction to use when Client.execute(ClientRequestContext, Request) of delegate() throws an exception instead of returning an error response

execute

protected final O execute(@Nullable
                          EventLoop eventLoop,
                          HttpMethod method,
                          String path,
                          @Nullable
                          String query,
                          @Nullable
                          String fragment,
                          I req,
                          BiFunction<ClientRequestContext,Throwable,O> fallback)

Executes the specified Request via delegate().

Parameters:

eventLoop - the EventLoop to execute 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

fallback - the fallback response BiFunction to use when Client.execute(ClientRequestContext, Request) of delegate() throws