com.linecorp.armeria.common.util.AbstractOptions<ClientFactoryOption<Object>,ClientFactoryOptionValue<Object>>

com.linecorp.armeria.client.ClientFactoryOptions

All Implemented Interfaces:: Iterable<ClientFactoryOptionValue<Object>>

public final class ClientFactoryOptions
extends AbstractOptions<ClientFactoryOption<Object>,ClientFactoryOptionValue<Object>>

A set of ClientFactoryOptions and their respective values.

Field Summary

Fields
Modifier and Type	Field	Description
`static ClientFactoryOption<Function<? super EventLoopGroup,? extends AddressResolverGroup<? extends InetSocketAddress>>>`	`ADDRESS_RESOLVER_GROUP_FACTORY`	The factory that creates an `AddressResolverGroup` which resolves remote addresses into `InetSocketAddress`es.
`static ClientFactoryOption<Map<ChannelOption<?>,Object>>`	`CHANNEL_OPTIONS`	The `ChannelOption`s of the sockets created by the `ClientFactory`.
`static ClientFactoryOption<ConnectionPoolListener>`	`CONNECTION_POOL_LISTENER`	The listener which is notified on a connection pool event.
`static ClientFactoryOption<Function<? super EventLoopGroup,? extends EventLoopScheduler>>`	`EVENT_LOOP_SCHEDULER_FACTORY`	The factory that creates an `EventLoopScheduler` which is responsible for assigning an `EventLoop` to handle a connection to the specified `Endpoint`.
`static ClientFactoryOption<Http1HeaderNaming>`	`HTTP1_HEADER_NAMING`	The `Http1HeaderNaming` which converts a lower-cased HTTP/2 header name into another HTTP/1 header name.
`static ClientFactoryOption<Integer>`	`HTTP1_MAX_CHUNK_SIZE`	The maximum length of each chunk in an HTTP/1 response content.
`static ClientFactoryOption<Integer>`	`HTTP1_MAX_HEADER_SIZE`	The maximum length of all headers in an HTTP/1 response.
`static ClientFactoryOption<Integer>`	`HTTP1_MAX_INITIAL_LINE_LENGTH`	The maximum length of an HTTP/1 response initial line.
`static ClientFactoryOption<Integer>`	`HTTP2_INITIAL_CONNECTION_WINDOW_SIZE`	The HTTP/2 initial connection flow-control window size.
`static ClientFactoryOption<Integer>`	`HTTP2_INITIAL_STREAM_WINDOW_SIZE`	The SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
`static ClientFactoryOption<Integer>`	`HTTP2_MAX_FRAME_SIZE`	The SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
`static ClientFactoryOption<Long>`	`HTTP2_MAX_HEADER_LIST_SIZE`	The HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
`static ClientFactoryOption<Long>`	`IDLE_TIMEOUT_MILLIS`	The idle timeout of a socket connection in milliseconds.
`static ClientFactoryOption<Long>`	`MAX_CONNECTION_AGE_MILLIS`	The client-side max age of a connection for keep-alive in milliseconds.
`static ClientFactoryOption<Integer>`	`MAX_NUM_REQUESTS_PER_CONNECTION`	The client-side maximum allowed number of requests that can be sent through one connection.
`static ClientFactoryOption<MeterRegistry>`	`METER_REGISTRY`	The `MeterRegistry` which collects various stats.
`static ClientFactoryOption<Long>`	`PING_INTERVAL_MILLIS`	The PING interval in milliseconds.
`static ClientFactoryOption<ProxyConfigSelector>`	`PROXY_CONFIG_SELECTOR`	The `ProxyConfigSelector` which determines the `ProxyConfig` to be used.
`static ClientFactoryOption<Boolean>`	`SHUTDOWN_WORKER_GROUP_ON_CLOSE`	Whether to shut down the worker `EventLoopGroup` when the `ClientFactory` is closed.
`static ClientFactoryOption<Boolean>`	`TLS_ALLOW_UNSAFE_CIPHERS`	Deprecated. It's not recommended to enable this option.
`static ClientFactoryOption<Consumer<? super SslContextBuilder>>`	`TLS_CUSTOMIZER`	The `Consumer` which can arbitrarily configure the `SslContextBuilder` that will be applied to the SSL session.
`static ClientFactoryOption<Boolean>`	`USE_HTTP1_PIPELINING`	Whether to use HTTP pipelining for HTTP/1 connections.
`static ClientFactoryOption<Boolean>`	`USE_HTTP2_PREFACE`	Whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
`static ClientFactoryOption<EventLoopGroup>`	`WORKER_GROUP`	The worker `EventLoopGroup`.

Method Summary

Modifier and Type	Method	Description
`Function<? super EventLoopGroup,? extends AddressResolverGroup<? extends InetSocketAddress>>`	`addressResolverGroupFactory()`	Returns the factory that creates an `AddressResolverGroup` which resolves remote addresses into `InetSocketAddress`es.
`Map<ChannelOption<?>,Object>`	`channelOptions()`	Returns the `ChannelOption`s of the sockets created by the `ClientFactory`.
`ConnectionPoolListener`	`connectionPoolListener()`	Returns the listener which is notified on a connection pool event.
`Function<? super EventLoopGroup,? extends EventLoopScheduler>`	`eventLoopSchedulerFactory()`	Returns the factory that creates an `EventLoopScheduler` which is responsible for assigning an `EventLoop` to handle a connection to the specified `Endpoint`.
`Http1HeaderNaming`	`http1HeaderNaming()`	Returns the `Http1HeaderNaming` which converts a lower-cased HTTP/2 header name into another header name.
`int`	`http1MaxChunkSize()`	Returns the maximum length of each chunk in an HTTP/1 response content.
`int`	`http1MaxHeaderSize()`	Returns the maximum length of all headers in an HTTP/1 response.
`int`	`http1MaxInitialLineLength()`	Returns the maximum length of an HTTP/1 response initial line.
`int`	`http2InitialConnectionWindowSize()`	Returns the HTTP/2 initial connection flow-control window size.
`int`	`http2InitialStreamWindowSize()`	Returns the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
`int`	`http2MaxFrameSize()`	Returns the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
`long`	`http2MaxHeaderListSize()`	Returns the HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
`long`	`idleTimeoutMillis()`	Returns the idle timeout of a socket connection in milliseconds.
`long`	`maxConnectionAgeMillis()`	Returns the client-side max age of a connection for keep-alive in milliseconds.
`int`	`maxNumRequestsPerConnection()`	Returns the client-side maximum allowed number of requests that can be sent through one connection.
`MeterRegistry`	`meterRegistry()`	Returns the `MeterRegistry` which collects various stats.
`static ClientFactoryOptions`	`of()`	Returns an empty singleton `ClientFactoryOptions`.
`static ClientFactoryOptions`	`of(ClientFactoryOptions baseOptions, ClientFactoryOptionValue<?>... additionalValues)`	Merges the specified `ClientFactoryOptions` and `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(ClientFactoryOptions baseOptions, Iterable<? extends ClientFactoryOptionValue<?>> additionalValues)`	Merges the specified `ClientFactoryOptions` and `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(ClientFactoryOptionValue<?>... values)`	Returns the `ClientFactoryOptions` with the specified `ClientFactoryOptionValue`s.
`static ClientFactoryOptions`	`of(Iterable<? extends ClientFactoryOptionValue<?>> values)`	Returns the `ClientFactoryOptions` with the specified `ClientFactoryOptionValue`s.
`long`	`pingIntervalMillis()`	Returns the PING interval in milliseconds.
`ProxyConfigSelector`	`proxyConfigSelector()`	The `ProxyConfigSelector` which determines the `ProxyConfig` to be used.
`boolean`	`shutdownWorkerGroupOnClose()`	Returns the flag whether to shut down the worker `EventLoopGroup` when the `ClientFactory` is closed.
`boolean`	`tlsAllowUnsafeCiphers()`	Returns whether to allow the bad cipher suites listed in RFC7540 for TLS handshake.
`Consumer<? super SslContextBuilder>`	`tlsCustomizer()`	Returns the `Consumer` which can arbitrarily configure the `SslContextBuilder` that will be applied to the SSL session.
`boolean`	`useHttp1Pipelining()`	Returns whether to use HTTP pipelining for HTTP/1 connections.
`boolean`	`useHttp2Preface()`	Returns whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
`EventLoopGroup`	`workerGroup()`	Returns the worker `EventLoopGroup`.

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
- WORKER_GROUP
  
  public static final ClientFactoryOption<EventLoopGroup> WORKER_GROUP
  
  The worker EventLoopGroup.
- SHUTDOWN_WORKER_GROUP_ON_CLOSE
  
  public static final ClientFactoryOption<Boolean> SHUTDOWN_WORKER_GROUP_ON_CLOSE
  
  Whether to shut down the worker EventLoopGroup when the ClientFactory is closed.
- EVENT_LOOP_SCHEDULER_FACTORY
  
  public static final ClientFactoryOption<Function<? super EventLoopGroup,? extends EventLoopScheduler>> EVENT_LOOP_SCHEDULER_FACTORY
  
  The factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
- TLS_CUSTOMIZER
  
  public static final ClientFactoryOption<Consumer<? super SslContextBuilder>> TLS_CUSTOMIZER
  
  The Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
- TLS_ALLOW_UNSAFE_CIPHERS
  
  @Deprecated public static final ClientFactoryOption<Boolean> TLS_ALLOW_UNSAFE_CIPHERS
  
  Deprecated.
  It's not recommended to enable this option. Use it only when you have no other way to communicate with an insecure peer than this.
  
  Whether to allow the bad cipher suites listed in RFC7540 for TLS handshake.
  Note that enabling this option increases the security risk of your connection. Use it only when you must communicate with a legacy system that does not support secure cipher suites. See Section 9.2.2, RFC7540 for more information.
- ADDRESS_RESOLVER_GROUP_FACTORY
  
  public static final ClientFactoryOption<Function<? super EventLoopGroup,? extends AddressResolverGroup<? extends InetSocketAddress>>> ADDRESS_RESOLVER_GROUP_FACTORY
  
  The factory that creates an AddressResolverGroup which resolves remote addresses into InetSocketAddresses.
- HTTP2_INITIAL_CONNECTION_WINDOW_SIZE
  
  public static final ClientFactoryOption<Integer> HTTP2_INITIAL_CONNECTION_WINDOW_SIZE
  
  The HTTP/2 initial connection flow-control window size.
- HTTP2_INITIAL_STREAM_WINDOW_SIZE
  
  public static final ClientFactoryOption<Integer> HTTP2_INITIAL_STREAM_WINDOW_SIZE
  
  The SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
- HTTP2_MAX_FRAME_SIZE
  
  public static final ClientFactoryOption<Integer> HTTP2_MAX_FRAME_SIZE
  
  The SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
- HTTP2_MAX_HEADER_LIST_SIZE
  
  public static final ClientFactoryOption<Long> HTTP2_MAX_HEADER_LIST_SIZE
  
  The HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
- HTTP1_MAX_INITIAL_LINE_LENGTH
  
  public static final ClientFactoryOption<Integer> HTTP1_MAX_INITIAL_LINE_LENGTH
  
  The maximum length of an HTTP/1 response initial line.
- HTTP1_MAX_HEADER_SIZE
  
  public static final ClientFactoryOption<Integer> HTTP1_MAX_HEADER_SIZE
  
  The maximum length of all headers in an HTTP/1 response.
- HTTP1_MAX_CHUNK_SIZE
  
  public static final ClientFactoryOption<Integer> HTTP1_MAX_CHUNK_SIZE
  
  The maximum length of each chunk in an HTTP/1 response content.
- IDLE_TIMEOUT_MILLIS
  
  public static final ClientFactoryOption<Long> IDLE_TIMEOUT_MILLIS
  
  The idle timeout of a socket connection in milliseconds.
- PING_INTERVAL_MILLIS
  
  public static final ClientFactoryOption<Long> PING_INTERVAL_MILLIS
  
  The PING interval in milliseconds. When neither read nor write was performed for the specified period of time, a PING frame is sent for HTTP/2 or an OPTIONS request with an asterisk ("*") is sent for HTTP/1.
- MAX_CONNECTION_AGE_MILLIS
  
  public static final ClientFactoryOption<Long> MAX_CONNECTION_AGE_MILLIS
  
  The client-side max age of a connection for keep-alive in milliseconds. If the value is greater than 0, a connection is disconnected after the specified amount of time since the connection was established. This option is disabled by default, which means unlimited.
- MAX_NUM_REQUESTS_PER_CONNECTION
  
  public static final ClientFactoryOption<Integer> MAX_NUM_REQUESTS_PER_CONNECTION
  
  The client-side maximum allowed number of requests that can be sent through one connection. This option is disabled by default, which means unlimited.
- USE_HTTP2_PREFACE
  
  public static final ClientFactoryOption<Boolean> USE_HTTP2_PREFACE
  
  Whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
- USE_HTTP1_PIPELINING
  
  public static final ClientFactoryOption<Boolean> USE_HTTP1_PIPELINING
  
  Whether to use HTTP pipelining for HTTP/1 connections.
- CONNECTION_POOL_LISTENER
  
  public static final ClientFactoryOption<ConnectionPoolListener> CONNECTION_POOL_LISTENER
  
  The listener which is notified on a connection pool event.
- METER_REGISTRY
  
  public static final ClientFactoryOption<MeterRegistry> METER_REGISTRY
  
  The MeterRegistry which collects various stats.
- PROXY_CONFIG_SELECTOR
  
  public static final ClientFactoryOption<ProxyConfigSelector> PROXY_CONFIG_SELECTOR
  
  The ProxyConfigSelector which determines the ProxyConfig to be used.
- HTTP1_HEADER_NAMING
  
  public static final ClientFactoryOption<Http1HeaderNaming> HTTP1_HEADER_NAMING
  
  The Http1HeaderNaming which converts a lower-cased HTTP/2 header name into another HTTP/1 header name.
- CHANNEL_OPTIONS
  
  public static final ClientFactoryOption<Map<ChannelOption<?>,Object>> CHANNEL_OPTIONS
  
  The ChannelOptions of the sockets created by the ClientFactory.
Method Details
- of
  
  public static ClientFactoryOptions of()
  
  Returns an empty singleton ClientFactoryOptions.
- of
  
  public static ClientFactoryOptions of(ClientFactoryOptionValue<?>... values)
  
  Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
- of
  
  public static ClientFactoryOptions of(Iterable<? extends ClientFactoryOptionValue<?>> values)
  
  Returns the ClientFactoryOptions with the specified ClientFactoryOptionValues.
- of
  
  public static ClientFactoryOptions of(ClientFactoryOptions baseOptions, ClientFactoryOptionValue<?>... additionalValues)
  
  Merges the specified ClientFactoryOptions and ClientFactoryOptionValues.
  
  Returns:
  
  the merged ClientFactoryOptions
- of
  
  public static ClientFactoryOptions of(ClientFactoryOptions baseOptions, Iterable<? extends ClientFactoryOptionValue<?>> additionalValues)
  
  Merges the specified ClientFactoryOptions and ClientFactoryOptionValues.
  
  Returns:
  
  the merged ClientFactoryOptions
- workerGroup
  
  public EventLoopGroup workerGroup()
  
  Returns the worker EventLoopGroup.
- shutdownWorkerGroupOnClose
  
  public boolean shutdownWorkerGroupOnClose()
  
  Returns the flag whether to shut down the worker EventLoopGroup when the ClientFactory is closed.
- eventLoopSchedulerFactory
  
  public Function<? super EventLoopGroup,? extends EventLoopScheduler> eventLoopSchedulerFactory()
  
  Returns the factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
- channelOptions
  
  public Map<ChannelOption<?>,Object> channelOptions()
  
  Returns the ChannelOptions of the sockets created by the ClientFactory.
- tlsCustomizer
  
  public Consumer<? super SslContextBuilder> tlsCustomizer()
  
  Returns the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session.
- addressResolverGroupFactory
  
  public Function<? super EventLoopGroup,? extends AddressResolverGroup<? extends InetSocketAddress>> addressResolverGroupFactory()
  
  Returns the factory that creates an AddressResolverGroup which resolves remote addresses into InetSocketAddresses.
- http2InitialConnectionWindowSize
  
  public int http2InitialConnectionWindowSize()
  
  Returns the HTTP/2 initial connection flow-control window size.
- http2InitialStreamWindowSize
  
  public int http2InitialStreamWindowSize()
  
  Returns the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
- http2MaxFrameSize
  
  public int http2MaxFrameSize()
  
  Returns the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
- http2MaxHeaderListSize
  
  public long http2MaxHeaderListSize()
  
  Returns the HTTP/2 SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
- http1MaxInitialLineLength
  
  public int http1MaxInitialLineLength()
  
  Returns the maximum length of an HTTP/1 response initial line.
- http1MaxHeaderSize
  
  public int http1MaxHeaderSize()
  
  Returns the maximum length of all headers in an HTTP/1 response.
- http1MaxChunkSize
  
  public int http1MaxChunkSize()
  
  Returns the maximum length of each chunk in an HTTP/1 response content.
- idleTimeoutMillis
  
  public long idleTimeoutMillis()
  
  Returns the idle timeout of a socket connection in milliseconds.
- pingIntervalMillis
  
  public long pingIntervalMillis()
  
  Returns the PING interval in milliseconds. When neither read nor write was performed for the specified period of time, a PING frame is sent for HTTP/2 or an OPTIONS request with an asterisk ("*") is sent for HTTP/1.
- maxConnectionAgeMillis
  
  public long maxConnectionAgeMillis()
  
  Returns the client-side max age of a connection for keep-alive in milliseconds. If the value is greater than 0, a connection is disconnected after the specified amount of the time since the connection was established.
- maxNumRequestsPerConnection
  
  public int maxNumRequestsPerConnection()
  
  Returns the client-side maximum allowed number of requests that can be sent through one connection.
- useHttp2Preface
  
  public boolean useHttp2Preface()
  
  Returns whether to send an HTTP/2 preface string instead of an HTTP/1 upgrade request to negotiate the protocol version of a cleartext HTTP connection.
- useHttp1Pipelining
  
  public boolean useHttp1Pipelining()
  
  Returns whether to use HTTP pipelining for HTTP/1 connections.
- connectionPoolListener
  
  public ConnectionPoolListener connectionPoolListener()
  
  Returns the listener which is notified on a connection pool event.
- meterRegistry
  
  public MeterRegistry meterRegistry()
  
  Returns the MeterRegistry which collects various stats.
- proxyConfigSelector
  
  public ProxyConfigSelector proxyConfigSelector()
  
  The ProxyConfigSelector which determines the ProxyConfig to be used.
- http1HeaderNaming
  
  public Http1HeaderNaming http1HeaderNaming()
  
  Returns the Http1HeaderNaming which converts a lower-cased HTTP/2 header name into another header name. This is useful when communicating with a legacy system that only supports case sensitive HTTP/1 headers.
- tlsAllowUnsafeCiphers
  
  public boolean tlsAllowUnsafeCiphers()
  
  Returns whether to allow the bad cipher suites listed in RFC7540 for TLS handshake.
  Note that enabling this option increases the security risk of your connection. Use it only when you must communicate with a legacy system that does not support secure cipher suites. See Section 9.2.2, RFC7540 for more information.

Class ClientFactoryOptions

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Details

WORKER_GROUP

SHUTDOWN_WORKER_GROUP_ON_CLOSE

EVENT_LOOP_SCHEDULER_FACTORY

TLS_CUSTOMIZER

TLS_ALLOW_UNSAFE_CIPHERS

ADDRESS_RESOLVER_GROUP_FACTORY

HTTP2_INITIAL_CONNECTION_WINDOW_SIZE

HTTP2_INITIAL_STREAM_WINDOW_SIZE

HTTP2_MAX_FRAME_SIZE

HTTP2_MAX_HEADER_LIST_SIZE

HTTP1_MAX_INITIAL_LINE_LENGTH

HTTP1_MAX_HEADER_SIZE

HTTP1_MAX_CHUNK_SIZE

IDLE_TIMEOUT_MILLIS

PING_INTERVAL_MILLIS

MAX_CONNECTION_AGE_MILLIS

MAX_NUM_REQUESTS_PER_CONNECTION

USE_HTTP2_PREFACE

USE_HTTP1_PIPELINING

CONNECTION_POOL_LISTENER

METER_REGISTRY

PROXY_CONFIG_SELECTOR

HTTP1_HEADER_NAMING

CHANNEL_OPTIONS

Method Details

of

of

of

of

of

workerGroup

shutdownWorkerGroupOnClose

eventLoopSchedulerFactory

channelOptions

tlsCustomizer

addressResolverGroupFactory

http2InitialConnectionWindowSize

http2InitialStreamWindowSize

http2MaxFrameSize

http2MaxHeaderListSize

http1MaxInitialLineLength

http1MaxHeaderSize

http1MaxChunkSize

idleTimeoutMillis

pingIntervalMillis

maxConnectionAgeMillis

maxNumRequestsPerConnection

useHttp2Preface

useHttp1Pipelining

connectionPoolListener

meterRegistry

proxyConfigSelector

http1HeaderNaming

tlsAllowUnsafeCiphers