reactor.ipc.netty.http.server

Class HttpServerOptions.Builder

java.lang.Object

reactor.ipc.netty.options.NettyOptions.Builder<ServerBootstrap,ServerOptions,BUILDER>

reactor.ipc.netty.options.ServerOptions.Builder<HttpServerOptions.Builder>

reactor.ipc.netty.http.server.HttpServerOptions.Builder

All Implemented Interfaces:

java.util.function.Supplier<HttpServerOptions.Builder>

Enclosing class:

HttpServerOptions

public static final class HttpServerOptions.Builder
extends ServerOptions.Builder<HttpServerOptions.Builder>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INITIAL_BUFFER_SIZE
static int	DEFAULT_MAX_CHUNK_SIZE
static int	DEFAULT_MAX_HEADER_SIZE
static int	DEFAULT_MAX_INITIAL_LINE_LENGTH
static boolean	DEFAULT_VALIDATE_HEADERS

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

bootstrapTemplate

Method Summary

Modifier and Type	Method and Description
HttpServerOptions	build()
HttpServerOptions.Builder	compression(boolean enabled) Enable GZip response compression if the client request presents accept encoding headers
HttpServerOptions.Builder	compression(int minResponseSize) Enable GZip response compression if the client request presents accept encoding headers AND the response reaches a minimum threshold
HttpServerOptions.Builder	from(HttpServerOptions options) Fill the builder with attribute values from the provided options.
HttpServerOptions.Builder	initialBufferSize(int value) Configure the initial buffer size for HTTP request decoding.
HttpServerOptions.Builder	maxChunkSize(int value) Configure the maximum chunk size that can be decoded for the HTTP request.
HttpServerOptions.Builder	maxHeaderSize(int value) Configure the maximum header size that can be decoded for the HTTP request.
HttpServerOptions.Builder	maxInitialLineLength(int value) Configure the maximum length that can be decoded for the HTTP request's initial line.
HttpServerOptions.Builder	validateHeaders(boolean validate) Configure whether or not to validate headers when decoding requests.

Methods inherited from class reactor.ipc.netty.options.ServerOptions.Builder

attr, from, get, host, listenAddress, option, port, selectorAttr, selectorOption, sslSelfSigned, sslSelfSigned

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

afterChannelInit, afterNettyContextInit, channelGroup, eventLoopGroup, isLoopAvailable, loopResources, onChannelInit, preferNative, sslCloseNotifyFlushTimeout, sslCloseNotifyFlushTimeoutMillis, sslCloseNotifyReadTimeout, sslCloseNotifyReadTimeoutMillis, sslContext, sslHandshakeTimeout, sslHandshakeTimeoutMillis

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_INITIAL_LINE_LENGTH

public static final int DEFAULT_MAX_INITIAL_LINE_LENGTH

See Also:

Constant Field Values

DEFAULT_MAX_HEADER_SIZE

public static final int DEFAULT_MAX_HEADER_SIZE

See Also:

Constant Field Values

DEFAULT_MAX_CHUNK_SIZE

public static final int DEFAULT_MAX_CHUNK_SIZE

See Also:

Constant Field Values

DEFAULT_VALIDATE_HEADERS

public static final boolean DEFAULT_VALIDATE_HEADERS

See Also:

Constant Field Values

DEFAULT_INITIAL_BUFFER_SIZE

public static final int DEFAULT_INITIAL_BUFFER_SIZE

See Also:

Constant Field Values

Method Detail

compression

public final HttpServerOptions.Builder compression(boolean enabled)

Enable GZip response compression if the client request presents accept encoding headers

Parameters:

enabled - true whether compression is enabled

Returns:

this

compression

public final HttpServerOptions.Builder compression(int minResponseSize)

Enable GZip response compression if the client request presents accept encoding headers AND the response reaches a minimum threshold

Parameters:

minResponseSize - compression is performed once response size exceeds given value in byte

Returns:

this

maxInitialLineLength

public final HttpServerOptions.Builder maxInitialLineLength(int value)

Configure the maximum length that can be decoded for the HTTP request's initial line. Defaults to #DEFAULT_MAX_INITIAL_LINE_LENGTH.

Parameters:

value - the value for the maximum initial line length (strictly positive)

Returns:

this option builder for further configuration

maxHeaderSize

public final HttpServerOptions.Builder maxHeaderSize(int value)

Configure the maximum header size that can be decoded for the HTTP request. Defaults to DEFAULT_MAX_HEADER_SIZE.

Parameters:

value - the value for the maximum header size (strictly positive)

Returns:

this option builder for further configuration

maxChunkSize

public final HttpServerOptions.Builder maxChunkSize(int value)

Configure the maximum chunk size that can be decoded for the HTTP request. Defaults to DEFAULT_MAX_CHUNK_SIZE.

Parameters:

value - the value for the maximum chunk size (strictly positive)

Returns:

this option builder for further configuration

validateHeaders

public final HttpServerOptions.Builder validateHeaders(boolean validate)

Configure whether or not to validate headers when decoding requests. Defaults to #DEFAULT_VALIDATE_HEADERS.

Parameters:

validate - true to validate headers, false otherwise

Returns:

this option builder for further configuration

initialBufferSize

public final HttpServerOptions.Builder initialBufferSize(int value)

Configure the initial buffer size for HTTP request decoding. Defaults to DEFAULT_INITIAL_BUFFER_SIZE.

Parameters:

value - the initial buffer size to use (strictly positive)

Returns:

from

public final HttpServerOptions.Builder from(HttpServerOptions options)

Fill the builder with attribute values from the provided options.

Parameters:

options - The instance from which to copy values

Returns:

this

build

public HttpServerOptions build()

Overrides:

build in class ServerOptions.Builder<HttpServerOptions.Builder>