com.linecorp.armeria.client

Class ClientOptionsBuilder

java.lang.Object

com.linecorp.armeria.client.ClientOptionsBuilder

public final class ClientOptionsBuilder
extends Object

Creates a new ClientOptions using the builder pattern.

See Also:

ClientBuilder

Constructor Summary

Constructors

Constructor and Description
ClientOptionsBuilder() Deprecated. Use ClientOptions.builder().
ClientOptionsBuilder(ClientOptions options) Deprecated. Use ClientOptions.toBuilder().

Method Summary

Modifier and Type	Method and 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.
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	defaultMaxResponseLength(long maxResponseLength) Deprecated.
ClientOptionsBuilder	defaultResponseTimeout(Duration responseTimeout) Deprecated.
ClientOptionsBuilder	defaultResponseTimeoutMillis(long responseTimeoutMillis) Deprecated.
ClientOptionsBuilder	defaultWriteTimeout(Duration writeTimeout) Deprecated.
ClientOptionsBuilder	defaultWriteTimeoutMillis(long writeTimeoutMillis) Deprecated.
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 java.lang.Object

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

Constructor Detail

ClientOptionsBuilder

@Deprecated
public ClientOptionsBuilder()

Deprecated. Use ClientOptions.builder().

Creates a new instance with the default options.

ClientOptionsBuilder

@Deprecated
public ClientOptionsBuilder(ClientOptions options)

Deprecated. Use ClientOptions.toBuilder().

Creates a new instance with the specified base options.

Method Detail

build

public ClientOptions build()

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

options

public ClientOptionsBuilder options(ClientOptions options)

Adds the specified ClientOptions.

options

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

Adds the specified ClientOptionValues.

options

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

Adds the specified ClientOptionValues.

option

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

Adds the specified ClientOption and its value.

option

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

Adds the specified ClientOptionValue.

factory

public ClientOptionsBuilder factory(ClientFactory factory)

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

defaultWriteTimeout

@Deprecated
public ClientOptionsBuilder defaultWriteTimeout(Duration writeTimeout)

Deprecated.

Sets the timeout of a socket write attempt.

Parameters:

writeTimeout - the timeout. 0 disables the timeout.

defaultWriteTimeoutMillis

@Deprecated
public ClientOptionsBuilder defaultWriteTimeoutMillis(long writeTimeoutMillis)

Deprecated.

Sets the timeout of a socket write attempt in milliseconds.

Parameters:

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

writeTimeout

public ClientOptionsBuilder writeTimeout(Duration writeTimeout)

Sets the timeout of a socket write attempt.

Parameters:

writeTimeout - the timeout. 0 disables the timeout.

writeTimeoutMillis

public ClientOptionsBuilder writeTimeoutMillis(long writeTimeoutMillis)

Sets the timeout of a socket write attempt in milliseconds.

Parameters:

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

defaultResponseTimeout

@Deprecated
public ClientOptionsBuilder defaultResponseTimeout(Duration responseTimeout)

Deprecated.

Sets the timeout of a response.

Parameters:

responseTimeout - the timeout. 0 disables the timeout.

defaultResponseTimeoutMillis

@Deprecated
public ClientOptionsBuilder defaultResponseTimeoutMillis(long responseTimeoutMillis)

Deprecated.

Sets the timeout of a response in milliseconds.

Parameters:

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

responseTimeout

public ClientOptionsBuilder responseTimeout(Duration responseTimeout)

Sets the timeout of a response.

Parameters:

responseTimeout - the timeout. 0 disables the timeout.

responseTimeoutMillis

public ClientOptionsBuilder responseTimeoutMillis(long responseTimeoutMillis)

Sets the timeout of a response in milliseconds.

Parameters:

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

defaultMaxResponseLength

@Deprecated
public ClientOptionsBuilder defaultMaxResponseLength(long maxResponseLength)

Deprecated.

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

Parameters:

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

maxResponseLength

public ClientOptionsBuilder maxResponseLength(long maxResponseLength)

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

Parameters:

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

requestIdGenerator

public ClientOptionsBuilder requestIdGenerator(Supplier<RequestId> requestIdGenerator)

Sets the Supplier that generates a RequestId.

endpointRemapper

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

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.

See Also:

ClientOption.ENDPOINT_REMAPPER, ClientOptions.endpointRemapper()

decorator

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

Adds the specified HTTP-level decorator.

Parameters:

decorator - the Function that transforms an HttpClient to another

decorator

public ClientOptionsBuilder decorator(DecoratingHttpClientFunction decorator)

Adds the specified HTTP-level decorator.

Parameters:

decorator - the DecoratingHttpClientFunction that intercepts an invocation

rpcDecorator

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

Adds the specified RPC-level decorator.

Parameters:

decorator - the Function that transforms an RpcClient to another

rpcDecorator

public ClientOptionsBuilder rpcDecorator(DecoratingRpcClientFunction decorator)

Adds the specified RPC-level decorator.

Parameters:

decorator - the DecoratingRpcClientFunction that intercepts an invocation

addHttpHeader

public ClientOptionsBuilder addHttpHeader(CharSequence name,
                                          Object value)

Adds the specified HTTP header.

addHttpHeaders

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

Adds the specified HTTP headers.

setHttpHeader

public ClientOptionsBuilder setHttpHeader(CharSequence name,
                                          Object value)

Sets the specified HTTP header.

setHttpHeaders

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

Sets the specified HTTP headers.