com.linecorp.armeria.client

Class DecoratingClientFactory

java.lang.Object

com.linecorp.armeria.client.AbstractClientFactory

com.linecorp.armeria.client.DecoratingClientFactory

All Implemented Interfaces:

ClientFactory, AutoCloseable

public class DecoratingClientFactory
extends AbstractClientFactory

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

Field Summary

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

DEFAULT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ReleasableHolder<io.netty.channel.EventLoop>	acquireEventLoop(Endpoint endpoint, SessionProtocol sessionProtocol) Acquires an EventLoop that is expected to handle a connection to the specified Endpoint.
<T> Optional<ClientBuilderParams>	clientBuilderParams(T client) Returns the ClientBuilderParams held in client.
void	close() Closes all clients managed by this factory and shuts down the EventLoopGroup created implicitly by this factory.
protected ClientFactory	delegate() Returns the delegate ClientFactory.
io.netty.channel.EventLoopGroup	eventLoopGroup() Returns the EventLoopGroup being used by this ClientFactory.
Supplier<io.netty.channel.EventLoop>	eventLoopSupplier() Returns a Supplier that provides one of the EventLoops being used by this ClientFactory.
MeterRegistry	meterRegistry() Returns the MeterRegistry that collects various stats.
<T> T	newClient(Scheme scheme, Endpoint endpoint, String path, Class<T> clientType, ClientOptions options) Creates a new client that connects to the specified Endpoint with the Scheme and path.
<T> T	newClient(URI uri, Class<T> clientType, ClientOptions options) Creates a new client that connects to the specified URI.
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> Optional<T>	unwrap(Object client, Class<T> type) Unwraps the specified client object into the object of the specified type.

Methods inherited from class com.linecorp.armeria.client.AbstractClientFactory

newClient, newClient, newClient, newClient, newClient, newClient, newEndpoint, validateScheme, validateScheme

Methods inherited from class java.lang.Object

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

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

builder, closeDefault, disableShutdownHook, ofDefault

Constructor Detail

DecoratingClientFactory

protected DecoratingClientFactory(ClientFactory delegate)

Creates a new instance.

Method Detail

delegate

protected ClientFactory delegate()

Returns the delegate ClientFactory.

supportedSchemes

public Set<Scheme> supportedSchemes()

Description copied from interface: ClientFactory

Returns the Schemes supported by this ClientFactory.

eventLoopGroup

public io.netty.channel.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.

eventLoopSupplier

public Supplier<io.netty.channel.EventLoop> eventLoopSupplier()

Description copied from interface: ClientFactory

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

acquireEventLoop

public ReleasableHolder<io.netty.channel.EventLoop> acquireEventLoop(Endpoint endpoint,
                                                                     SessionProtocol sessionProtocol)

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.

meterRegistry

public MeterRegistry meterRegistry()

Description copied from interface: ClientFactory

Returns the MeterRegistry that collects various stats.

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.

options

public ClientFactoryOptions options()

Description copied from interface: ClientFactory

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

newClient

public <T> T newClient(URI uri,
                       Class<T> clientType,
                       ClientOptions options)

Description copied from interface: ClientFactory

Creates a new client that connects to the specified URI.

Parameters:

uri - the URI of the server endpoint

clientType - the type of the new client

options - the ClientOptions

newClient

public <T> T newClient(Scheme scheme,
                       Endpoint endpoint,
                       @Nullable
                       String path,
                       Class<T> clientType,
                       ClientOptions options)

Description copied from interface: ClientFactory

Creates a new client that connects to the specified Endpoint with the Scheme and path.

Parameters:

scheme - the Scheme for the endpoint

endpoint - the server Endpoint

path - the service path

clientType - the type of the new client

options - the ClientOptions

clientBuilderParams

public <T> Optional<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 Optional.empty().

unwrap

public <T> Optional<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).get();

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

Parameters:

client - the client object

type - the type of the object to return

Returns:

the object of the specified type if found. Optional.empty() if not found.

See Also:

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

close

public void close()

Description copied from interface: ClientFactory

Closes all clients managed by this factory and shuts down the EventLoopGroup created implicitly by this factory.