HTTP functionality for the Reactor Netty library 1.1.16 · reactor.netty.http.HttpDecoderSpec

Modifier and Type	Field and Description
protected boolean	allowDuplicateContentLengths
public static final boolean	DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS
public static final int	DEFAULT_INITIAL_BUFFER_SIZE
public static final int	DEFAULT_MAX_CHUNK_SIZE Default max chunk size.
public static final int	DEFAULT_MAX_HEADER_SIZE
public static final int	DEFAULT_MAX_INITIAL_LINE_LENGTH
public static final boolean	DEFAULT_VALIDATE_HEADERS
protected int	h2cMaxContentLength
protected int	initialBufferSize
protected int	maxChunkSize
protected int	maxHeaderSize
protected int	maxInitialLineLength
protected boolean	validateHeaders

Access	Constructor and Description
public	HttpDecoderSpec()

Method Summary

Modifier and Type	Method and Description
public T	Returns: this option builder for further configuration allowDuplicateContentLengths(boolean true to allow duplicate `Content-Length` headers with the same value, false otherwise allow) Configure whether to allow duplicate `Content-Length` headers.
public boolean	Returns: the configuration whether to allow duplicate `Content-Length` headers allowDuplicateContentLengths() Return the configuration whether to allow duplicate `Content-Length` headers.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public T	Returns: this builder for further configuration h2cMaxContentLength(int the maximum length of the content of the upgrade request h2cMaxContentLength) Configure the maximum length of the content of the HTTP/2.0 clear-text upgrade request.
public int	Returns: the configured maximum length of the content of the HTTP/2.0 clear-text upgrade request h2cMaxContentLength() Return the configured maximum length of the content of the HTTP/2.0 clear-text upgrade request.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public T	Returns: this option builder for further configuration initialBufferSize(int the initial buffer size to use (strictly positive) value) Configure the initial buffer size for HTTP request decoding.
public int	Returns: the configured initial buffer size for HTTP request decoding initialBufferSize() Return the configured initial buffer size for HTTP request decoding.
public T	Returns: this option builder for further configuration maxChunkSize(int the value for the maximum chunk size (strictly positive) value) Deprecated as of 1.1.0. This will be removed in 2.0.0 as Netty 5 does not support this configuration. Configure the maximum chunk size that can be decoded for the HTTP request.
public int	Returns: the configured maximum chunk size that can be decoded for the HTTP request maxChunkSize() Deprecated as of 1.1.0. This will be removed in 2.0.0 as Netty 5 does not support this configuration. Return the configured maximum chunk size that can be decoded for the HTTP request.
public T	Returns: this option builder for further configuration maxHeaderSize(int the value for the maximum header size (strictly positive) value) Configure the maximum header size that can be decoded for the HTTP request.
public int	Returns: the configured maximum header size that can be decoded for the HTTP request maxHeaderSize() Return the configured maximum header size that can be decoded for the HTTP request.
public T	Returns: this option builder for further configuration maxInitialLineLength(int the value for the maximum initial line length (strictly positive) value) Configure the maximum length that can be decoded for the HTTP request's initial line.
public int	Returns: the configured maximum length that can be decoded for the HTTP request's initial line maxInitialLineLength() Return the configured maximum length that can be decoded for the HTTP request's initial line.
public T	Returns: this option builder for further configuration validateHeaders(boolean true to validate headers, false otherwise validate) Configure whether to validate headers when decoding requests.
public boolean	Returns: the configuration whether to validate headers when decoding requests validateHeaders() Return the configuration whether to validate headers when decoding requests.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

allowDuplicateContentLengths	back to summary
protected boolean allowDuplicateContentLengths

DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS	back to summary
public static final boolean DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS

DEFAULT_INITIAL_BUFFER_SIZE	back to summary
public static final int DEFAULT_INITIAL_BUFFER_SIZE

DEFAULT_MAX_CHUNK_SIZE	back to summary
public static final int DEFAULT_MAX_CHUNK_SIZE Deprecated as of 1.1.0. This will be removed in 2.0.0 as Netty 5 does not support this configuration. Default max chunk size. Annotations @Deprecated

DEFAULT_MAX_HEADER_SIZE	back to summary
public static final int DEFAULT_MAX_HEADER_SIZE

DEFAULT_MAX_INITIAL_LINE_LENGTH	back to summary
public static final int DEFAULT_MAX_INITIAL_LINE_LENGTH

DEFAULT_VALIDATE_HEADERS	back to summary
public static final boolean DEFAULT_VALIDATE_HEADERS

h2cMaxContentLength	back to summary
protected int h2cMaxContentLength

initialBufferSize	back to summary
protected int initialBufferSize

maxChunkSize	back to summary
protected int maxChunkSize

maxHeaderSize	back to summary
protected int maxHeaderSize

maxInitialLineLength	back to summary
protected int maxInitialLineLength

validateHeaders	back to summary
protected boolean validateHeaders

HttpDecoderSpec	back to summary
public HttpDecoderSpec()

Method Detail

allowDuplicateContentLengths back to summary

allowDuplicateContentLengths	back to summary
public T allowDuplicateContentLengths(boolean allow) Configure whether to allow duplicate `Content-Length` headers. Defaults to `DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS` which means that a message with duplicate `Content-Length` headers is rejected. When this is configured to `true`, duplicate `Content-Length` headers are accepted only if they are all the same value, otherwise such message is rejected. The duplicated `Content-Length` headers are replaced with a single valid `Content-Length` header. Parameters allow:boolean true to allow duplicate `Content-Length` headers with the same value, false otherwise Returns:T this option builder for further configuration Since 1.0.8

public T allowDuplicateContentLengths(boolean allow)

Configure whether to allow duplicate Content-Length headers. Defaults to DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS which means that a message with duplicate Content-Length headers is rejected. When this is configured to true, duplicate Content-Length headers are accepted only if they are all the same value, otherwise such message is rejected. The duplicated Content-Length headers are replaced with a single valid Content-Length header.

Parameters

allow:boolean: true to allow duplicate Content-Length headers with the same value, false otherwise

Returns:T

this option builder for further configuration

Since

1.0.8

allowDuplicateContentLengths back to summary

allowDuplicateContentLengths	back to summary
public boolean allowDuplicateContentLengths() Return the configuration whether to allow duplicate `Content-Length` headers. Returns:boolean the configuration whether to allow duplicate `Content-Length` headers Since 1.0.8

public boolean allowDuplicateContentLengths()

Return the configuration whether to allow duplicate Content-Length headers.

Returns:boolean: the configuration whether to allow duplicate Content-Length headers
Since: 1.0.8

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

h2cMaxContentLength back to summary

h2cMaxContentLength	back to summary
public T h2cMaxContentLength(int h2cMaxContentLength) Configure the maximum length of the content of the HTTP/2.0 clear-text upgrade request. By default the server will reject an upgrade request with non-empty content, because the upgrade request is most likely a GET request. If the client sends a non-GET upgrade request, `h2cMaxContentLength` specifies the maximum length of the content of the upgrade request. By default the client will allow an upgrade request with up to 65536 as the maximum length of the aggregated content. Parameters h2cMaxContentLength:int the maximum length of the content of the upgrade request Returns:T this builder for further configuration

public T h2cMaxContentLength(int h2cMaxContentLength)

Configure the maximum length of the content of the HTTP/2.0 clear-text upgrade request.

By default the server will reject an upgrade request with non-empty content, because the upgrade request is most likely a GET request. If the client sends a non-GET upgrade request, h2cMaxContentLength specifies the maximum length of the content of the upgrade request.
By default the client will allow an upgrade request with up to 65536 as the maximum length of the aggregated content.

Parameters

h2cMaxContentLength:int: the maximum length of the content of the upgrade request

Returns:T

this builder for further configuration

h2cMaxContentLength	back to summary
public int h2cMaxContentLength() Return the configured maximum length of the content of the HTTP/2.0 clear-text upgrade request. Returns:int the configured maximum length of the content of the HTTP/2.0 clear-text upgrade request

h2cMaxContentLength

back to summary

public int h2cMaxContentLength()

Return the configured maximum length of the content of the HTTP/2.0 clear-text upgrade request.

Returns:int: the configured maximum length of the content of the HTTP/2.0 clear-text upgrade request

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

initialBufferSize back to summary

initialBufferSize	back to summary
public T initialBufferSize(int value) Configure the initial buffer size for HTTP request decoding. Defaults to `DEFAULT_INITIAL_BUFFER_SIZE`. Parameters value:int the initial buffer size to use (strictly positive) Returns:T this option builder for further configuration

public T initialBufferSize(int value)

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

Parameters

value:int: the initial buffer size to use (strictly positive)

Returns:T

this option builder for further configuration

initialBufferSize	back to summary
public int initialBufferSize() Return the configured initial buffer size for HTTP request decoding. Returns:int the configured initial buffer size for HTTP request decoding

initialBufferSize

back to summary

public int initialBufferSize()

Return the configured initial buffer size for HTTP request decoding.

Returns:int: the configured initial buffer size for HTTP request decoding

maxChunkSize back to summary

maxChunkSize	back to summary
public T maxChunkSize(int value) Deprecated as of 1.1.0. This will be removed in 2.0.0 as Netty 5 does not support this configuration. Configure the maximum chunk size that can be decoded for the HTTP request. Defaults to `DEFAULT_MAX_CHUNK_SIZE`. Parameters value:int the value for the maximum chunk size (strictly positive) Returns:T this option builder for further configuration Annotations @Deprecated

public T maxChunkSize(int value)

Deprecated

as of 1.1.0. This will be removed in 2.0.0 as Netty 5 does not support this configuration.

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

Parameters

value:int: the value for the maximum chunk size (strictly positive)

Returns:T

this option builder for further configuration

Annotations

@Deprecated

maxChunkSize	back to summary
public int maxChunkSize() Deprecated as of 1.1.0. This will be removed in 2.0.0 as Netty 5 does not support this configuration. Return the configured maximum chunk size that can be decoded for the HTTP request. Returns:int the configured maximum chunk size that can be decoded for the HTTP request Annotations @Deprecated

maxChunkSize

back to summary

public int maxChunkSize()

Deprecated

as of 1.1.0. This will be removed in 2.0.0 as Netty 5 does not support this configuration.

Return the configured maximum chunk size that can be decoded for the HTTP request.

Returns:int

the configured maximum chunk size that can be decoded for the HTTP request

Annotations

@Deprecated

maxHeaderSize back to summary

maxHeaderSize	back to summary
public T maxHeaderSize(int value) Configure the maximum header size that can be decoded for the HTTP request. Defaults to `DEFAULT_MAX_HEADER_SIZE`. Parameters value:int the value for the maximum header size (strictly positive) Returns:T this option builder for further configuration

public T maxHeaderSize(int value)

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

Parameters

value:int: the value for the maximum header size (strictly positive)

Returns:T

this option builder for further configuration

maxHeaderSize	back to summary
public int maxHeaderSize() Return the configured maximum header size that can be decoded for the HTTP request. Returns:int the configured maximum header size that can be decoded for the HTTP request

maxHeaderSize

back to summary

public int maxHeaderSize()

Return the configured maximum header size that can be decoded for the HTTP request.

Returns:int: the configured maximum header size that can be decoded for the HTTP request

maxInitialLineLength back to summary

maxInitialLineLength	back to summary
public T 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:int the value for the maximum initial line length (strictly positive) Returns:T this option builder for further configuration

public T 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:int: the value for the maximum initial line length (strictly positive)

Returns:T

this option builder for further configuration

maxInitialLineLength	back to summary
public int maxInitialLineLength() Return the configured maximum length that can be decoded for the HTTP request's initial line. Returns:int the configured maximum length that can be decoded for the HTTP request's initial line

maxInitialLineLength

back to summary

public int maxInitialLineLength()

Return the configured maximum length that can be decoded for the HTTP request's initial line.

Returns:int: the configured maximum length that can be decoded for the HTTP request's initial line

validateHeaders back to summary

validateHeaders	back to summary
public T validateHeaders(boolean validate) Configure whether to validate headers when decoding requests. Defaults to `DEFAULT_VALIDATE_HEADERS`. Parameters validate:boolean true to validate headers, false otherwise Returns:T this option builder for further configuration

public T validateHeaders(boolean validate)

Configure whether to validate headers when decoding requests. Defaults to DEFAULT_VALIDATE_HEADERS.

Parameters

validate:boolean: true to validate headers, false otherwise

Returns:T

this option builder for further configuration

validateHeaders	back to summary
public boolean validateHeaders() Return the configuration whether to validate headers when decoding requests. Returns:boolean the configuration whether to validate headers when decoding requests

validateHeaders

back to summary

public boolean validateHeaders()

Return the configuration whether to validate headers when decoding requests.

Returns:boolean: the configuration whether to validate headers when decoding requests

public abstract Class HttpDecoderSpec<T extends reactor.netty.http.HttpDecoderSpec<T>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail