Top Description Inners Fields Constructors Methods
reactor.netty.http.client

public final Class HttpClientConfig

extends ClientTransportConfig<HttpClientConfig>
Class Inheritance
Imports
java.net.SocketAddress, .URI, java.nio.charset.Charset, java.time.Duration, java.util.Map, .Objects, java.util.concurrent.TimeUnit, java.util.function.BiConsumer, .BiFunction, .BiPredicate, .Consumer, .Function, .Supplier, java.util.regex.Pattern, io.netty.channel.Channel, .ChannelHandler, .ChannelHandlerAdapter, .ChannelHandlerContext, .ChannelInboundHandlerAdapter, .ChannelInitializer, .ChannelOption, .ChannelPipeline, io.netty.handler.codec.http.DefaultHttpHeaders, .HttpClientCodec, .HttpClientUpgradeHandler, .HttpContentDecompressor, .HttpHeaders, .HttpMethod, .HttpResponse, .HttpResponseStatus, .LastHttpContent, io.netty.handler.codec.http.cookie.ClientCookieDecoder, .ClientCookieEncoder, io.netty.handler.codec.http2.Http2ClientUpgradeCodec, .Http2FrameCodec, .Http2FrameCodecBuilder, .Http2FrameLogger, .Http2MultiplexHandler, .Http2Settings, .Http2StreamFrameToHttpObjectCodec, io.netty.handler.flush.FlushConsolidationHandler, io.netty.handler.logging.LogLevel, .LoggingHandler, io.netty.handler.ssl.ApplicationProtocolNames, .SslHandler, io.netty.handler.timeout.ReadTimeoutHandler, io.netty.resolver.AddressResolverGroup, io.netty.util.ReferenceCountUtil, org.reactivestreams.Publisher, reactor.core.publisher.Mono, reactor.netty.ChannelPipelineConfigurer, .Connection, .ConnectionObserver, .NettyOutbound, .NettyPipeline, .ReactorNetty, reactor.netty.channel.ChannelMetricsRecorder, .ChannelOperations, reactor.netty.http.Http2SettingsSpec, .HttpProtocol, .HttpResources, reactor.netty.http.logging.HttpMessageLogFactory, .ReactorNettyHttpMessageLogFactory, reactor.netty.resources.ConnectionProvider, .LoopResources, reactor.netty.tcp.SslProvider, reactor.netty.transport.ClientTransportConfig, .ProxyProvider, reactor.netty.transport.logging.AdvancedByteBufFormat, reactor.util.Logger, .Loggers, reactor.util.annotation.Nullable, reactor.util.context.Context
Encapsulate all necessary configuration for HTTP client transport. The public API is read-only.
Authors
Stephane Maldini, Violeta Georgieva

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
HttpClientConfig.H2CleartextCodec

pack-priv static class
HttpClientConfig.H2Codec

pack-priv static class
HttpClientConfig.H2InboundStreamHandler

Handle inbound streams (server pushes).

pack-priv static class
HttpClientConfig.H2OrHttp11Codec

pack-priv static class
HttpClientConfig.HttpClientChannelInitializer

pack-priv static class
HttpClientConfig.HttpClientDoOn

pack-priv static class
HttpClientConfig.ReactorNettyHttpClientUpgradeHandler

pack-priv static class
HttpClientConfig.StreamConnectionObserver

Field Summary

Modifier and TypeField and Description
pack-priv int
_protocols

pack-priv boolean
acceptGzip

pack-priv String
baseUrl

pack-priv BiFunction<? super HttpClientRequest, ? super NettyOutbound, ? extends Publisher<Void>>
body

pack-priv Function<? super Mono<? extends Connection>, ? extends Mono<? extends Connection>>
connector

pack-priv ClientCookieDecoder
cookieDecoder

pack-priv ClientCookieEncoder
cookieEncoder

pack-priv HttpResponseDecoderSpec
decoder

pack-priv Function<Mono<HttpClientConfig>, Mono<HttpClientConfig>>
deferredConf

pack-priv BiConsumer<? super HttpClientRequest, ? super Connection>
doAfterRequest

pack-priv BiConsumer<? super HttpClientResponse, ? super Connection>
doAfterResponseSuccess

pack-priv BiConsumer<? super HttpClientResponse, ? super Connection>
doOnRedirect

pack-priv BiConsumer<? super HttpClientRequest, ? super Connection>
doOnRequest

pack-priv BiConsumer<? super HttpClientRequest, ? super Throwable>
doOnRequestError

pack-priv BiConsumer<? super HttpClientResponse, ? super Connection>
doOnResponse

pack-priv BiConsumer<? super HttpClientResponse, ? super Throwable>
doOnResponseError

pack-priv static final Pattern
FOLLOW_REDIRECT_CODES

pack-priv static final BiPredicate<HttpClientRequest, HttpClientResponse>
FOLLOW_REDIRECT_PREDICATE

pack-priv BiPredicate<HttpClientRequest, HttpClientResponse>
followRedirectPredicate

pack-priv static final int
h11

pack-priv static final int
h11orH2

pack-priv static final int
h11orH2C

pack-priv static final int
h2

pack-priv static final int
h2c

pack-priv HttpHeaders
headers

pack-priv static final Http2StreamFrameToHttpObjectCodec
HTTP2_STREAM_FRAME_TO_HTTP_OBJECT

pack-priv Http2SettingsSpec
http2Settings

pack-priv static final Http2StreamBridgeClientHandler
HTTP_2_STREAM_BRIDGE_CLIENT_HANDLER

pack-priv HttpMessageLogFactory
httpMessageLogFactory

pack-priv static final Logger
log

Hides reactor.netty.transport.TransportConfig.log.

pack-priv static final LoggingHandler
LOGGING_HANDLER

pack-priv HttpMethod
method

pack-priv HttpProtocol[]
protocols

pack-priv BiConsumer<HttpHeaders, HttpClientRequest>
redirectRequestBiConsumer

pack-priv Consumer<HttpClientRequest>
redirectRequestConsumer

pack-priv Duration
responseTimeout

pack-priv boolean
retryDisabled

pack-priv static final boolean
SSL_DEBUG

Default value whether the SSL debugging on the client side will be enabled/disabled, fallback to SSL debugging disabled.

pack-priv SslProvider
sslProvider

pack-priv URI
uri

pack-priv String
uriStr

pack-priv Function<String, String>
uriTagValue

pack-priv WebsocketClientSpec
websocketClientSpec

Constructor Summary

AccessConstructor and Description
pack-priv
HttpClientConfig(HttpConnectionProvider connectionProvider, Map<ChannelOption<?>, ?> options, Supplier<? extends SocketAddress> remoteAddress)

pack-priv
HttpClientConfig(HttpClientConfig parent)

Method Summary

Modifier and TypeMethod and Description
pack-priv static void
addStreamHandlers(Channel ch, ConnectionObserver obs, ChannelOperations.OnSetup opsFactory, boolean acceptGzip, ChannelMetricsRecorder metricsRecorder, long responseTimeoutMillis, Function<String, String> uriTagValue)

public String

Returns:

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

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

public int
channelHash()

Overrides reactor.netty.transport.ClientTransportConfig.channelHash.

public ChannelOperations.OnSetup
channelOperationsProvider()

Overrides reactor.netty.transport.TransportConfig.channelOperationsProvider.

Return the associated ChannelOperations.OnSetup, config implementations might override this.
pack-priv boolean
checkProtocol(int protocol)

pack-priv static void
configureHttp11OrH2CleartextPipeline(ChannelPipeline p, boolean acceptGzip, HttpResponseDecoderSpec decoder, Http2Settings http2Settings, ChannelMetricsRecorder metricsRecorder, ConnectionObserver observer, ChannelOperations.OnSetup opsFactory, Function<String, String> uriTagValue)

pack-priv static void
configureHttp11Pipeline(ChannelPipeline p, boolean acceptGzip, HttpResponseDecoderSpec decoder, ChannelMetricsRecorder metricsRecorder, Function<String, String> uriTagValue)

pack-priv static void
configureHttp2Pipeline(ChannelPipeline p, boolean acceptGzip, HttpResponseDecoderSpec decoder, Http2Settings http2Settings, ConnectionObserver observer)

public ConnectionProvider
connectionProvider()

Overrides reactor.netty.transport.ClientTransportConfig.connectionProvider.

Return the ConnectionProvider.
public ClientCookieDecoder

Returns:

the configured ClientCookieDecoder or the default ClientCookieDecoder#STRICT
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.
public ClientCookieEncoder

Returns:

the configured ClientCookieEncoder or the default ClientCookieEncoder#STRICT
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.
public HttpResponseDecoderSpec

Returns:

the configured HTTP request decoder options or the default
decoder()

Return the configured HTTP response decoder options or the default.

public AddressResolverGroup<?>

Returns:

the global AddressResolverGroup
defaultAddressResolverGroup()

Implements abstract reactor.netty.transport.ClientTransportConfig.defaultAddressResolverGroup.

Provides a global AddressResolverGroup from HttpResources that is shared amongst all HTTP clients.
protected ConnectionObserver
defaultConnectionObserver()

Overrides reactor.netty.transport.ClientTransportConfig.defaultConnectionObserver.

Return the configured default ConnectionObserver.
protected LoggingHandler
defaultLoggingHandler()

Implements abstract reactor.netty.transport.TransportConfig.defaultLoggingHandler.

Return the default LoggingHandler to wiretap this transport.
protected LoopResources
defaultLoopResources()

Implements abstract reactor.netty.transport.TransportConfig.defaultLoopResources.

Return the default LoopResources for this transport.
protected ChannelMetricsRecorder
defaultMetricsRecorder()

Implements abstract reactor.netty.transport.TransportConfig.defaultMetricsRecorder.

Return the configured metrics recorder.
protected ChannelPipelineConfigurer
defaultOnChannelInit()

Overrides reactor.netty.transport.ClientTransportConfig.defaultOnChannelInit.

Return the default callback if any or ChannelPipelineConfigurer#emptyConfigurer().
pack-priv void
deferredConf(Function<HttpClientConfig, Mono<HttpClientConfig>> deferrer)

public BiPredicate<HttpClientRequest, HttpClientResponse>

Returns:

the configured follow redirect predicate or null
followRedirectPredicate()

Return the configured follow redirect predicate or null.

public HttpHeaders

Returns:

a copy of the request headers
headers()

Return a copy of the request headers.

pack-priv Http2Settings
http2Settings()

public Http2SettingsSpec

Returns:

the HTTP/2 configuration
http2SettingsSpec()

Return the HTTP/2 configuration.

pack-priv HttpConnectionProvider
httpConnectionProvider()

public boolean

Returns:

whether GZip compression is enabled
isAcceptGzip()

Return whether GZip compression is enabled.

public boolean

Returns:

true if retry once is disabled, false otherwise
isRetryDisabled()

Return true if retry once is disabled, false otherwise.

public boolean

Returns:

true if that HttpClient secured via SSL transport
isSecure()

Returns true if that HttpClient secured via SSL transport.

protected void
loggingHandler(LoggingHandler loggingHandler)

Overrides reactor.netty.transport.TransportConfig.loggingHandler.

public HttpMethod

Returns:

the configured request method
method()

Return the configured request method.

protected void
metricsRecorder(Supplier<? extends ChannelMetricsRecorder>
a supplier for the ChannelMetricsRecorder
metricsRecorder)

Overrides reactor.netty.transport.TransportConfig.metricsRecorder.

Obtains immediately the ChannelMetricsRecorder from the provided Supplier.
public HttpProtocol[]

Returns:

the HTTP protocol to support
protocols()

Return the HTTP protocol to support.

pack-priv void
protocols(HttpProtocol... protocols)

protected void
proxyProvider(ProxyProvider proxyProvider)

Overrides reactor.netty.transport.ClientTransportConfig.proxyProvider.

public BiConsumer<HttpHeaders, HttpClientRequest>

Returns:

the configured redirect request BiConsumer or null
redirectRequestBiConsumer()

Return the configured redirect request BiConsumer or null.

public Consumer<HttpClientRequest>

Returns:

the configured redirect request consumer or null
redirectRequestConsumer()

Return the configured redirect request consumer or null.

protected AddressResolverGroup<?>
resolverInternal()

Overrides reactor.netty.transport.ClientTransportConfig.resolverInternal.

public Duration

Returns:

the configured response timeout or null
responseTimeout()

Return the configured response timeout or null.

public SslProvider

Returns:

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

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

public String

Returns:

the configured request uri
uri()

Return the configured request uri.

public Function<String, String>

Returns:

the configured function that receives the actual uri and returns the uri tag value that will be used for the metrics with reactor.netty.Metrics#URI tag
uriTagValue()

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

public WebsocketClientSpec

Returns:

the configured websocket client configuration
websocketClientSpec()

Return the configured websocket client configuration.

Inherited from reactor.netty.transport.ClientTransportConfig:
channelTypedoOnConnectdoOnConnecteddoOnDisconnectedeventLoopGroupgetNameResolverProviderhasProxyproxyProviderremoteAddressresolver