Package reactor.netty.http.server

Class HttpServerConfig

java.lang.Object

reactor.netty.transport.TransportConfig

reactor.netty.transport.ServerTransportConfig<HttpServerConfig>

reactor.netty.http.server.HttpServerConfig

public final class HttpServerConfig
extends ServerTransportConfig<HttpServerConfig>

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

Author:

Stephane Maldini, Violeta Georgieva, Andrey Shlykov

Method Summary

Modifier and Type	Method	Description
ChannelInitializer<Channel>	channelInitializer(ConnectionObserver connectionObserver, @Nullable SocketAddress remoteAddress, boolean onServer)	Return the ChannelInitializer that will be used for initializing the channel pipeline.
protected Class<? extends Channel>	channelType(boolean isDomainSocket)	Return the channel type this configuration is associated with, it can be one of the following.
@Nullable BiPredicate<HttpServerRequest,HttpServerResponse>	compressPredicate()	Return the configured compression predicate or null.
ServerCookieDecoder	cookieDecoder()	Deprecated. as of 1.1.0.
ServerCookieEncoder	cookieEncoder()	Deprecated. as of 1.1.0.
HttpRequestDecoderSpec	decoder()	Return the configured HTTP request decoder options or the default.
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().
HttpServerFormDecoderProvider	formDecoderProvider()	Return the configured HTTP form decoder or the default.
@Nullable Http2SettingsSpec	http2SettingsSpec()	Return the HTTP/2 configuration.
@Nullable Http3SettingsSpec	http3SettingsSpec()	Return the HTTP/3 configuration.
@Nullable Duration	idleTimeout()	Return the configured idle timeout for the connection when it is waiting for an HTTP request or null.
boolean	isForwarded()	Returns whether that HttpServer supports the "Forwarded" and "X-Forwarded-*" HTTP request headers for deriving information about the connection.
boolean	isSecure()	Returns true if that HttpServer secured via SSL transport.
protected void	loggingHandler(LoggingHandler loggingHandler)
int	maxKeepAliveRequests()	The configured maximum number of HTTP/1.1 requests which can be served until the connection is closed by the server.
protected void	metricsRecorder(@Nullable Supplier<? extends ChannelMetricsRecorder> metricsRecorder)	Obtains immediately the ChannelMetricsRecorder from the provided Supplier.
int	minCompressionSize()	Compression is performed once response size exceeds the minimum compression size in bytes.
HttpProtocol[]	protocols()	Return the HTTP protocol to support.
ProxyProtocolSupportType	proxyProtocolSupportType()	Return the supported type for the "HAProxy proxy protocol".
@Nullable Duration	readTimeout()	Return the configured read timeout for the request or null.
boolean	redirectHttpToHttps()	Returns true if that HttpServer will redirect HTTP to HTTPS by changing the scheme only but otherwise leaving the port the same when SSL is enabled.
@Nullable Duration	requestTimeout()	Return the configured request timeout for the request or null.
@Nullable SslProvider	sslProvider()	Returns the current SslProvider if that HttpServer secured via SSL transport or null.
@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.

Methods inherited from class reactor.netty.transport.ServerTransportConfig

childAttributes, childObserver, childOptions, defaultChildObserver, defaultConnectionObserver, doOnBind, doOnBound, doOnConnection, doOnUnbound, eventLoopGroup

Methods inherited from class reactor.netty.transport.TransportConfig

attributes, bindAddress, bindAddress, channelGroup, channelHash, channelOperationsProvider, 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

compressPredicate

public @Nullable BiPredicate<HttpServerRequest,HttpServerResponse> compressPredicate()

Return the configured compression predicate or null.

Returns:

the configured compression predicate or null

cookieDecoder

@Deprecated
public ServerCookieDecoder 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 ServerCookieDecoder or the default ServerCookieDecoder.STRICT.

Returns:

the configured ServerCookieDecoder or the default ServerCookieDecoder.STRICT

cookieEncoder

@Deprecated
public ServerCookieEncoder 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 ServerCookieEncoder or the default ServerCookieEncoder.STRICT.

Returns:

the configured ServerCookieEncoder or the default ServerCookieEncoder.STRICT

decoder

public HttpRequestDecoderSpec decoder()

Return the configured HTTP request decoder options or the default.

Returns:

the configured HTTP request decoder options or the default

formDecoderProvider

public HttpServerFormDecoderProvider formDecoderProvider()

Return the configured HTTP form decoder or the default.

Returns:

the configured HTTP form decoder or the default

Since:

1.0.11

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

idleTimeout

public @Nullable Duration idleTimeout()

Return the configured idle timeout for the connection when it is waiting for an HTTP request or null.

Returns:

the configured idle timeout for the connection when it is waiting for an HTTP request or null

isForwarded

public boolean isForwarded()

Returns whether that HttpServer supports the "Forwarded" and "X-Forwarded-*" HTTP request headers for deriving information about the connection.

Returns:

true if that HttpServer supports the "Forwarded" and "X-Forwarded-*" HTTP request headers for deriving information about the connection

isSecure

public boolean isSecure()

Returns true if that HttpServer secured via SSL transport.

Returns:

true if that HttpServer secured via SSL transport

maxKeepAliveRequests

public int maxKeepAliveRequests()

The configured maximum number of HTTP/1.1 requests which can be served until the connection is closed by the server.

Returns:

the configured maximum number of HTTP/1.1 requests which can be served until the connection is closed by the server.

Since:

1.0.13

See Also:

• HttpServer.maxKeepAliveRequests(int)

minCompressionSize

public int minCompressionSize()

Compression is performed once response size exceeds the minimum compression size in bytes.

Returns:

the minimum compression size in bytes

protocols

public HttpProtocol[] protocols()

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

Returns:

the HTTP protocol to support

proxyProtocolSupportType

public ProxyProtocolSupportType proxyProtocolSupportType()

Return the supported type for the "HAProxy proxy protocol". The default is ProxyProtocolSupportType.OFF.

Returns:

the supported type for the "HAProxy proxy protocol"

readTimeout

public @Nullable Duration readTimeout()

Return the configured read timeout for the request or null.

Returns:

the configured read timeout for the request or null

Since:

1.1.9

redirectHttpToHttps

public boolean redirectHttpToHttps()

Returns true if that HttpServer will redirect HTTP to HTTPS by changing the scheme only but otherwise leaving the port the same when SSL is enabled. This configuration is applicable only for HTTP/1.x.

Returns:

true if that HttpServer will redirect HTTP to HTTPS by changing the scheme only but otherwise leaving the port the same when SSL is enabled. This configuration is applicable only for HTTP/1.x.

requestTimeout

public @Nullable Duration requestTimeout()

Return the configured request timeout for the request or null.

Returns:

the configured request timeout for the request or null

Since:

1.1.9

sslProvider

public @Nullable SslProvider sslProvider()

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

Returns:

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

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

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

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 ServerTransportConfig<HttpServerConfig>

Parameters:

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

Returns:

the channel type this configuration is associated with

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 ServerTransportConfig<HttpServerConfig>

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