Package reactor.netty.http.client

Class HttpResponseDecoderSpec

java.lang.Object

reactor.netty.http.HttpDecoderSpec<HttpResponseDecoderSpec>

reactor.netty.http.client.HttpResponseDecoderSpec

All Implemented Interfaces:

Supplier<HttpResponseDecoderSpec>

public final class HttpResponseDecoderSpec
extends HttpDecoderSpec<HttpResponseDecoderSpec>

A configuration builder to fine tune the HttpClientCodec (or more precisely the HttpClientCodec.Decoder).

Defaults are accessible as constants:

HttpDecoderSpec.DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS	false
DEFAULT_FAIL_ON_MISSING_RESPONSE	false
DEFAULT_H2C_MAX_CONTENT_LENGTH	65536
HttpDecoderSpec.DEFAULT_INITIAL_BUFFER_SIZE	128
HttpDecoderSpec.DEFAULT_MAX_CHUNK_SIZE	8192
DEFAULT_MAX_DECOMPRESSION_BUFFER_SIZE	0
HttpDecoderSpec.DEFAULT_MAX_HEADER_SIZE	8192
HttpDecoderSpec.DEFAULT_MAX_INITIAL_LINE_LENGTH	4096
DEFAULT_PARSE_HTTP_AFTER_CONNECT_REQUEST	false
HttpDecoderSpec.DEFAULT_VALIDATE_HEADERS	true
HttpDecoderSpec.DEFAULT_ALLOW_PARTIAL_CHUNKS	true

Author:

Violeta Georgieva

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_FAIL_ON_MISSING_RESPONSE
static final int	DEFAULT_H2C_MAX_CONTENT_LENGTH	The maximum length of the content of the HTTP/2.0 clear-text upgrade request.
static final int	DEFAULT_MAX_DECOMPRESSION_BUFFER_SIZE	The default maximum allowed size of the decompression buffer, in bytes, used when decompressing a compressed HTTP response body.
static final boolean	DEFAULT_PARSE_HTTP_AFTER_CONNECT_REQUEST

Fields inherited from class reactor.netty.http.HttpDecoderSpec

allowDuplicateContentLengths, allowPartialChunks, DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS, DEFAULT_ALLOW_PARTIAL_CHUNKS, DEFAULT_INITIAL_BUFFER_SIZE, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_VALIDATE_HEADERS, h2cMaxContentLength, initialBufferSize, maxChunkSize, maxHeaderSize, maxInitialLineLength, validateHeaders

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
HttpResponseDecoderSpec	failOnMissingResponse(boolean failOnMissingResponse)	Configure whether to throw an exception on a channel inactive in case there was a missing response.
HttpResponseDecoderSpec	get()
int	hashCode()
int	maxDecompressionBufferSize()	Return the configured maximum allowed size, in bytes, of the buffer used to decompress a compressed HTTP response body.
HttpResponseDecoderSpec	maxDecompressionBufferSize(int value)	Configure the maximum allowed size, in bytes, of the buffer used to decompress a compressed HTTP response body (applies to gzip/deflate/br/zstd when compression is enabled).
HttpResponseDecoderSpec	parseHttpAfterConnectRequest(boolean parseHttpAfterConnectRequest)	Configure whether the HTTP decoding will continue even after HTTP CONNECT.

Methods inherited from class reactor.netty.http.HttpDecoderSpec

allowDuplicateContentLengths, allowDuplicateContentLengths, allowPartialChunks, allowPartialChunks, h2cMaxContentLength, h2cMaxContentLength, initialBufferSize, initialBufferSize, maxChunkSize, maxChunkSize, maxHeaderSize, maxHeaderSize, maxInitialLineLength, maxInitialLineLength, validateHeaders, validateHeaders

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_FAIL_ON_MISSING_RESPONSE

public static final boolean DEFAULT_FAIL_ON_MISSING_RESPONSE

See Also:

• Constant Field Values

DEFAULT_PARSE_HTTP_AFTER_CONNECT_REQUEST

public static final boolean DEFAULT_PARSE_HTTP_AFTER_CONNECT_REQUEST

See Also:

• Constant Field Values

DEFAULT_H2C_MAX_CONTENT_LENGTH

public static final int DEFAULT_H2C_MAX_CONTENT_LENGTH

The maximum length of the content of the HTTP/2.0 clear-text upgrade request. By default, the client will allow an upgrade request with up to 65536 as the maximum length of the aggregated content.

See Also:

• Constant Field Values

DEFAULT_MAX_DECOMPRESSION_BUFFER_SIZE

public static final int DEFAULT_MAX_DECOMPRESSION_BUFFER_SIZE

The default maximum allowed size of the decompression buffer, in bytes, used when decompressing a compressed HTTP response body. 0 means that the maximum size is not limited.

See Also:

• Constant Field Values

Method Details

get

public HttpResponseDecoderSpec get()

failOnMissingResponse

public HttpResponseDecoderSpec failOnMissingResponse(boolean failOnMissingResponse)

Configure whether to throw an exception on a channel inactive in case there was a missing response.

Parameters:

failOnMissingResponse - true - throw an exception on a channel inactive in case there was a missing response, otherwise false

Returns:

this option builder for further configuration

parseHttpAfterConnectRequest

public HttpResponseDecoderSpec parseHttpAfterConnectRequest(boolean parseHttpAfterConnectRequest)

Configure whether the HTTP decoding will continue even after HTTP CONNECT.

Parameters:

parseHttpAfterConnectRequest - true to continue HTTP decoding, otherwise false

Returns:

this option builder for further configuration

maxDecompressionBufferSize

public HttpResponseDecoderSpec maxDecompressionBufferSize(int value)

Configure the maximum allowed size, in bytes, of the buffer used to decompress a compressed HTTP response body (applies to gzip/deflate/br/zstd when compression is enabled). When the decompression buffer reaches this size and cannot be expanded further, a io.netty.handler.codec.compression.DecompressionException is thrown. Defaults to DEFAULT_MAX_DECOMPRESSION_BUFFER_SIZE (0), which means that the maximum size is not limited.

Parameters:

value - the maximum allowed size of the decompression buffer, in bytes; 0 means the maximum size is not limited (non-negative)

Returns:

this option builder for further configuration

Since:

1.0.53

maxDecompressionBufferSize

public int maxDecompressionBufferSize()

Return the configured maximum allowed size, in bytes, of the buffer used to decompress a compressed HTTP response body. 0 means the maximum size is not limited.

Returns:

the configured maximum allowed size of the decompression buffer, in bytes

Since:

1.0.53

equals

public boolean equals(Object o)

Overrides:

equals in class HttpDecoderSpec<HttpResponseDecoderSpec>

hashCode

public int hashCode()

Overrides:

hashCode in class HttpDecoderSpec<HttpResponseDecoderSpec>