Top Description Fields Constructors Methods

io.netty.handler.codec.http

public Class HttpRequestDecoder

Class Inheritance

extends HttpObjectDecoder

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.handler.codec.ByteToMessageDecoder
io.netty.handler.codec.http.HttpObjectDecoder
io.netty.handler.codec.http.HttpRequestDecoder

Known Direct Subclasses

io.netty.handler.codec.http.HttpServerCodec.HttpServerRequestDecoder

Imports

io.netty.buffer.ByteBuf, .Unpooled, io.netty.channel.ChannelPipeline, io.netty.util.AsciiString

Decodes ByteBufs into HttpRequests and HttpContents.

Parameters that prevents excessive memory consumption

Name	Meaning
`maxInitialLineLength`	The maximum length of the initial line (e.g. `"GET / HTTP/1.0"`) If the length of the initial line exceeds this value, a `TooLongHttpLineException` will be raised.
`maxHeaderSize`	The maximum length of all headers. If the sum of the length of each header exceeds this value, a `TooLongHttpHeaderException` will be raised.
`maxChunkSize`	The maximum length of the content or each chunk. If the content length exceeds this value, the transfer encoding of the decoded request will be converted to 'chunked' and the content will be split into multiple `HttpContent`s. If the transfer encoding of the HTTP request is 'chunked' already, each chunk will be split into smaller chunks if the length of the chunk exceeds this value. If you prefer not to handle `HttpContent`s in your handler, insert `HttpObjectAggregator` after this decoder in the `ChannelPipeline`.

Parameters that control parsing behavior

Name	Default value	Meaning
`allowDuplicateContentLengths`	false	When set to `false`, will reject any messages that contain multiple Content-Length header fields. When set to `true`, will allow multiple Content-Length headers only if they are all the same decimal value. The duplicated field-values will be replaced with a single valid Content-Length field. See RFC 7230, Section 3.3.2.
`allowPartialChunks`	true	If the length of a chunk exceeds the `ByteBuf`s readable bytes and `allowPartialChunks` is set to `true`, the chunk will be split into multiple `HttpContent`s. Otherwise, if the chunk size does not exceed `maxChunkSize` and `allowPartialChunks` is set to `false`, the `ByteBuf` is not decoded into an `HttpContent` until the readable bytes are greater or equal to the chunk size.

Header Validation

It is recommended to always enable header validation.

Without header validation, your system can become vulnerable to CWE-113: Improper Neutralization of CRLF Sequences in HTTP Headers ('HTTP Response Splitting') .

This recommendation stands even when both peers in the HTTP exchange are trusted, as it helps with defence-in-depth.

Field Summary

Modifier and Type	Field and Description
private static final AsciiString	Accept
private static final long	ACCEPT_AS_LONG
private static final AsciiString	Connection
private static final long	CONNECTION_AS_LONG_0
private static final short	CONNECTION_AS_SHORT_1
private static final long	CONTENT_AS_LONG
private static final AsciiString	ContentLength
private static final AsciiString	ContentType
private static final int	GET_AS_INT
private static final AsciiString	Host
private static final int	HOST_AS_INT
private static final long	HTTP_1_0_AS_LONG
private static final long	HTTP_1_1_AS_LONG
private static final long	LENGTH_AS_LONG
private static final int	POST_AS_INT
private static final int	TYPE_AS_INT

Inherited from io.netty.handler.codec.http.HttpObjectDecoder:: DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS DEFAULT_ALLOW_PARTIAL_CHUNKS DEFAULT_CHUNKED_SUPPORTED DEFAULT_INITIAL_BUFFER_SIZE DEFAULT_MAX_CHUNK_SIZE DEFAULT_MAX_HEADER_SIZE DEFAULT_MAX_INITIAL_LINE_LENGTH DEFAULT_VALIDATE_HEADERS headersFactory trailersFactory validateHeaders

Constructor Summary

Access	Constructor and Description
public	HttpRequestDecoder() Creates a new instance with the default `maxInitialLineLength (4096)`, `maxHeaderSize (8192)`, and `maxChunkSize (8192)`.
public	HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize) Creates a new instance with the specified parameters.
public	HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled.
public	HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled.
public	HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled.
public	HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean allowPartialChunks) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled.
public	HttpRequestDecoder(HttpDecoderConfig config) Creates a new instance with the specified configuration.

Method Summary

Modifier and Type	Method and Description
protected HttpMessage	createInvalidMessage() Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.createInvalidMessage.
protected HttpMessage	createMessage(String[] initialLine) Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.createMessage.
private static boolean	isAccept(byte[] sb, int start)
private static boolean	isConnection(byte[] sb, int start)
protected boolean	isContentAlwaysEmpty(final HttpMessage msg) Overrides io.netty.handler.codec.http.HttpObjectDecoder.isContentAlwaysEmpty.
private static boolean	isContentLength(byte[] sb, int start)
private static boolean	isContentType(byte[] sb, int start)
protected boolean	isDecodingRequest() Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.isDecodingRequest.
private static boolean	isGetMethod(final byte[] sb, int start)
private static boolean	isHost(byte[] sb, int start)
private static boolean	isPostMethod(final byte[] sb, int start)
protected String	splitFirstWordInitialLine(final byte[] sb, final int start, final int length) Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitFirstWordInitialLine.
protected AsciiString	splitHeaderName(final byte[] sb, final int start, final int length) Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitHeaderName.
protected String	splitThirdWordInitialLine(final byte[] sb, final int start, final int length) Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitThirdWordInitialLine.

Inherited from io.netty.handler.codec.http.HttpObjectDecoder:: decode decodeLast handlerRemoved0 handleTransferEncodingChunkedWithContentLength isSwitchingToNonHttp1Protocol isValidating reset splitSecondWordInitialLine userEventTriggered

Field Detail

Accept	back to summary
private static final AsciiString Accept

ACCEPT_AS_LONG	back to summary
private static final long ACCEPT_AS_LONG

Connection	back to summary
private static final AsciiString Connection

CONNECTION_AS_LONG_0	back to summary
private static final long CONNECTION_AS_LONG_0

CONNECTION_AS_SHORT_1	back to summary
private static final short CONNECTION_AS_SHORT_1

CONTENT_AS_LONG	back to summary
private static final long CONTENT_AS_LONG

ContentLength	back to summary
private static final AsciiString ContentLength

ContentType	back to summary
private static final AsciiString ContentType

GET_AS_INT	back to summary
private static final int GET_AS_INT

Host	back to summary
private static final AsciiString Host

HOST_AS_INT	back to summary
private static final int HOST_AS_INT

HTTP_1_0_AS_LONG	back to summary
private static final long HTTP_1_0_AS_LONG

HTTP_1_1_AS_LONG	back to summary
private static final long HTTP_1_1_AS_LONG

LENGTH_AS_LONG	back to summary
private static final long LENGTH_AS_LONG

POST_AS_INT	back to summary
private static final int POST_AS_INT

TYPE_AS_INT	back to summary
private static final int TYPE_AS_INT

Constructor Detail

HttpRequestDecoder	back to summary
public HttpRequestDecoder() Creates a new instance with the default `maxInitialLineLength (4096)`, `maxHeaderSize (8192)`, and `maxChunkSize (8192)`.

HttpRequestDecoder	back to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize) Creates a new instance with the specified parameters.

HttpRequestDecoder	back to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled. Annotations @Deprecated

HttpRequestDecoder	back to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled. Annotations @Deprecated

HttpRequestDecoder	back to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled. Annotations @Deprecated

HttpRequestDecoder	back to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean allowPartialChunks) Deprecated Prefer the `HttpRequestDecoder(HttpDecoderConfig)` constructor, to always have header validation enabled. Annotations @Deprecated

HttpRequestDecoder	back to summary
public HttpRequestDecoder(HttpDecoderConfig config) Creates a new instance with the specified configuration.

Method Detail

createInvalidMessage	back to summary
protected HttpMessage createInvalidMessage() Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.createInvalidMessage. Annotations @Override

createInvalidMessage

back to summary

protected HttpMessage createInvalidMessage()

Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.createInvalidMessage.

Annotations

@Override

createMessage	back to summary
protected HttpMessage createMessage(String[] initialLine) throws Exception Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.createMessage. Annotations @Override

createMessage

back to summary

protected HttpMessage createMessage(String[] initialLine) throws Exception

Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.createMessage.

Annotations

@Override

isAccept	back to summary
private static boolean isAccept(byte[] sb, int start)

isConnection	back to summary
private static boolean isConnection(byte[] sb, int start)

isContentAlwaysEmpty	back to summary
protected boolean isContentAlwaysEmpty(final HttpMessage msg) Overrides io.netty.handler.codec.http.HttpObjectDecoder.isContentAlwaysEmpty. Annotations @Override

isContentAlwaysEmpty

back to summary

protected boolean isContentAlwaysEmpty(final HttpMessage msg)

Overrides io.netty.handler.codec.http.HttpObjectDecoder.isContentAlwaysEmpty.

Annotations

@Override

isContentLength	back to summary
private static boolean isContentLength(byte[] sb, int start)

isContentType	back to summary
private static boolean isContentType(byte[] sb, int start)

isDecodingRequest	back to summary
protected boolean isDecodingRequest() Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.isDecodingRequest. Annotations @Override

isDecodingRequest

back to summary

protected boolean isDecodingRequest()

Implements abstract io.netty.handler.codec.http.HttpObjectDecoder.isDecodingRequest.

Annotations

@Override

isGetMethod	back to summary
private static boolean isGetMethod(final byte[] sb, int start)

isHost	back to summary
private static boolean isHost(byte[] sb, int start)

isPostMethod	back to summary
private static boolean isPostMethod(final byte[] sb, int start)

splitFirstWordInitialLine	back to summary
protected String splitFirstWordInitialLine(final byte[] sb, final int start, final int length) Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitFirstWordInitialLine. Annotations @Override

splitFirstWordInitialLine

back to summary

protected String splitFirstWordInitialLine(final byte[] sb, final int start, final int length)

Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitFirstWordInitialLine.

Annotations

@Override

splitHeaderName	back to summary
protected AsciiString splitHeaderName(final byte[] sb, final int start, final int length) Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitHeaderName. Annotations @Override

splitHeaderName

back to summary

protected AsciiString splitHeaderName(final byte[] sb, final int start, final int length)

Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitHeaderName.

Annotations

@Override

splitThirdWordInitialLine	back to summary
protected String splitThirdWordInitialLine(final byte[] sb, final int start, final int length) Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitThirdWordInitialLine. Annotations @Override

splitThirdWordInitialLine

back to summary

protected String splitThirdWordInitialLine(final byte[] sb, final int start, final int length)

Overrides io.netty.handler.codec.http.HttpObjectDecoder.splitThirdWordInitialLine.

Annotations

@Override