Package reactor.netty.http.client

Class HttpClientConfig

java.lang.Object

reactor.netty.transport.TransportConfig

reactor.netty.transport.ClientTransportConfig<HttpClientConfig>

reactor.netty.http.client.HttpClientConfig

public final class HttpClientConfig
extends ClientTransportConfig<HttpClientConfig>

Encapsulate all necessary configuration for HTTP client transport. The public API is read-only.

Author:

Stephane Maldini, Violeta Georgieva

Method Summary

Modifier and Type	Method	Description
@Nullable String	baseUrl()	Return the configured base URL to use for this request/response or null.
protected void	bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)
int	channelHash()
ChannelInitializer<Channel>	channelInitializer(ConnectionObserver connectionObserver, @Nullable SocketAddress remoteAddress, boolean onServer)	Return the ChannelInitializer that will be used for initializing the channel pipeline.
ChannelOperations.OnSetup	channelOperationsProvider()	Return the associated ChannelOperations.OnSetup, config implementations might override this.
protected Class<? extends Channel>	channelType(boolean isDomainSocket)	Return the channel type this configuration is associated with, it can be one of the following.
ConnectionProvider	connectionProvider()	Return the ConnectionProvider.
ClientCookieDecoder	cookieDecoder()	Deprecated. as of 1.1.0.
ClientCookieEncoder	cookieEncoder()	Deprecated. as of 1.1.0.
HttpResponseDecoderSpec	decoder()	Return the configured HTTP response decoder options or the default.
AddressResolverGroup<?>	defaultAddressResolverGroup()	Provides a global AddressResolverGroup from HttpResources that is shared amongst all HTTP clients.
protected ConnectionObserver	defaultConnectionObserver()	Return the configured default ConnectionObserver.
protected LoggingHandler	defaultLoggingHandler()	Return the default LoggingHandler to wiretap this transport.
protected LoopResources	defaultLoopResources()	Return the default LoopResources for this transport.
protected ChannelMetricsRecorder	defaultMetricsRecorder()	Return the configured metrics recorder.
protected ChannelPipelineConfigurer	defaultOnChannelInit()	Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer().
@Nullable BiPredicate<HttpClientRequest,HttpClientResponse>	followRedirectPredicate()	Return the configured follow redirect predicate or null.
HttpHeaders	headers()	Return a copy of the request headers.
@Nullable Http2SettingsSpec	http2SettingsSpec()	Return the HTTP/2 configuration.
@Nullable Http3SettingsSpec	http3SettingsSpec()	Return the HTTP/3 configuration.
boolean	isAcceptBrotli()	Return whether Brotli compression is enabled.
boolean	isAcceptGzip()	Return whether GZip compression is enabled.
boolean	isRetryDisabled()	Return true if retry once is disabled, false otherwise.
boolean	isSecure()	Returns true if that HttpClient secured via SSL transport.
protected void	loggingHandler(LoggingHandler loggingHandler)
HttpMethod	method()	Return the configured request method.
protected void	metricsRecorder(@Nullable Supplier<? extends ChannelMetricsRecorder> metricsRecorder)	Obtains immediately the ChannelMetricsRecorder from the provided Supplier.
HttpProtocol[]	protocols()	Return the HTTP protocol to support.
protected void	proxyProvider(ProxyProvider proxyProvider)
protected void	proxyProviderSupplier(Supplier<ProxyProvider> proxyProviderSupplier)
@Nullable BiConsumer<HttpHeaders,HttpClientRequest>	redirectRequestBiConsumer()	Return the configured redirect request BiConsumer or null.
@Nullable Consumer<HttpClientRequest>	redirectRequestConsumer()	Return the configured redirect request consumer or null.
protected AddressResolverGroup<?>	resolverInternal()
@Nullable Duration	responseTimeout()	Return the configured response timeout or null.
@Nullable SslProvider	sslProvider()	Returns the current SslProvider if that HttpClient secured via SSL transport or null.
@Nullable String	uri()	Return the configured request uri.
@Nullable Function<String,String>	uriTagValue()	Returns the configured function that receives the actual uri and returns the uri tag value that will be used for the metrics with Metrics.URI tag.
@Nullable WebsocketClientSpec	websocketClientSpec()	Return the configured websocket client configuration.

Methods inherited from class reactor.netty.transport.ClientTransportConfig

doOnConnect, doOnConnected, doOnDisconnected, eventLoopGroup, getNameResolverProvider, hasProxy, proxyProvider, proxyProviderSupplier, remoteAddress, resolver

Methods inherited from class reactor.netty.transport.TransportConfig

attributes, bindAddress, channelGroup, connectionFactory, connectionObserver, doOnChannelInit, isPreferNative, loggingHandler, loopResources, metricsRecorder, metricsRecorderInternal, options, updateMap

Methods inherited from class java.lang.Object

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

Method Details

baseUrl

public @Nullable String baseUrl()

Return the configured base URL to use for this request/response or null.

Returns:

the configured base URL to use for this request/response or null

channelHash

public int channelHash()

Overrides:

channelHash in class ClientTransportConfig<HttpClientConfig>

channelOperationsProvider

public ChannelOperations.OnSetup channelOperationsProvider()

Description copied from class: TransportConfig

Return the associated ChannelOperations.OnSetup, config implementations might override this.

Overrides:

channelOperationsProvider in class TransportConfig

Returns:

the associated ChannelOperations.OnSetup

connectionProvider

public ConnectionProvider connectionProvider()

Description copied from class: ClientTransportConfig

Return the ConnectionProvider.

Overrides:

connectionProvider in class ClientTransportConfig<HttpClientConfig>

Returns:

the ConnectionProvider

cookieDecoder

@Deprecated
public ClientCookieDecoder cookieDecoder()

Deprecated.

as of 1.1.0. This will be removed in 2.0.0 as Netty 5 supports only strict validation.

Return the configured ClientCookieDecoder or the default ClientCookieDecoder.STRICT.

Returns:

the configured ClientCookieDecoder or the default ClientCookieDecoder.STRICT

cookieEncoder

@Deprecated
public ClientCookieEncoder cookieEncoder()

Deprecated.

as of 1.1.0. This will be removed in 2.0.0 as Netty 5 supports only strict validation.

Return the configured ClientCookieEncoder or the default ClientCookieEncoder.STRICT.

Returns:

the configured ClientCookieEncoder or the default ClientCookieEncoder.STRICT

decoder

public HttpResponseDecoderSpec decoder()

Return the configured HTTP response decoder options or the default.

Returns:

the configured HTTP request decoder options or the default

followRedirectPredicate

public @Nullable BiPredicate<HttpClientRequest,HttpClientResponse> followRedirectPredicate()

Return the configured follow redirect predicate or null.

Returns:

the configured follow redirect predicate or null

headers

public HttpHeaders headers()

Return a copy of the request headers.

Returns:

a copy of the request headers

http2SettingsSpec

public @Nullable Http2SettingsSpec http2SettingsSpec()

Return the HTTP/2 configuration.

Returns:

the HTTP/2 configuration

http3SettingsSpec

@Incubating
public @Nullable Http3SettingsSpec http3SettingsSpec()

Return the HTTP/3 configuration.

Returns:

the HTTP/3 configuration

Since:

1.2.0

isAcceptBrotli

public boolean isAcceptBrotli()

Return whether Brotli compression is enabled.

Returns:

whether Brotli compression is enabled

isAcceptGzip

public boolean isAcceptGzip()

Return whether GZip compression is enabled.

Returns:

whether GZip compression is enabled

isRetryDisabled

public boolean isRetryDisabled()

Return true if retry once is disabled, false otherwise.

Returns:

true if retry once is disabled, false otherwise

isSecure

public boolean isSecure()

Returns true if that HttpClient secured via SSL transport.

Returns:

true if that HttpClient secured via SSL transport

method

public HttpMethod method()

Return the configured request method.

Returns:

the configured request method

protocols

public HttpProtocol[] protocols()

Return the HTTP protocol to support. Default is HttpProtocol.HTTP11.

Returns:

the HTTP protocol to support

redirectRequestBiConsumer

public @Nullable BiConsumer<HttpHeaders,HttpClientRequest> redirectRequestBiConsumer()

Return the configured redirect request BiConsumer or null.

Returns:

the configured redirect request BiConsumer or null

redirectRequestConsumer

public @Nullable Consumer<HttpClientRequest> redirectRequestConsumer()

Return the configured redirect request consumer or null.

Returns:

the configured redirect request consumer or null

responseTimeout

public @Nullable Duration responseTimeout()

Return the configured response timeout or null.

Returns:

the configured response timeout or null

sslProvider

public @Nullable SslProvider sslProvider()

Returns the current SslProvider if that HttpClient secured via SSL transport or null.

Returns:

the current SslProvider if that HttpClient secured via SSL transport or null

uri

public @Nullable String uri()

Return the configured request uri.

Returns:

the configured request uri

uriTagValue

public @Nullable Function<String,String> uriTagValue()

Returns the configured function that receives the actual uri and returns the uri tag value that will be used for the metrics with Metrics.URI tag.

Returns:

the configured function that receives the actual uri and returns the uri tag value that will be used for the metrics with Metrics.URI tag

websocketClientSpec

public @Nullable WebsocketClientSpec websocketClientSpec()

Return the configured websocket client configuration.

Returns:

the configured websocket client configuration

channelInitializer

public ChannelInitializer<Channel> channelInitializer(ConnectionObserver connectionObserver,
 @Nullable SocketAddress remoteAddress,
 boolean onServer)

Description copied from class: TransportConfig

Return the ChannelInitializer that will be used for initializing the channel pipeline.

Overrides:

channelInitializer in class TransportConfig

Parameters:

connectionObserver - the configured ConnectionObserver

remoteAddress - the remote address

onServer - channel initializer for the server or for the client

Returns:

the ChannelInitializer that will be used for initializing the channel pipeline

defaultAddressResolverGroup

public AddressResolverGroup<?> defaultAddressResolverGroup()

Provides a global AddressResolverGroup from HttpResources that is shared amongst all HTTP clients. AddressResolverGroup uses the global LoopResources from HttpResources.

Specified by:

defaultAddressResolverGroup in class ClientTransportConfig<HttpClientConfig>

Returns:

the global AddressResolverGroup

bindAddress

protected void bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)

Overrides:

bindAddress in class TransportConfig

channelType

protected Class<? extends Channel> channelType(boolean isDomainSocket)

Description copied from class: TransportConfig

Return the channel type this configuration is associated with, it can be one of the following.

• SocketChannel
• ServerSocketChannel
• DomainSocketChannel
• ServerDomainSocketChannel
• DatagramChannel

Overrides:

channelType in class ClientTransportConfig<HttpClientConfig>

Parameters:

isDomainSocket - true if DomainSocketChannel or ServerDomainSocketChannel is needed, false otherwise

Returns:

the channel type this configuration is associated with

defaultConnectionObserver

protected ConnectionObserver defaultConnectionObserver()

Description copied from class: TransportConfig

Return the configured default ConnectionObserver.

Overrides:

defaultConnectionObserver in class ClientTransportConfig<HttpClientConfig>

Returns:

the configured default ConnectionObserver

defaultLoggingHandler

protected LoggingHandler defaultLoggingHandler()

Description copied from class: TransportConfig

Return the default LoggingHandler to wiretap this transport.

Specified by:

defaultLoggingHandler in class TransportConfig

Returns:

the default LoggingHandler to wiretap this transport

defaultLoopResources

protected LoopResources defaultLoopResources()

Description copied from class: TransportConfig

Return the default LoopResources for this transport.

Specified by:

defaultLoopResources in class TransportConfig

Returns:

the default LoopResources for this transport

defaultMetricsRecorder

protected ChannelMetricsRecorder defaultMetricsRecorder()

Description copied from class: TransportConfig

Return the configured metrics recorder.

Specified by:

defaultMetricsRecorder in class TransportConfig

Returns:

the configured metrics recorder

defaultOnChannelInit

protected ChannelPipelineConfigurer defaultOnChannelInit()

Description copied from class: TransportConfig

Return the default callback if any or ChannelPipelineConfigurer.emptyConfigurer().

Overrides:

defaultOnChannelInit in class ClientTransportConfig<HttpClientConfig>

Returns:

the default callback if any or ChannelPipelineConfigurer.emptyConfigurer()

loggingHandler

protected void loggingHandler(LoggingHandler loggingHandler)

Overrides:

loggingHandler in class TransportConfig

metricsRecorder

protected void metricsRecorder(@Nullable Supplier<? extends ChannelMetricsRecorder> metricsRecorder)

Description copied from class: TransportConfig

Obtains immediately the ChannelMetricsRecorder from the provided Supplier.

Overrides:

metricsRecorder in class TransportConfig

Parameters:

metricsRecorder - a supplier for the ChannelMetricsRecorder

proxyProvider

protected void proxyProvider(ProxyProvider proxyProvider)

Overrides:

proxyProvider in class ClientTransportConfig<HttpClientConfig>

proxyProviderSupplier

protected void proxyProviderSupplier(Supplier<ProxyProvider> proxyProviderSupplier)

Overrides:

proxyProviderSupplier in class ClientTransportConfig<HttpClientConfig>

resolverInternal

protected AddressResolverGroup<?> resolverInternal()

Overrides:

resolverInternal in class ClientTransportConfig<HttpClientConfig>