Package com.linecorp.armeria.client

Class ClientOptions

java.lang.Object

com.linecorp.armeria.common.util.AbstractOptions<ClientOption<Object>,ClientOptionValue<Object>>

com.linecorp.armeria.client.ClientOptions

All Implemented Interfaces:

Iterable<ClientOptionValue<Object>>

public final class ClientOptions
extends AbstractOptions<ClientOption<Object>,ClientOptionValue<Object>>

A set of ClientOptions and their respective values.

Field Summary

Fields

Modifier and Type	Field	Description
static final ClientOption<Boolean>	AUTO_FILL_ORIGIN_HEADER	Whether to add an HttpHeaderNames.ORIGIN header automatically when sending an HttpRequest when the HttpRequest.headers() does not have it.
static final ClientOption<Consumer<ClientRequestContext>>	CONTEXT_CUSTOMIZER	The ClientRequestContext customizer.
static final ClientOption<Supplier<? extends AutoCloseable>>	CONTEXT_HOOK
static final ClientOption<ClientDecoration>	DECORATION	The Function that decorates the client components.
static final ClientOption<Function<? super Endpoint,? extends EndpointGroup>>	ENDPOINT_REMAPPER	A Function that remaps a target Endpoint into an EndpointGroup.
static final ClientOption<ClientFactory>	FACTORY	The ClientFactory used for creating a client.
static final ClientOption<HttpHeaders>	HEADERS	The additional HTTP headers to send with requests.
static final ClientOption<Long>	MAX_RESPONSE_LENGTH	The maximum allowed length of a server response.
static final ClientOption<RedirectConfig>	REDIRECT_CONFIG	The redirect configuration.
static final ClientOption<Long>	REQUEST_AUTO_ABORT_DELAY_MILLIS	The amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
static final ClientOption<Supplier<RequestId>>	REQUEST_ID_GENERATOR	The Supplier that generates a RequestId.
static final ClientOption<Long>	RESPONSE_TIMEOUT_MILLIS	The timeout of a server reply to a client call.
static final ClientOption<ResponseTimeoutMode>	RESPONSE_TIMEOUT_MODE
static final ClientOption<SuccessFunction>	SUCCESS_FUNCTION	The SuccessFunction that determines if the request is successful or not.
static final ClientOption<Long>	WRITE_TIMEOUT_MILLIS	The timeout of a socket write.

Method Summary

Modifier and Type	Method	Description
boolean	autoFillOriginHeader()	Returns whether to add an HttpHeaderNames.ORIGIN header automatically when sending an HttpRequest when the HttpRequest.headers() does not have it.
static ClientOptionsBuilder	builder()	Returns a newly created ClientOptionsBuilder.
Consumer<ClientRequestContext>	contextCustomizer()	Returns the Consumer that customizes a ClientRequestContext.
Supplier<AutoCloseable>	contextHook()	Returns the Supplier which provides an AutoCloseable and will be called whenever this RequestContext is popped from the RequestContextStorage.
ClientDecoration	decoration()	Returns the Functions that decorate the components of a client.
Function<? super Endpoint,? extends EndpointGroup>	endpointRemapper()	Returns the Function that remaps a target Endpoint into an EndpointGroup.
ClientFactory	factory()	Returns the ClientFactory used for creating a client.
HttpHeaders	headers()	Returns the additional HTTP headers to send with requests.
long	maxResponseLength()	Returns the maximum allowed length of a server response.
static ClientOptions	of()	Returns an empty singleton ClientOptions.
static ClientOptions	of(ClientOptions baseOptions, ClientOptionValue<?>... additionalValues)	Merges the specified ClientOptions and ClientOptionValues.
static ClientOptions	of(ClientOptions baseOptions, Iterable<? extends ClientOptionValue<?>> additionalValues)	Merges the specified ClientOptions and ClientOptionValues.
static ClientOptions	of(ClientOptionValue<?>... values)	Returns the ClientOptions with the specified ClientOptionValues.
static ClientOptions	of(Iterable<? extends ClientOptionValue<?>> values)	Returns the ClientOptions with the specified ClientOptionValues.
RedirectConfig	redirectConfig()	Returns the RedirectConfig.
long	requestAutoAbortDelayMillis()	Returns the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.
Supplier<RequestId>	requestIdGenerator()	Returns the Supplier that generates a RequestId.
long	responseTimeoutMillis()	Returns the timeout of a server reply to a client call.
ResponseTimeoutMode	responseTimeoutMode()	Returns the ResponseTimeoutMode which determines when a responseTimeoutMillis() will start to be scheduled.
SuccessFunction	successFunction()	Returns the SuccessFunction that determines if the request is successful or not.
ClientOptionsBuilder	toBuilder()	Returns a new ClientOptionsBuilder created from this ClientOptions.
long	writeTimeoutMillis()	Returns the timeout of a socket write.

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

asMap, get, iterator, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

FACTORY

public static final ClientOption<ClientFactory> FACTORY

The ClientFactory used for creating a client.

WRITE_TIMEOUT_MILLIS

public static final ClientOption<Long> WRITE_TIMEOUT_MILLIS

The timeout of a socket write.

RESPONSE_TIMEOUT_MILLIS

public static final ClientOption<Long> RESPONSE_TIMEOUT_MILLIS

The timeout of a server reply to a client call.

MAX_RESPONSE_LENGTH

public static final ClientOption<Long> MAX_RESPONSE_LENGTH

The maximum allowed length of a server response.

REQUEST_AUTO_ABORT_DELAY_MILLIS

public static final ClientOption<Long> REQUEST_AUTO_ABORT_DELAY_MILLIS

The amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.

AUTO_FILL_ORIGIN_HEADER

@UnstableApi
public static final ClientOption<Boolean> AUTO_FILL_ORIGIN_HEADER

Whether to add an HttpHeaderNames.ORIGIN header automatically when sending an HttpRequest when the HttpRequest.headers() does not have it.

See Also:

• The Web Origin Concept

REDIRECT_CONFIG

@UnstableApi
public static final ClientOption<RedirectConfig> REDIRECT_CONFIG

The redirect configuration.

CONTEXT_CUSTOMIZER

@UnstableApi
public static final ClientOption<Consumer<ClientRequestContext>> CONTEXT_CUSTOMIZER

The ClientRequestContext customizer.

See Also:

• Clients.withContextCustomizer(Consumer)

DECORATION

public static final ClientOption<ClientDecoration> DECORATION

The Function that decorates the client components.

REQUEST_ID_GENERATOR

public static final ClientOption<Supplier<RequestId>> REQUEST_ID_GENERATOR

The Supplier that generates a RequestId.

SUCCESS_FUNCTION

public static final ClientOption<SuccessFunction> SUCCESS_FUNCTION

The SuccessFunction that determines if the request is successful or not.

ENDPOINT_REMAPPER

public static final ClientOption<Function<? super Endpoint,? extends EndpointGroup>> ENDPOINT_REMAPPER

A Function that remaps a target Endpoint into an EndpointGroup.

See Also:

• ClientBuilder.endpointRemapper(Function)

CONTEXT_HOOK

@UnstableApi
public static final ClientOption<Supplier<? extends AutoCloseable>> CONTEXT_HOOK

RESPONSE_TIMEOUT_MODE

@UnstableApi
public static final ClientOption<ResponseTimeoutMode> RESPONSE_TIMEOUT_MODE

HEADERS

public static final ClientOption<HttpHeaders> HEADERS

The additional HTTP headers to send with requests.

Method Details

of

public static ClientOptions of()

Returns an empty singleton ClientOptions.

of

public static ClientOptions of(ClientOptionValue<?>... values)

Returns the ClientOptions with the specified ClientOptionValues.

of

public static ClientOptions of(Iterable<? extends ClientOptionValue<?>> values)

Returns the ClientOptions with the specified ClientOptionValues.

of

public static ClientOptions of(ClientOptions baseOptions,
 ClientOptionValue<?>... additionalValues)

Merges the specified ClientOptions and ClientOptionValues.

Returns:

the merged ClientOptions

of

public static ClientOptions of(ClientOptions baseOptions,
 Iterable<? extends ClientOptionValue<?>> additionalValues)

Merges the specified ClientOptions and ClientOptionValues.

Returns:

the merged ClientOptions

builder

public static ClientOptionsBuilder builder()

Returns a newly created ClientOptionsBuilder.

factory

public ClientFactory factory()

Returns the ClientFactory used for creating a client.

writeTimeoutMillis

public long writeTimeoutMillis()

Returns the timeout of a socket write.

responseTimeoutMillis

public long responseTimeoutMillis()

Returns the timeout of a server reply to a client call.

maxResponseLength

public long maxResponseLength()

Returns the maximum allowed length of a server response.

requestAutoAbortDelayMillis

public long requestAutoAbortDelayMillis()

Returns the amount of time in millis to wait before aborting an HttpRequest when its corresponding HttpResponse is complete.

autoFillOriginHeader

@UnstableApi
public boolean autoFillOriginHeader()

Returns whether to add an HttpHeaderNames.ORIGIN header automatically when sending an HttpRequest when the HttpRequest.headers() does not have it.

redirectConfig

@UnstableApi
public RedirectConfig redirectConfig()

Returns the RedirectConfig.

decoration

public ClientDecoration decoration()

Returns the Functions that decorate the components of a client.

headers

public HttpHeaders headers()

Returns the additional HTTP headers to send with requests. Used only when the underlying SessionProtocol is HTTP.

requestIdGenerator

public Supplier<RequestId> requestIdGenerator()

Returns the Supplier that generates a RequestId.

successFunction

public SuccessFunction successFunction()

Returns the SuccessFunction that determines if the request is successful or not.

endpointRemapper

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

Returns the Function that remaps a target Endpoint into an EndpointGroup.

See Also:

• ClientBuilder.endpointRemapper(Function)

contextCustomizer

public Consumer<ClientRequestContext> contextCustomizer()

Returns the Consumer that customizes a ClientRequestContext.

contextHook

@UnstableApi
public Supplier<AutoCloseable> contextHook()

Returns the Supplier which provides an AutoCloseable and will be called whenever this RequestContext is popped from the RequestContextStorage.

responseTimeoutMode

@UnstableApi
public ResponseTimeoutMode responseTimeoutMode()

Returns the ResponseTimeoutMode which determines when a responseTimeoutMillis() will start to be scheduled.

See Also:

• ResponseTimeoutMode

toBuilder

public ClientOptionsBuilder toBuilder()

Returns a new ClientOptionsBuilder created from this ClientOptions.