reactor.ipc.netty.http.client

Class HttpClientOptions

java.lang.Object

reactor.ipc.netty.options.NettyOptions<Bootstrap,ClientOptions>

reactor.ipc.netty.options.ClientOptions

reactor.ipc.netty.http.client.HttpClientOptions

All Implemented Interfaces:

java.util.function.Supplier<Bootstrap>

public final class HttpClientOptions
extends ClientOptions

An http client connector builder with low-level connection options including connection pooling and proxy.

Author:

Stephane Maldini

Nested Class Summary

Nested classes/interfaces inherited from class reactor.ipc.netty.options.ClientOptions

ClientOptions.Proxy

Field Summary

Fields inherited from class reactor.ipc.netty.options.NettyOptions

DEFAULT_PORT

Method Summary

Modifier and Type	Method and Description
HttpClientOptions	afterChannelInit(java.util.function.Consumer<? super Channel> afterChannelInit) Setup the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.
<T> HttpClientOptions	attr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
HttpClientOptions	channelGroup(ChannelGroup channelGroup) Provide a ChannelGroup for each active remote channel will be held in the provided group.
HttpClientOptions	compression(boolean enabled) Enable GZip accept-encoding header and support for compressed response
HttpClientOptions	connect(InetSocketAddress connectAddress) The address to which this client should connect.
HttpClientOptions	connect(String host, int port) The host and port to which this client should connect.
HttpClientOptions	connect(java.util.function.Supplier<? extends InetSocketAddress> connectAddress) The address to which this client should connect.
static HttpClientOptions	create() Create new HttpClientOptions.
protected SslContext	defaultSslContext() Default Ssl context if none configured or null;
HttpClientOptions	disablePool() Disable current ClientOptions.poolResources
HttpClientOptions	duplicate() Return a copy of all options and references such as NettyOptions.onChannelInit(Predicate).
HttpClientOptions	eventLoopGroup(EventLoopGroup eventLoopGroup) Provide a shared EventLoopGroup each Connector handler.
InetSocketAddress	getRemoteAddress(URI uri) Return a new InetSocketAddress from the URI.
HttpClientOptions	loopResources(LoopResources eventLoopSelector) Provide an EventLoopGroup supplier.
HttpClientOptions	onChannelInit(java.util.function.Predicate<? super Channel> onChannelInit) A callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.
<T> HttpClientOptions	option(ChannelOption<T> key, T value) Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE.
HttpClientOptions	poolResources(PoolResources poolResources) Configures the ChannelPool selector for the socket.
HttpClientOptions	preferNative(boolean preferNative) Set the preferred native option.
HttpClientOptions	protocolFamily(InternetProtocolFamily protocolFamily) Configures the version family for the socket.
HttpClientOptions	proxy(ClientOptions.Proxy type, InetSocketAddress connectAddress) Let this client connect through a proxy by providing an address.
HttpClientOptions	proxy(ClientOptions.Proxy type, InetSocketAddress connectAddress, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through a proxy by providing an address and credentials.
HttpClientOptions	proxy(ClientOptions.Proxy type, String host, int port) Let this client connect through a proxy by providing a host and port.
HttpClientOptions	proxy(ClientOptions.Proxy type, String host, int port, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through a proxy by providing a host, port and credentials.
HttpClientOptions	proxy(ClientOptions.Proxy type, java.util.function.Supplier<? extends InetSocketAddress> connectAddress) Let this client connect through a proxy by providing a proxy type and address.
HttpClientOptions	proxy(ClientOptions.Proxy type, java.util.function.Supplier<? extends InetSocketAddress> connectAddress, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through a proxy by providing an address supplier.
HttpClientOptions	proxy(InetSocketAddress connectAddress) Let this client connect through an HTTP proxy by providing an address.
HttpClientOptions	proxy(InetSocketAddress connectAddress, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through an HTTP proxy by providing an address and credentials.
HttpClientOptions	proxy(String host, int port) Let this client connect through an HTTP proxy by providing a host and port.
HttpClientOptions	proxy(String host, int port, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through an HTTP proxy by providing a host, port and credentials.
HttpClientOptions	proxy(java.util.function.Supplier<? extends InetSocketAddress> connectAddress, String username, java.util.function.Function<? super String,? extends String> password) Let this client connect through an HTTP proxy by providing an address supplier and credentials.
HttpClientOptions	resolver(AddressResolverGroup<?> resolver) Assign an AddressResolverGroup.
HttpClientOptions	sslCloseNotifyFlushTimeout(java.time.Duration sslCloseNotifyFlushTimeout) Set the options to use for configuring SSL close_notify flush timeout.
HttpClientOptions	sslCloseNotifyFlushTimeoutMillis(long sslCloseNotifyFlushTimeoutMillis) Set the options to use for configuring SSL close_notify flush timeout.
HttpClientOptions	sslCloseNotifyReadTimeout(java.time.Duration sslCloseNotifyReadTimeout) Set the options to use for configuring SSL close_notify read timeout.
HttpClientOptions	sslCloseNotifyReadTimeoutMillis(long sslCloseNotifyReadTimeoutMillis) Set the options to use for configuring SSL close_notify read timeout.
HttpClientOptions	sslContext(SslContext sslContext) Set the options to use for configuring SSL.
HttpClientOptions	sslHandshakeTimeout(java.time.Duration sslHandshakeTimeout) Set the options to use for configuring SSL handshake timeout.
HttpClientOptions	sslHandshakeTimeoutMillis(long sslHandshakeTimeoutMillis) Set the options to use for configuring SSL handshake timeout.
HttpClientOptions	sslSupport() Enable default sslContext support
HttpClientOptions	sslSupport(java.util.function.Consumer<? super SslContextBuilder> configurator) Enable default sslContext support and enable further customization via the passed configurator.

Methods inherited from class reactor.ipc.netty.options.ClientOptions

connect, get, getAddress, getPoolResources, getProxyHandler, useDatagramChannel, useProxy

Methods inherited from class reactor.ipc.netty.options.NettyOptions

afterChannelInit, getLoopResources, getSslHandler, onChannelInit, preferNative, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static HttpClientOptions create()

Create new HttpClientOptions.

Returns:

a new option builder

afterChannelInit

public HttpClientOptions afterChannelInit(java.util.function.Consumer<? super Channel> afterChannelInit)

Description copied from class: NettyOptions

Setup the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.

Overrides:

afterChannelInit in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

afterChannelInit - the post channel setup handler

Returns:

this

See Also:

NettyOptions.onChannelInit(Predicate)

attr

public <T> HttpClientOptions attr(AttributeKey<T> key,
                                  T value)

Description copied from class: NettyOptions

Attribute default attribute to the future Channel connection. They will be available via NettyInbound.attr(AttributeKey).

Overrides:

attr in class NettyOptions<Bootstrap,ClientOptions>

Type Parameters:

T - the attribute type

Parameters:

key - the attribute key

value - the attribute value

Returns:

this builder

See Also:

AbstractBootstrap.attr(AttributeKey, Object)

channelGroup

public HttpClientOptions channelGroup(ChannelGroup channelGroup)

Description copied from class: NettyOptions

Provide a ChannelGroup for each active remote channel will be held in the provided group.

Overrides:

channelGroup in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

channelGroup - a ChannelGroup to monitor remote channel

Returns:

this builder

loopResources

public HttpClientOptions loopResources(LoopResources eventLoopSelector)

Description copied from class: NettyOptions

Provide an EventLoopGroup supplier. Note that server might call it twice for both their selection and io loops.

Overrides:

loopResources in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

eventLoopSelector - a selector accepting native runtime expectation and returning an eventLoopGroup

Returns:

this builder

connect

public HttpClientOptions connect(@Nonnull
                                 String host,
                                 int port)

Description copied from class: ClientOptions

The host and port to which this client should connect.

Overrides:

connect in class ClientOptions

Parameters:

host - The host to connect to.

port - The port to connect to.

Returns:

this

connect

public HttpClientOptions connect(@Nonnull
                                 InetSocketAddress connectAddress)

Description copied from class: ClientOptions

The address to which this client should connect.

Overrides:

connect in class ClientOptions

Parameters:

connectAddress - The address to connect to.

Returns:

this

connect

public HttpClientOptions connect(@Nonnull
                                 java.util.function.Supplier<? extends InetSocketAddress> connectAddress)

Description copied from class: ClientOptions

The address to which this client should connect.

Overrides:

connect in class ClientOptions

Parameters:

connectAddress - A supplier of the address to connect to.

Returns:

this

disablePool

public HttpClientOptions disablePool()

Description copied from class: ClientOptions

Disable current ClientOptions.poolResources

Overrides:

disablePool in class ClientOptions

Returns:

this

duplicate

public HttpClientOptions duplicate()

Description copied from class: NettyOptions

Return a copy of all options and references such as NettyOptions.onChannelInit(Predicate). Further option uses on the returned builder will be fully isolated from this option builder.

Overrides:

duplicate in class ClientOptions

Returns:

a new duplicated builder;

eventLoopGroup

public HttpClientOptions eventLoopGroup(EventLoopGroup eventLoopGroup)

Description copied from class: NettyOptions

Provide a shared EventLoopGroup each Connector handler.

Overrides:

eventLoopGroup in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

an EventLoopGroup provider given the native runtime expectation

compression

public HttpClientOptions compression(boolean enabled)

Enable GZip accept-encoding header and support for compressed response

Parameters:

enabled - true whether gzip support is enabled

Returns:

this builder

getRemoteAddress

public final InetSocketAddress getRemoteAddress(URI uri)

Return a new InetSocketAddress from the URI.

If the port is undefined (-1), a default port is used (80 or 443 depending on whether the URI is secure or not). If a proxy is used, the returned address is provided unresolved.

Parameters:

uri - URI to extract host and port information from

Returns:

a new eventual InetSocketAddress

onChannelInit

public HttpClientOptions onChannelInit(java.util.function.Predicate<? super Channel> onChannelInit)

Description copied from class: NettyOptions

A callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.

Overrides:

onChannelInit in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

onChannelInit - pre channel pipeline setup handler

Returns:

this

See Also:

NettyOptions.afterChannelInit(Consumer)

option

public <T> HttpClientOptions option(ChannelOption<T> key,
                                    T value)

Description copied from class: NettyOptions

Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE. This will apply to each new channel from remote peer.

Overrides:

option in class NettyOptions<Bootstrap,ClientOptions>

Type Parameters:

T - the option type

Parameters:

key - the option key

Returns:

this

See Also:

AbstractBootstrap.option(ChannelOption, Object)

preferNative

public HttpClientOptions preferNative(boolean preferNative)

Description copied from class: NettyOptions

Set the preferred native option. Determine if epoll should be used if available.

Overrides:

preferNative in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

preferNative - Should the connector prefer native (epoll) if available

Returns:

this

poolResources

public HttpClientOptions poolResources(PoolResources poolResources)

Description copied from class: ClientOptions

Configures the ChannelPool selector for the socket. Will effectively enable client connection-pooling.

Overrides:

poolResources in class ClientOptions

Parameters:

poolResources - the PoolResources given an InetSocketAddress

Returns:

this

protocolFamily

public HttpClientOptions protocolFamily(InternetProtocolFamily protocolFamily)

Description copied from class: ClientOptions

Configures the version family for the socket.

Overrides:

protocolFamily in class ClientOptions

Parameters:

protocolFamily - the version family for the socket, or null for the system default family

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               String host,
                               int port)

Let this client connect through an HTTP proxy by providing a host and port.

Parameters:

host - The proxy host to connect to.

port - The proxy port to connect to.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               String host,
                               int port,
                               @Nullable
                               String username,
                               @Nullable
                               java.util.function.Function<? super String,? extends String> password)

Let this client connect through an HTTP proxy by providing a host, port and credentials.

Parameters:

host - The proxy host to connect to.

port - The proxy port to connect to.

username - The proxy username to use.

password - A password-providing function for the proxy.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               ClientOptions.Proxy type,
                               @Nonnull
                               String host,
                               int port,
                               @Nullable
                               String username,
                               @Nullable
                               java.util.function.Function<? super String,? extends String> password)

Description copied from class: ClientOptions

Let this client connect through a proxy by providing a host, port and credentials.

Overrides:

proxy in class ClientOptions

Parameters:

type - The proxy type.

host - The proxy host to connect to.

port - The proxy port to connect to.

username - The proxy username.

password - A function to supply the proxy's password from the username.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               ClientOptions.Proxy type,
                               @Nonnull
                               String host,
                               int port)

Description copied from class: ClientOptions

Let this client connect through a proxy by providing a host and port.

Overrides:

proxy in class ClientOptions

Parameters:

type - The proxy type.

host - The host to connect to.

port - The port to connect to.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               ClientOptions.Proxy type,
                               @Nonnull
                               InetSocketAddress connectAddress)

Description copied from class: ClientOptions

Let this client connect through a proxy by providing an address.

Overrides:

proxy in class ClientOptions

Parameters:

type - The proxy type.

connectAddress - The address to connect to.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               ClientOptions.Proxy type,
                               @Nonnull
                               InetSocketAddress connectAddress,
                               @Nullable
                               String username,
                               @Nullable
                               java.util.function.Function<? super String,? extends String> password)

Description copied from class: ClientOptions

Let this client connect through a proxy by providing an address and credentials.

Overrides:

proxy in class ClientOptions

Parameters:

type - The proxy type.

connectAddress - The address to connect to.

username - The proxy username.

password - A function to supply the proxy's password from the username.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               ClientOptions.Proxy type,
                               @Nonnull
                               java.util.function.Supplier<? extends InetSocketAddress> connectAddress,
                               @Nullable
                               String username,
                               @Nullable
                               java.util.function.Function<? super String,? extends String> password)

Description copied from class: ClientOptions

Let this client connect through a proxy by providing an address supplier.

Overrides:

proxy in class ClientOptions

Parameters:

type - The proxy type.

connectAddress - The supplier for the address to connect to.

username - The proxy username.

password - A function to supply the proxy's password from the username.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               InetSocketAddress connectAddress)

Let this client connect through an HTTP proxy by providing an address.

Parameters:

connectAddress - The proxy address to connect to.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               InetSocketAddress connectAddress,
                               @Nullable
                               String username,
                               @Nullable
                               java.util.function.Function<? super String,? extends String> password)

Let this client connect through an HTTP proxy by providing an address and credentials.

Parameters:

connectAddress - The address to connect to.

username - The proxy username to use.

password - A password-providing function for the proxy.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               ClientOptions.Proxy type,
                               @Nonnull
                               java.util.function.Supplier<? extends InetSocketAddress> connectAddress)

Let this client connect through a proxy by providing a proxy type and address.

Overrides:

proxy in class ClientOptions

Parameters:

type - the proxy type.

connectAddress - The address to connect to.

Returns:

this

proxy

public HttpClientOptions proxy(@Nonnull
                               java.util.function.Supplier<? extends InetSocketAddress> connectAddress,
                               @Nullable
                               String username,
                               @Nullable
                               java.util.function.Function<? super String,? extends String> password)

Let this client connect through an HTTP proxy by providing an address supplier and credentials.

Parameters:

connectAddress - A supplier of the address to connect to.

username - The proxy username to use.

password - A password-providing function for the proxy.

Returns:

this

resolver

public HttpClientOptions resolver(AddressResolverGroup<?> resolver)

Description copied from class: ClientOptions

Assign an AddressResolverGroup.

Overrides:

resolver in class ClientOptions

Parameters:

resolver - the new AddressResolverGroup

Returns:

this ClientOptions

sslContext

public HttpClientOptions sslContext(SslContext sslContext)

Description copied from class: NettyOptions

Set the options to use for configuring SSL. Setting this to null means don't use SSL at all (the default).

Overrides:

sslContext in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

sslContext - The context to set when configuring SSL

Returns:

this

sslHandshakeTimeoutMillis

public HttpClientOptions sslHandshakeTimeoutMillis(long sslHandshakeTimeoutMillis)

Description copied from class: NettyOptions

Set the options to use for configuring SSL handshake timeout. Default to 10000 ms.

Overrides:

sslHandshakeTimeoutMillis in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

sslHandshakeTimeoutMillis - The timeout in milliseconds

Returns:

this

sslHandshakeTimeout

public HttpClientOptions sslHandshakeTimeout(java.time.Duration sslHandshakeTimeout)

Description copied from class: NettyOptions

Set the options to use for configuring SSL handshake timeout. Default to 10000 ms.

Overrides:

sslHandshakeTimeout in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

sslHandshakeTimeout - The timeout Duration

Returns:

this

sslCloseNotifyFlushTimeout

public HttpClientOptions sslCloseNotifyFlushTimeout(java.time.Duration sslCloseNotifyFlushTimeout)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify flush timeout. Default to 3000 ms.

Overrides:

sslCloseNotifyFlushTimeout in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

sslCloseNotifyFlushTimeout - The timeout Duration

Returns:

this

sslCloseNotifyFlushTimeoutMillis

public HttpClientOptions sslCloseNotifyFlushTimeoutMillis(long sslCloseNotifyFlushTimeoutMillis)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify flush timeout. Default to 3000 ms.

Overrides:

sslCloseNotifyFlushTimeoutMillis in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

sslCloseNotifyFlushTimeoutMillis - The timeout in milliseconds

Returns:

this

sslCloseNotifyReadTimeout

public HttpClientOptions sslCloseNotifyReadTimeout(java.time.Duration sslCloseNotifyReadTimeout)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify read timeout. Default to 0 ms.

Overrides:

sslCloseNotifyReadTimeout in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

sslCloseNotifyReadTimeout - The timeout Duration

Returns:

this

sslCloseNotifyReadTimeoutMillis

public HttpClientOptions sslCloseNotifyReadTimeoutMillis(long sslCloseNotifyReadTimeoutMillis)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify read timeout. Default to 0 ms.

Overrides:

sslCloseNotifyReadTimeoutMillis in class NettyOptions<Bootstrap,ClientOptions>

Parameters:

sslCloseNotifyReadTimeoutMillis - The timeout in milliseconds

Returns:

this

sslSupport

public HttpClientOptions sslSupport()

Description copied from class: ClientOptions

Enable default sslContext support

Overrides:

sslSupport in class ClientOptions

Returns:

this ClientOptions

sslSupport

public HttpClientOptions sslSupport(java.util.function.Consumer<? super SslContextBuilder> configurator)

Description copied from class: ClientOptions

Enable default sslContext support and enable further customization via the passed configurator. The builder will then produce the SslContext to be passed to NettyOptions.sslContext(SslContext).

Overrides:

sslSupport in class ClientOptions

Parameters:

configurator - builder callback for further customization.

Returns:

this ClientOptions

defaultSslContext

protected SslContext defaultSslContext()

Description copied from class: NettyOptions

Default Ssl context if none configured or null;

Overrides:

defaultSslContext in class NettyOptions<Bootstrap,ClientOptions>

Returns:

a default SslContext