Package com.linecorp.armeria.client

Class DecoratingClientFactory

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<ClientFactory>

com.linecorp.armeria.client.DecoratingClientFactory

All Implemented Interfaces:

ClientFactory, AsyncCloseable, ListenableAsyncCloseable, Unwrappable, AutoCloseable

public class DecoratingClientFactory
extends AbstractUnwrappable<ClientFactory>
implements ClientFactory

A ClientFactory that delegates the creation of Clients to another ClientFactory.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DecoratingClientFactory(ClientFactory delegate)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ReleasableHolder<EventLoop>	acquireEventLoop(SessionProtocol sessionProtocol, EndpointGroup endpointGroup, Endpoint endpoint)	Acquires an EventLoop that is expected to handle a connection to the specified Endpoint.
<T> ClientBuilderParams	clientBuilderParams(T client)	Returns the ClientBuilderParams held in client.
void	close()	Releases any underlying resources held by this object synchronously.
CompletableFuture<?>	closeAsync()	Releases any underlying resources held by this object asynchronously.
EventLoopGroup	eventLoopGroup()	Returns the EventLoopGroup being used by this ClientFactory.
Supplier<EventLoop>	eventLoopSupplier()	Returns a Supplier that provides one of the EventLoops being used by this ClientFactory.
boolean	isClosed()	Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.
boolean	isClosing()	Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.
MeterRegistry	meterRegistry()	Returns the MeterRegistry that collects various stats.
Object	newClient(ClientBuilderParams params)	Creates a new client with the specified ClientBuilderParams.
protected HttpClient	newHttpClient(ClientBuilderParams params)	Creates a new HttpClient which uses the same SessionProtocol, EndpointGroup and ClientOptions with the specified ClientBuilderParams.
int	numConnections()	Returns the number of open connections managed by this ClientFactory.
ClientFactoryOptions	options()	Returns the ClientFactoryOptions that has been used to create this ClientFactory.
void	setMeterRegistry(MeterRegistry meterRegistry)	Sets the MeterRegistry that collects various stats.
Set<Scheme>	supportedSchemes()	Returns the Schemes supported by this ClientFactory.
<T> T	unwrap(Object client, Class<T> type)	Unwraps the specified client object into the object of the specified type.
CompletableFuture<?>	whenClosed()	Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.

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

as, toString, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.ClientFactory

unwrap, validateParams, validateScheme, validateUri

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

as

Constructor Details

DecoratingClientFactory

protected DecoratingClientFactory(ClientFactory delegate)

Creates a new instance.

Method Details

newHttpClient

protected final HttpClient newHttpClient(ClientBuilderParams params)

Creates a new HttpClient which uses the same SessionProtocol, EndpointGroup and ClientOptions with the specified ClientBuilderParams. Note that path and SerializationFormat are always "/" and SerializationFormat.NONE.

supportedSchemes

public Set<Scheme> supportedSchemes()

Description copied from interface: ClientFactory

Returns the Schemes supported by this ClientFactory.

Specified by:

supportedSchemes in interface ClientFactory

eventLoopGroup

public EventLoopGroup eventLoopGroup()

Description copied from interface: ClientFactory

Returns the EventLoopGroup being used by this ClientFactory. Can be used to, e.g., schedule a periodic task without creating a separate event loop. Use ClientFactory.eventLoopSupplier() instead if what you need is an EventLoop rather than an EventLoopGroup.

Specified by:

eventLoopGroup in interface ClientFactory

eventLoopSupplier

public Supplier<EventLoop> eventLoopSupplier()

Description copied from interface: ClientFactory

Returns a Supplier that provides one of the EventLoops being used by this ClientFactory.

Specified by:

eventLoopSupplier in interface ClientFactory

acquireEventLoop

public ReleasableHolder<EventLoop> acquireEventLoop(SessionProtocol sessionProtocol,
EndpointGroup endpointGroup,
@Nullable
Endpoint endpoint)

Description copied from interface: ClientFactory

Acquires an EventLoop that is expected to handle a connection to the specified Endpoint. The caller must release the returned EventLoop back by calling ReleasableHolder.release() so that ClientFactory utilizes EventLoops efficiently.

Specified by:

acquireEventLoop in interface ClientFactory

Parameters:

sessionProtocol - the SessionProtocol of the connection

endpointGroup - the EndpointGroup where endpoint belongs to.

endpoint - the Endpoint where a request is being sent. null if the Endpoint is not known yet.

meterRegistry

public MeterRegistry meterRegistry()

Description copied from interface: ClientFactory

Returns the MeterRegistry that collects various stats.

Specified by:

meterRegistry in interface ClientFactory

setMeterRegistry

public void setMeterRegistry(MeterRegistry meterRegistry)

Description copied from interface: ClientFactory

Sets the MeterRegistry that collects various stats. Note that this method is intended to be used during the initialization phase of an application, so that the application gets a chance to switch to the preferred MeterRegistry implementation. Invoking this method after this factory started to export stats to the old MeterRegistry may result in undocumented behavior.

Specified by:

setMeterRegistry in interface ClientFactory

options

public ClientFactoryOptions options()

Description copied from interface: ClientFactory

Returns the ClientFactoryOptions that has been used to create this ClientFactory.

Specified by:

options in interface ClientFactory

newClient

public Object newClient(ClientBuilderParams params)

Description copied from interface: ClientFactory

Creates a new client with the specified ClientBuilderParams. The client instance returned by this method must be an instance of ClientBuilderParams.clientType().

Specified by:

newClient in interface ClientFactory

clientBuilderParams

public <T> ClientBuilderParams clientBuilderParams(T client)

Description copied from interface: ClientFactory

Returns the ClientBuilderParams held in client. This is used when creating a new derived Client which inherits ClientBuilderParams from client. If this ClientFactory does not know how to handle the ClientBuilderParams for the provided client, it should return null.

Specified by:

clientBuilderParams in interface ClientFactory

unwrap

public <T> T unwrap(Object client,
Class<T> type)

Description copied from interface: ClientFactory

Unwraps the specified client object into the object of the specified type. For example,

 ClientFactory clientFactory = ...;
 WebClient client = WebClient.builder(...)
                             .factory(clientFactory)
                             .decorator(LoggingClient.newDecorator())
                             .build();

 LoggingClient unwrapped = clientFactory.unwrap(client, LoggingClient.class);

 // If the client implements Unwrappable, you can just use the 'as()' method.
 LoggingClient unwrapped2 = client.as(LoggingClient.class);
 

Specified by:

unwrap in interface ClientFactory

Parameters:

client - the client object

type - the type of the object to return

Returns:

the object of the specified type if found, or null if not found.

See Also:

Client.as(Class), Clients.unwrap(Object, Class), Unwrappable

isClosing

public boolean isClosing()

Description copied from interface: ListenableAsyncCloseable

Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.

Specified by:

isClosing in interface ListenableAsyncCloseable

See Also:

ListenableAsyncCloseable.isClosed()

isClosed

public boolean isClosed()

Description copied from interface: ListenableAsyncCloseable

Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.

Specified by:

isClosed in interface ListenableAsyncCloseable

See Also:

ListenableAsyncCloseable.isClosing()

whenClosed

public CompletableFuture<?> whenClosed()

Description copied from interface: ListenableAsyncCloseable

Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.

Specified by:

whenClosed in interface ListenableAsyncCloseable

closeAsync

public CompletableFuture<?> closeAsync()

Description copied from interface: AsyncCloseable

Releases any underlying resources held by this object asynchronously.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

the CompletableFuture which is completed after the resources are released

close

public void close()

Description copied from interface: AsyncCloseable

Releases any underlying resources held by this object synchronously.

Specified by:

close in interface AsyncCloseable

Specified by:

close in interface AutoCloseable

numConnections

public int numConnections()

Description copied from interface: ClientFactory

Returns the number of open connections managed by this ClientFactory.

Specified by:

numConnections in interface ClientFactory