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

Method Summary

Modifier and Type	Method and Description
java.util.function.BiPredicate<HttpServerRequest,HttpServerResponse>	compressPredicate() Return the configured compression predicate or null.
ServerCookieDecoder	cookieDecoder() Return the configured ServerCookieDecoder or the default ServerCookieDecoder.STRICT.
ServerCookieEncoder	cookieEncoder() Return the configured ServerCookieEncoder or the default ServerCookieEncoder.STRICT.
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()
Http2SettingsSpec	http2SettingsSpec() Return the HTTP/2 configuration
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)
protected void	metricsRecorder(java.util.function.Supplier<? extends ChannelMetricsRecorder> metricsRecorder)
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".
SslProvider	sslProvider() Returns the current SslProvider if that TcpServer secured via SSL transport or null
java.util.function.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

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

Methods inherited from class reactor.netty.transport.TransportConfig

attributes, bindAddress, channelGroup, channelHash, channelInitializer, channelOperationsProvider, connectionFactory, connectionObserver, doOnChannelInit, isPreferNative, loggingHandler, loopResources, metricsRecorder, options, updateMap

Methods inherited from class java.lang.Object

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

Method Detail

compressPredicate

@Nullable
public java.util.function.BiPredicate<HttpServerRequest,HttpServerResponse> compressPredicate()

Return the configured compression predicate or null.

Returns:

the configured compression predicate or null

cookieDecoder

public ServerCookieDecoder cookieDecoder()

Return the configured ServerCookieDecoder or the default ServerCookieDecoder.STRICT.

Returns:

the configured ServerCookieDecoder or the default ServerCookieDecoder.STRICT

cookieEncoder

public ServerCookieEncoder cookieEncoder()

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

http2SettingsSpec

public Http2SettingsSpec http2SettingsSpec()

Return the HTTP/2 configuration

Returns:

the HTTP/2 configuration

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

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"

sslProvider

@Nullable
public SslProvider sslProvider()

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

Returns:

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

uriTagValue

@Nullable
public java.util.function.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

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
                               java.util.function.Supplier<? extends ChannelMetricsRecorder> metricsRecorder)

Overrides:

metricsRecorder in class TransportConfig