Package com.linecorp.armeria.client

Class ClientOptionsBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractClientOptionsBuilder

com.linecorp.armeria.client.ClientOptionsBuilder

public final class ClientOptionsBuilder
extends AbstractClientOptionsBuilder

Creates a new ClientOptions using the builder pattern.

See Also:

ClientBuilder

Method Summary

Modifier and Type	Method	Description
ClientOptionsBuilder	addHttpHeader(CharSequence name, Object value)	Adds the specified HTTP header.
ClientOptionsBuilder	addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)	Adds the specified HTTP headers.
ClientOptionsBuilder	auth(BasicToken token)	Sets the HTTP basic access authentication header using HttpHeaderNames.AUTHORIZATION.
ClientOptionsBuilder	auth(OAuth1aToken token)	Sets the OAuth Core 1.0 Revision A header using HttpHeaderNames.AUTHORIZATION.
ClientOptionsBuilder	auth(OAuth2Token token)	Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.
ClientOptions	build()	Returns a newly-created ClientOptions based on the ClientOptionValues of this builder.
ClientOptionsBuilder	decorator(DecoratingHttpClientFunction decorator)	Adds the specified HTTP-level decorator.
ClientOptionsBuilder	decorator(Function<? super HttpClient,? extends HttpClient> decorator)	Adds the specified HTTP-level decorator.
ClientOptionsBuilder	endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)	Sets a Function that remaps an Endpoint into an EndpointGroup.
ClientOptionsBuilder	factory(ClientFactory factory)	Sets the ClientFactory used for creating a client.
ClientOptionsBuilder	maxResponseLength(long maxResponseLength)	Sets the maximum allowed length of a server response in bytes.
<T> ClientOptionsBuilder	option(ClientOption<T> option, T value)	Adds the specified ClientOption and its value.
<T> ClientOptionsBuilder	option(ClientOptionValue<T> optionValue)	Adds the specified ClientOptionValue.
ClientOptionsBuilder	options(ClientOptions options)	Adds the specified ClientOptions.
ClientOptionsBuilder	options(ClientOptionValue<?>... options)	Adds the specified ClientOptionValues.
ClientOptionsBuilder	options(Iterable<ClientOptionValue<?>> options)	Adds the specified ClientOptionValues.
ClientOptionsBuilder	requestIdGenerator(Supplier<RequestId> requestIdGenerator)	Sets the Supplier that generates a RequestId.
ClientOptionsBuilder	responseTimeout(Duration responseTimeout)	Sets the timeout of a response.
ClientOptionsBuilder	responseTimeoutMillis(long responseTimeoutMillis)	Sets the timeout of a response in milliseconds.
ClientOptionsBuilder	rpcDecorator(DecoratingRpcClientFunction decorator)	Adds the specified RPC-level decorator.
ClientOptionsBuilder	rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)	Adds the specified RPC-level decorator.
ClientOptionsBuilder	setHttpHeader(CharSequence name, Object value)	Sets the specified HTTP header.
ClientOptionsBuilder	setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)	Sets the specified HTTP headers.
ClientOptionsBuilder	writeTimeout(Duration writeTimeout)	Sets the timeout of a socket write attempt.
ClientOptionsBuilder	writeTimeoutMillis(long writeTimeoutMillis)	Sets the timeout of a socket write attempt in milliseconds.

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

buildOptions, buildOptions

Methods inherited from class java.lang.Object

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

Method Details

build

public ClientOptions build()

Returns a newly-created ClientOptions based on the ClientOptionValues of this builder.

options

public ClientOptionsBuilder options(ClientOptions options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptions.

Overrides:

options in class AbstractClientOptionsBuilder

options

public ClientOptionsBuilder options(ClientOptionValue<?>... options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

options

public ClientOptionsBuilder options(Iterable<ClientOptionValue<?>> options)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValues.

Overrides:

options in class AbstractClientOptionsBuilder

option

public <T> ClientOptionsBuilder option(ClientOption<T> option, T value)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOption and its value.

Overrides:

option in class AbstractClientOptionsBuilder

option

public <T> ClientOptionsBuilder option(ClientOptionValue<T> optionValue)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified ClientOptionValue.

Overrides:

option in class AbstractClientOptionsBuilder

factory

public ClientOptionsBuilder factory(ClientFactory factory)

Description copied from class: AbstractClientOptionsBuilder

Sets the ClientFactory used for creating a client. The default is ClientFactory.ofDefault().

Overrides:

factory in class AbstractClientOptionsBuilder

writeTimeout

public ClientOptionsBuilder writeTimeout(Duration writeTimeout)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a socket write attempt.

Overrides:

writeTimeout in class AbstractClientOptionsBuilder

Parameters:

writeTimeout - the timeout. 0 disables the timeout.

writeTimeoutMillis

public ClientOptionsBuilder writeTimeoutMillis(long writeTimeoutMillis)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a socket write attempt in milliseconds.

Overrides:

writeTimeoutMillis in class AbstractClientOptionsBuilder

Parameters:

writeTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

responseTimeout

public ClientOptionsBuilder responseTimeout(Duration responseTimeout)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a response.

Overrides:

responseTimeout in class AbstractClientOptionsBuilder

Parameters:

responseTimeout - the timeout. 0 disables the timeout.

responseTimeoutMillis

public ClientOptionsBuilder responseTimeoutMillis(long responseTimeoutMillis)

Description copied from class: AbstractClientOptionsBuilder

Sets the timeout of a response in milliseconds.

Overrides:

responseTimeoutMillis in class AbstractClientOptionsBuilder

Parameters:

responseTimeoutMillis - the timeout in milliseconds. 0 disables the timeout.

maxResponseLength

public ClientOptionsBuilder maxResponseLength(long maxResponseLength)

Description copied from class: AbstractClientOptionsBuilder

Sets the maximum allowed length of a server response in bytes.

Overrides:

maxResponseLength in class AbstractClientOptionsBuilder

Parameters:

maxResponseLength - the maximum length in bytes. 0 disables the limit.

requestIdGenerator

public ClientOptionsBuilder requestIdGenerator(Supplier<RequestId> requestIdGenerator)

Description copied from class: AbstractClientOptionsBuilder

Sets the Supplier that generates a RequestId.

Overrides:

requestIdGenerator in class AbstractClientOptionsBuilder

endpointRemapper

public ClientOptionsBuilder endpointRemapper(Function<? super Endpoint,? extends EndpointGroup> endpointRemapper)

Description copied from class: AbstractClientOptionsBuilder

Sets a Function that remaps an Endpoint into an EndpointGroup. This ClientOption is useful when you need to override a single target host into a group of hosts to enable client-side load-balancing, e.g.

 MyService.Iface client =
     Clients.newClient("tbinary+http://example.com/api",
                       MyService.Iface.class);

 EndpointGroup myGroup = EndpointGroup.of(Endpoint.of("node-1.example.com")),
                                          Endpoint.of("node-2.example.com")));

 MyService.Iface derivedClient =
     Clients.newDerivedClient(client, options -> {
         return options.toBuilder()
                       .endpointRemapper(endpoint -> {
                           if (endpoint.host().equals("example.com")) {
                               return myGroup;
                           } else {
                               return endpoint;
                           }
                       })
                       .build();
     });

 // This request goes to 'node-1.example.com' or 'node-2.example.com'.
 derivedClient.call();
 

Note that the remapping does not occur recursively but only once.

Overrides:

endpointRemapper in class AbstractClientOptionsBuilder

See Also:

ClientOption.ENDPOINT_REMAPPER, ClientOptions.endpointRemapper()

decorator

public ClientOptionsBuilder decorator(Function<? super HttpClient,? extends HttpClient> decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP-level decorator.

Overrides:

decorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the Function that transforms an HttpClient to another

decorator

public ClientOptionsBuilder decorator(DecoratingHttpClientFunction decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP-level decorator.

Overrides:

decorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the DecoratingHttpClientFunction that intercepts an invocation

rpcDecorator

public ClientOptionsBuilder rpcDecorator(Function<? super RpcClient,? extends RpcClient> decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified RPC-level decorator.

Overrides:

rpcDecorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the Function that transforms an RpcClient to another

rpcDecorator

public ClientOptionsBuilder rpcDecorator(DecoratingRpcClientFunction decorator)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified RPC-level decorator.

Overrides:

rpcDecorator in class AbstractClientOptionsBuilder

Parameters:

decorator - the DecoratingRpcClientFunction that intercepts an invocation

addHttpHeader

public ClientOptionsBuilder addHttpHeader(CharSequence name, Object value)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP header.

Overrides:

addHttpHeader in class AbstractClientOptionsBuilder

addHttpHeaders

public ClientOptionsBuilder addHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)

Description copied from class: AbstractClientOptionsBuilder

Adds the specified HTTP headers.

Overrides:

addHttpHeaders in class AbstractClientOptionsBuilder

setHttpHeader

public ClientOptionsBuilder setHttpHeader(CharSequence name, Object value)

Description copied from class: AbstractClientOptionsBuilder

Sets the specified HTTP header.

Overrides:

setHttpHeader in class AbstractClientOptionsBuilder

setHttpHeaders

public ClientOptionsBuilder setHttpHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> httpHeaders)

Description copied from class: AbstractClientOptionsBuilder

Sets the specified HTTP headers.

Overrides:

setHttpHeaders in class AbstractClientOptionsBuilder

auth

public ClientOptionsBuilder auth(BasicToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the HTTP basic access authentication header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public ClientOptionsBuilder auth(OAuth1aToken token)

Description copied from class: AbstractClientOptionsBuilder

Sets the OAuth Core 1.0 Revision A header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder

auth

public ClientOptionsBuilder auth(OAuth2Token token)

Description copied from class: AbstractClientOptionsBuilder

Sets the OAuth 2.0 header using HttpHeaderNames.AUTHORIZATION.

Overrides:

auth in class AbstractClientOptionsBuilder