ClientFactoryBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.client.ClientFactoryBuilder

public final class ClientFactoryBuilder
extends Object

Builds a new ClientFactory.

Example


 final ClientFactory factory =
         ClientFactory.builder()
                      // Set the connection timeout to 5 seconds.
                      .connectTimeoutMillis(5000)
                      // Set the socket send buffer to 1 MiB.
                      .socketOption(ChannelOption.SO_SNDBUF, 1048576)
                      // Disable certificate verification; never do this in production!
                      .tlsNoVerify()
                      .build();

Constructor Summary

Constructors
Constructor and Description

ClientFactoryBuilder()
Deprecated.
Use ClientFactory.builder().

Constructors
Constructor and Description
`ClientFactoryBuilder()` Deprecated. Use `ClientFactory.builder()`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ClientFactoryBuilder`	`addressResolverGroupFactory(Function<? super io.netty.channel.EventLoopGroup,? extends io.netty.resolver.AddressResolverGroup<? extends InetSocketAddress>> addressResolverGroupFactory)` Sets the factory that creates a `AddressResolverGroup` which resolves remote addresses into `InetSocketAddress`es.
`ClientFactory`	`build()` Returns a newly-created `ClientFactory` based on the properties of this builder.
`<T> ClientFactoryBuilder`	`channelOption(io.netty.channel.ChannelOption<T> option, T value)` Sets the options of sockets created by the `ClientFactory`.
`ClientFactoryBuilder`	`connectionPoolListener(ConnectionPoolListener connectionPoolListener)` Sets the listener which is notified on a connection pool event.
`ClientFactoryBuilder`	`connectTimeout(Duration connectTimeout)` Sets the timeout of a socket connection attempt.
`ClientFactoryBuilder`	`connectTimeoutMillis(long connectTimeoutMillis)` Sets the timeout of a socket connection attempt in milliseconds.
`ClientFactoryBuilder`	`domainNameResolverCustomizer(Consumer<? super DnsResolverGroupBuilder> dnsResolverGroupCustomizer)` Adds the specified `Consumer` which customizes the given `DnsNameResolverBuilder`.
`ClientFactoryBuilder`	`eventLoopSchedulerFactory(Function<? super io.netty.channel.EventLoopGroup,? extends EventLoopScheduler> eventLoopSchedulerFactory)` Sets the factory that creates an `EventLoopScheduler` which is responsible for assigning an `EventLoop` to handle a connection to the specified `Endpoint`.
`ClientFactoryBuilder`	`http1MaxChunkSize(int http1MaxChunkSize)` Sets the maximum length of each chunk in an HTTP/1 response content.
`ClientFactoryBuilder`	`http1MaxHeaderSize(int http1MaxHeaderSize)` Sets the maximum length of all headers in an HTTP/1 response.
`ClientFactoryBuilder`	`http1MaxInitialLineLength(int http1MaxInitialLineLength)` Sets the maximum length of an HTTP/1 response initial line.
`ClientFactoryBuilder`	`http2InitialConnectionWindowSize(int http2InitialConnectionWindowSize)` Sets the initial connection flow-control window size.
`ClientFactoryBuilder`	`http2InitialStreamWindowSize(int http2InitialStreamWindowSize)` Sets the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control.
`ClientFactoryBuilder`	`http2MaxFrameSize(int http2MaxFrameSize)` Sets the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
`ClientFactoryBuilder`	`http2MaxHeaderListSize(long http2MaxHeaderListSize)` Sets the SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
`ClientFactoryBuilder`	`idleTimeout(Duration idleTimeout)` Sets the idle timeout of a socket connection.
`ClientFactoryBuilder`	`idleTimeoutMillis(long idleTimeoutMillis)` Sets the idle timeout of a socket connection in milliseconds.
`ClientFactoryBuilder`	`maxNumEventLoopsFunction(ToIntFunction<Endpoint> maxNumEventLoopsFunction)` Sets the `ToIntFunction` which takes an `Endpoint` and produces the maximum number of `EventLoop`s which will be used to handle connections to the specified `Endpoint`.
`ClientFactoryBuilder`	`maxNumEventLoopsPerEndpoint(int maxNumEventLoopsPerEndpoint)` Sets the maximum number of `EventLoop`s which will be used to handle HTTP/2 connections except the ones specified by `maxNumEventLoopsFunction(ToIntFunction)`.
`ClientFactoryBuilder`	`maxNumEventLoopsPerHttp1Endpoint(int maxNumEventLoopsPerEndpoint)` Sets the maximum number of `EventLoop`s which will be used to handle HTTP/1.1 connections except the ones specified by `maxNumEventLoopsFunction(ToIntFunction)`.
`ClientFactoryBuilder`	`meterRegistry(MeterRegistry meterRegistry)` Sets the `MeterRegistry` which collects various stats.
`<T> ClientFactoryBuilder`	`option(ClientFactoryOption<T> option, T value)` Adds the specified `ClientFactoryOption` and its `value`.
`<T> ClientFactoryBuilder`	`option(ClientFactoryOptionValue<T> optionValue)` Adds the specified `ClientFactoryOptionValue`.
`ClientFactoryBuilder`	`options(ClientFactoryOptions options)` Adds the specified `ClientFactoryOptions`.
`<T> ClientFactoryBuilder`	`socketOption(io.netty.channel.ChannelOption<T> option, T value)` Deprecated. Use `channelOption(ChannelOption, Object)`.
`ClientFactoryBuilder`	`sslContextCustomizer(Consumer<? super io.netty.handler.ssl.SslContextBuilder> sslContextCustomizer)` Deprecated. Use `tlsCustomizer(Consumer)`.
`ClientFactoryBuilder`	`tlsCustomizer(Consumer<? super io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)` Adds the `Consumer` which can arbitrarily configure the `SslContextBuilder` that will be applied to the SSL session.
`ClientFactoryBuilder`	`tlsNoVerify()` Disables the verification of server's key certificate chain.
`String`	`toString()`
`ClientFactoryBuilder`	`useHttp1Pipelining(boolean useHttp1Pipelining)` Sets whether to use HTTP pipelining for HTTP/1 connections.
`ClientFactoryBuilder`	`useHttp2Preface(boolean useHttp2Preface)` Sets 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.
`ClientFactoryBuilder`	`workerGroup(io.netty.channel.EventLoopGroup workerGroup, boolean shutdownOnClose)` Sets the worker `EventLoopGroup` which is responsible for performing socket I/O and running `Client.execute(ClientRequestContext, Request)`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClientFactoryBuilder
```
@Deprecated
public ClientFactoryBuilder()
```
    Deprecated. Use ClientFactory.builder().
    
    Creates a new instance.
- Method Detail
  - workerGroup
```
public ClientFactoryBuilder workerGroup(io.netty.channel.EventLoopGroup workerGroup,
                                        boolean shutdownOnClose)
```
    Sets the worker EventLoopGroup which is responsible for performing socket I/O and running Client.execute(ClientRequestContext, Request). If not set, the common worker group is used.
    
    Parameters:
    
    shutdownOnClose - whether to shut down the worker EventLoopGroup when the ClientFactory is closed
  - eventLoopSchedulerFactory
```
public ClientFactoryBuilder eventLoopSchedulerFactory(Function<? super io.netty.channel.EventLoopGroup,? extends EventLoopScheduler> eventLoopSchedulerFactory)
```
    Sets the factory that creates an EventLoopScheduler which is responsible for assigning an EventLoop to handle a connection to the specified Endpoint.
  - maxNumEventLoopsPerHttp1Endpoint
```
public ClientFactoryBuilder maxNumEventLoopsPerHttp1Endpoint(int maxNumEventLoopsPerEndpoint)
```
    Sets the maximum number of EventLoops which will be used to handle HTTP/1.1 connections except the ones specified by maxNumEventLoopsFunction(ToIntFunction). is used by default.
  - maxNumEventLoopsPerEndpoint
```
public ClientFactoryBuilder maxNumEventLoopsPerEndpoint(int maxNumEventLoopsPerEndpoint)
```
    Sets the maximum number of EventLoops which will be used to handle HTTP/2 connections except the ones specified by maxNumEventLoopsFunction(ToIntFunction). is used by default.
  - maxNumEventLoopsFunction
```
public ClientFactoryBuilder maxNumEventLoopsFunction(ToIntFunction<Endpoint> maxNumEventLoopsFunction)
```
    Sets the ToIntFunction which takes an Endpoint and produces the maximum number of EventLoops which will be used to handle connections to the specified Endpoint. The function should return 0 or a negative value for the Endpoints which it doesn't want to handle. For example:
```
 ToIntFunction<Endpoint> function = endpoint -> {
     if (endpoint.equals(Endpoint.of("foo.com"))) {
         return 5;
     }
     if (endpoint.host().contains("bar.com")) {
         return Integer.MAX_VALUE; // The value will be clamped at the number of event loops.
     }
     return -1; // Should return 0 or a negative value to use the default value.
 }
 
```
  - connectTimeout
```
public ClientFactoryBuilder connectTimeout(Duration connectTimeout)
```
    Sets the timeout of a socket connection attempt.
  - connectTimeoutMillis
```
public ClientFactoryBuilder connectTimeoutMillis(long connectTimeoutMillis)
```
    Sets the timeout of a socket connection attempt in milliseconds.
  - socketOption
```
@Deprecated
public <T> ClientFactoryBuilder socketOption(io.netty.channel.ChannelOption<T> option,
                                                         T value)
```
    Deprecated. Use channelOption(ChannelOption, Object).
    
    Sets the options of sockets created by the ClientFactory.
  - channelOption
```
public <T> ClientFactoryBuilder channelOption(io.netty.channel.ChannelOption<T> option,
                                              T value)
```
    Sets the options of sockets created by the ClientFactory.
  - sslContextCustomizer
```
@Deprecated
public ClientFactoryBuilder sslContextCustomizer(Consumer<? super io.netty.handler.ssl.SslContextBuilder> sslContextCustomizer)
```
    Deprecated. Use tlsCustomizer(Consumer).
    
    Sets the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session. For example, use SslContextBuilder.trustManager(java.io.File) to configure a custom server CA or SslContextBuilder.keyManager(java.io.File, java.io.File) to configure a client certificate for SSL authorization.
  - tlsNoVerify
```
public ClientFactoryBuilder tlsNoVerify()
```
    Disables the verification of server's key certificate chain. This method is a shortcut for: tlsCustomizer(b -> b.trustManager(InsecureTrustManagerFactory.INSTANCE)). Note: You should never use this in production but only for a testing purpose.
    
    See Also:
    
    InsecureTrustManagerFactory, tlsCustomizer(Consumer)
  - tlsCustomizer
```
public ClientFactoryBuilder tlsCustomizer(Consumer<? super io.netty.handler.ssl.SslContextBuilder> tlsCustomizer)
```
    Adds the Consumer which can arbitrarily configure the SslContextBuilder that will be applied to the SSL session. For example, use SslContextBuilder.trustManager(TrustManagerFactory) to configure a custom server CA or SslContextBuilder.keyManager(KeyManagerFactory) to configure a client certificate for SSL authorization.
  - addressResolverGroupFactory
```
public ClientFactoryBuilder addressResolverGroupFactory(Function<? super io.netty.channel.EventLoopGroup,? extends io.netty.resolver.AddressResolverGroup<? extends InetSocketAddress>> addressResolverGroupFactory)
```
    Sets the factory that creates a AddressResolverGroup which resolves remote addresses into InetSocketAddresses.
    
    Throws:
    
    IllegalStateException - if domainNameResolverCustomizer(Consumer) was called already.
  - domainNameResolverCustomizer
```
public ClientFactoryBuilder domainNameResolverCustomizer(Consumer<? super DnsResolverGroupBuilder> dnsResolverGroupCustomizer)
```
    Adds the specified Consumer which customizes the given DnsNameResolverBuilder. This method is useful when you want to change the behavior of the default domain name resolver, such as changing the DNS server list.
    
    Throws:
    
    IllegalStateException - if addressResolverGroupFactory(Function) was called already.
  - http2InitialConnectionWindowSize
```
public ClientFactoryBuilder http2InitialConnectionWindowSize(int http2InitialConnectionWindowSize)
```
    Sets the initial connection flow-control window size. The HTTP/2 connection is first established with bytes of connection flow-control window size, and it is changed if and only if http2InitialConnectionWindowSize is set. Note that this setting affects the connection-level window size, not the window size of streams.
    
    See Also:
    
    http2InitialStreamWindowSize(int)
  - http2InitialStreamWindowSize
```
public ClientFactoryBuilder http2InitialStreamWindowSize(int http2InitialStreamWindowSize)
```
    Sets the SETTINGS_INITIAL_WINDOW_SIZE for HTTP/2 stream-level flow control. Note that this setting affects the window size of all streams, not the connection-level window size.
    
    See Also:
    
    http2InitialConnectionWindowSize(int)
  - http2MaxFrameSize
```
public ClientFactoryBuilder http2MaxFrameSize(int http2MaxFrameSize)
```
    Sets the SETTINGS_MAX_FRAME_SIZE that indicates the size of the largest frame payload that this client is willing to receive.
  - http2MaxHeaderListSize
```
public ClientFactoryBuilder http2MaxHeaderListSize(long http2MaxHeaderListSize)
```
    Sets the SETTINGS_MAX_HEADER_LIST_SIZE that indicates the maximum size of header list that the client is prepared to accept, in octets.
  - http1MaxInitialLineLength
```
public ClientFactoryBuilder http1MaxInitialLineLength(int http1MaxInitialLineLength)
```
    Sets the maximum length of an HTTP/1 response initial line.
  - http1MaxHeaderSize
```
public ClientFactoryBuilder http1MaxHeaderSize(int http1MaxHeaderSize)
```
    Sets the maximum length of all headers in an HTTP/1 response.
  - http1MaxChunkSize
```
public ClientFactoryBuilder http1MaxChunkSize(int http1MaxChunkSize)
```
    Sets the maximum length of each chunk in an HTTP/1 response content. The content or a chunk longer than this value will be split into smaller chunks so that their lengths never exceed it.
  - idleTimeout
```
public ClientFactoryBuilder idleTimeout(Duration idleTimeout)
```
    Sets the idle timeout of a socket connection. The connection is closed if there is no request in progress for this amount of time.
  - idleTimeoutMillis
```
public ClientFactoryBuilder idleTimeoutMillis(long idleTimeoutMillis)
```
    Sets the idle timeout of a socket connection in milliseconds. The connection is closed if there is no request in progress for this amount of time.
  - useHttp2Preface
```
public ClientFactoryBuilder useHttp2Preface(boolean useHttp2Preface)
```
    Sets 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 ClientFactoryBuilder useHttp1Pipelining(boolean useHttp1Pipelining)
```
    Sets whether to use HTTP pipelining for HTTP/1 connections. This does not affect HTTP/2 connections. This option is disabled by default.
  - connectionPoolListener
```
public ClientFactoryBuilder connectionPoolListener(ConnectionPoolListener connectionPoolListener)
```
    Sets the listener which is notified on a connection pool event.
  - meterRegistry
```
public ClientFactoryBuilder meterRegistry(MeterRegistry meterRegistry)
```
    Sets the MeterRegistry which collects various stats.
  - option
```
public <T> ClientFactoryBuilder option(ClientFactoryOption<T> option,
                                       T value)
```
    Adds the specified ClientFactoryOption and its value.
  - option
```
public <T> ClientFactoryBuilder option(ClientFactoryOptionValue<T> optionValue)
```
    Adds the specified ClientFactoryOptionValue.
  - options
```
public ClientFactoryBuilder options(ClientFactoryOptions options)
```
    Adds the specified ClientFactoryOptions.
  - build
```
public ClientFactory build()
```
    Returns a newly-created ClientFactory based on the properties of this builder.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClientFactoryBuilder

Example

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientFactoryBuilder

Method Detail

workerGroup

eventLoopSchedulerFactory

maxNumEventLoopsPerHttp1Endpoint

maxNumEventLoopsPerEndpoint

maxNumEventLoopsFunction

connectTimeout

connectTimeoutMillis

socketOption

channelOption

sslContextCustomizer

tlsNoVerify

tlsCustomizer

addressResolverGroupFactory

domainNameResolverCustomizer

http2InitialConnectionWindowSize

http2InitialStreamWindowSize

http2MaxFrameSize

http2MaxHeaderListSize

http1MaxInitialLineLength

http1MaxHeaderSize

http1MaxChunkSize

idleTimeout

idleTimeoutMillis

useHttp2Preface

useHttp1Pipelining

connectionPoolListener

meterRegistry

option

option

options

build

toString