Decodes ByteBufs into HttpMessages and HttpContents.

Parameters that prevents excessive memory consumption

Name	Default value	Meaning
`maxInitialLineLength`	4096	The maximum length of the initial line (e.g. `"GET / HTTP/1.0"` or `"HTTP/1.0 200 OK"`) If the length of the initial line exceeds this value, a `TooLongHttpLineException` will be raised.
`maxHeaderSize`	8192	The maximum length of all headers. If the sum of the length of each header exceeds this value, a `TooLongHttpHeaderException` will be raised.
`maxChunkSize`	8192	The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk will be split into multiple `HttpContent`s whose length is `maxChunkSize` at maximum.

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.

Chunked Content

If the content of an HTTP message is greater than maxChunkSize or the transfer encoding of the HTTP message is 'chunked', this decoder generates one HttpMessage instance and its following HttpContents per single HTTP message to avoid excessive memory consumption. For example, the following HTTP message:

GET / HTTP/1.1
Transfer-Encoding: chunked

1a
abcdefghijklmnopqrstuvwxyz
10
1234567890abcdef
0
Content-MD5: ...
[blank line]

triggers HttpRequestDecoder to generate 3 objects:

An HttpRequest,
The first HttpContent whose content is 'abcdefghijklmnopqrstuvwxyz',
The second LastHttpContent whose content is '1234567890abcdef', which marks the end of the content.

If you prefer not to handle HttpContents by yourself for your convenience, insert HttpObjectAggregator after this decoder in the ChannelPipeline. However, please note that your server might not be as memory efficient as without the aggregator.

Extensibility

Please note that this decoder is designed to be extended to implement a protocol derived from HTTP, such as RTSP and ICAP. To implement the decoder of such a derived protocol, extend this class and implement all abstract methods properly.

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.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	HttpObjectDecoder.HeaderParser
private class	HttpObjectDecoder.LineParser
private static enum	HttpObjectDecoder.State The internal state of `HttpObjectDecoder`.

Field Summary

Modifier and Type	Field and Description
private final boolean	allowDuplicateContentLengths
private final boolean	allowPartialChunks
private boolean	chunked
private final boolean	chunkedSupported
private long	chunkSize
private long	contentLength
private HttpObjectDecoder.State	currentState
public static final boolean	DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS
public static final boolean	DEFAULT_ALLOW_PARTIAL_CHUNKS
public static final boolean	DEFAULT_CHUNKED_SUPPORTED
public static final int	DEFAULT_INITIAL_BUFFER_SIZE
public static final int	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
private final HttpObjectDecoder.HeaderParser	headerParser
protected final HttpHeadersFactory	headersFactory
private static final boolean[]	ISO_CONTROL_OR_WHITESPACE
private boolean	isSwitchingToNonHttp1Protocol
private static final boolean[]	LATIN_WHITESPACE
private final HttpObjectDecoder.LineParser	lineParser
private final int	maxChunkSize
private HttpMessage	message
private AsciiString	name
private final ByteBuf	parserScratchBuffer
private final AtomicBoolean	resetRequested
private static final ByteProcessor	SKIP_CONTROL_CHARS_BYTES
private static final boolean[]	SP_LENIENT_BYTES
private LastHttpContent	trailer
protected final HttpHeadersFactory	trailersFactory
protected final boolean	validateHeaders This field is no longer used.
private String	value

Inherited from io.netty.handler.codec.ByteToMessageDecoder:: COMPOSITE_CUMULATOR MERGE_CUMULATOR

Constructor Summary

Access	Constructor and Description
protected	HttpObjectDecoder() Creates a new instance with the default `maxInitialLineLength (4096)`, `maxHeaderSize (8192)`, and `maxChunkSize (8192)`.
protected	HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters.
protected	HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters.
protected	HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters.
protected	HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters.
protected	HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean allowPartialChunks) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters.
protected	HttpObjectDecoder(HttpDecoderConfig config) Creates a new instance with the specified configuration.

Method Summary

Modifier and Type	Method and Description
private void	addCurrentMessage(List<Object> out)
protected abstract HttpMessage	createInvalidMessage()
protected abstract HttpMessage	createMessage(String[] initialLine)
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, ByteBuf the `ByteBuf` from which to read data buffer, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other.
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Overrides io.netty.handler.codec.ByteToMessageDecoder.decodeLast. Is called one last time when the `ChannelHandlerContext` goes in-active.
private static int	findEndOfString(byte[] sb, int start, int end)
private static int	findNonSPLenient(byte[] sb, int offset, int end)
private static int	findNonWhitespace(byte[] sb, int offset, int end)
private static int	findSPLenient(byte[] sb, int offset, int end)
private static int	getChunkSize(byte[] hex, int start, int length)
protected void	handlerRemoved0(ChannelHandlerContext ctx) Overrides io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0. Gets called after the `ByteToMessageDecoder` was removed from the actual context and it doesn't handle events anymore.
protected void	handleTransferEncodingChunkedWithContentLength(HttpMessage message) Invoked when a message with both a "Transfer-Encoding: chunked" and a "Content-Length" header field is detected.
private HttpContent	invalidChunk(ByteBuf in, Exception cause)
private HttpMessage	invalidMessage(HttpMessage current, ByteBuf in, Exception cause)
protected boolean	isContentAlwaysEmpty(HttpMessage msg)
private static boolean	isControlOrWhitespaceAsciiChar(byte b)
protected abstract boolean	isDecodingRequest()
private static boolean	isOWS(byte ch)
private static boolean	isSPLenient(byte c)
protected boolean	isSwitchingToNonHttp1Protocol(HttpResponse msg) Returns true if the server switched to a different protocol than HTTP/1.0 or HTTP/1.1, e.g. HTTP/2 or Websocket.
protected boolean	isValidating(HttpHeadersFactory headersFactory)
private static boolean	isWhitespace(byte b)
private static String	langAsciiString(final byte[] asciiContent, int start, int length) This method shouldn't exist: look at https://bugs.openjdk.org/browse/JDK-8295496 for more context
private HttpObjectDecoder.State	readHeaders(ByteBuf buffer)
private LastHttpContent	readTrailingHeaders(ByteBuf buffer)
public void	reset() Resets the state of the decoder so that it is ready to decode a new message.
private void	resetNow()
private static int	skipWhiteSpaces(byte[] hex, int start, int length) It skips any whitespace char and return the number of skipped bytes.
protected String	splitFirstWordInitialLine(final byte[] asciiContent, int start, int length)
private void	splitHeader(byte[] line, int start, int length)
protected AsciiString	splitHeaderName(byte[] sb, int start, int length)
private String[]	splitInitialLine(ByteBuf asciiBuffer)
protected String	splitSecondWordInitialLine(final byte[] asciiContent, int start, int length)
protected String	splitThirdWordInitialLine(final byte[] asciiContent, int start, int length)
public void	userEventTriggered(ChannelHandlerContext ctx, Object evt) Overrides io.netty.handler.codec.ByteToMessageDecoder.userEventTriggered. Implements io.netty.channel.ChannelInboundHandler.userEventTriggered. Calls `ChannelHandlerContext#fireUserEventTriggered(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.

Inherited from io.netty.handler.codec.ByteToMessageDecoder:: actualReadableBytes callDecode channelInactive channelRead channelReadComplete discardSomeReadBytes handlerRemoved internalBuffer isSingleDecode setCumulator setDiscardAfterReads setSingleDecode

Field Detail

allowDuplicateContentLengths	back to summary
private final boolean allowDuplicateContentLengths

allowPartialChunks	back to summary
private final boolean allowPartialChunks

chunked	back to summary
private boolean chunked

chunkedSupported	back to summary
private final boolean chunkedSupported

chunkSize	back to summary
private long chunkSize

contentLength	back to summary
private long contentLength

currentState	back to summary
private HttpObjectDecoder.State currentState

DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS	back to summary
public static final boolean DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS

DEFAULT_ALLOW_PARTIAL_CHUNKS	back to summary
public static final boolean DEFAULT_ALLOW_PARTIAL_CHUNKS

DEFAULT_CHUNKED_SUPPORTED	back to summary
public static final boolean DEFAULT_CHUNKED_SUPPORTED

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

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

headerParser	back to summary
private final HttpObjectDecoder.HeaderParser headerParser

headersFactory	back to summary
protected final HttpHeadersFactory headersFactory

ISO_CONTROL_OR_WHITESPACE	back to summary
private static final boolean[] ISO_CONTROL_OR_WHITESPACE

isSwitchingToNonHttp1Protocol	back to summary
private boolean isSwitchingToNonHttp1Protocol

LATIN_WHITESPACE	back to summary
private static final boolean[] LATIN_WHITESPACE

lineParser	back to summary
private final HttpObjectDecoder.LineParser lineParser

maxChunkSize	back to summary
private final int maxChunkSize

message	back to summary
private HttpMessage message

name	back to summary
private AsciiString name

parserScratchBuffer	back to summary
private final ByteBuf parserScratchBuffer

resetRequested	back to summary
private final AtomicBoolean resetRequested

SKIP_CONTROL_CHARS_BYTES	back to summary
private static final ByteProcessor SKIP_CONTROL_CHARS_BYTES

SP_LENIENT_BYTES	back to summary
private static final boolean[] SP_LENIENT_BYTES

trailer	back to summary
private LastHttpContent trailer

trailersFactory	back to summary
protected final HttpHeadersFactory trailersFactory

validateHeaders	back to summary
protected final boolean validateHeaders Deprecated This field is no longer used. It is only kept around for backwards compatibility purpose. Annotations @Deprecated

value	back to summary
private String value

Constructor Detail

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

HttpObjectDecoder back to summary

HttpObjectDecoder	back to summary
protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters. Annotations @Deprecated

protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported)

Deprecated

Use HttpObjectDecoder(HttpDecoderConfig) instead.

Creates a new instance with the specified parameters.

Annotations

@Deprecated

HttpObjectDecoder back to summary

HttpObjectDecoder	back to summary
protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters. Annotations @Deprecated

protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders)

Deprecated

Use HttpObjectDecoder(HttpDecoderConfig) instead.

Creates a new instance with the specified parameters.

Annotations

@Deprecated

HttpObjectDecoder back to summary

HttpObjectDecoder	back to summary
protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters. Annotations @Deprecated

protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize)

Deprecated

Use HttpObjectDecoder(HttpDecoderConfig) instead.

Creates a new instance with the specified parameters.

Annotations

@Deprecated

HttpObjectDecoder back to summary

HttpObjectDecoder	back to summary
protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters. Annotations @Deprecated

protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)

Deprecated

Use HttpObjectDecoder(HttpDecoderConfig) instead.

Creates a new instance with the specified parameters.

Annotations

@Deprecated

HttpObjectDecoder back to summary

HttpObjectDecoder	back to summary
protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths, boolean allowPartialChunks) Deprecated Use `HttpObjectDecoder(HttpDecoderConfig)` instead. Creates a new instance with the specified parameters. Annotations @Deprecated

Deprecated

Use HttpObjectDecoder(HttpDecoderConfig) instead.

Creates a new instance with the specified parameters.

Annotations

@Deprecated

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

Method Detail

addCurrentMessage	back to summary
private void addCurrentMessage(List<Object> out)

createInvalidMessage	back to summary
protected abstract HttpMessage createInvalidMessage()

createMessage	back to summary
protected abstract HttpMessage createMessage(String[] initialLine) throws Exception

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode. Doc from io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other. This method will be called till either the input `ByteBuf` has nothing to read when return from this method or till nothing was read from the input `ByteBuf`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to buffer:ByteBuf the `ByteBuf` from which to read data out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode.

Doc from io.netty.handler.codec.ByteToMessageDecoder.decode.

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this ByteToMessageDecoder belongs to
buffer:ByteBuf: the ByteBuf from which to read data
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

decodeLast back to summary

decodeLast	back to summary
protected void decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception Overrides io.netty.handler.codec.ByteToMessageDecoder.decodeLast. Doc from io.netty.handler.codec.ByteToMessageDecoder.decodeLast. Is called one last time when the `ChannelHandlerContext` goes in-active. Which means the `channelInactive(ChannelHandlerContext)` was triggered. By default, this will just call `decode(ChannelHandlerContext, ByteBuf, List)` but sub-classes may override this for some special cleanup operation. Annotations @Override

protected void decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception

Overrides io.netty.handler.codec.ByteToMessageDecoder.decodeLast.

Doc from io.netty.handler.codec.ByteToMessageDecoder.decodeLast.

Is called one last time when the ChannelHandlerContext goes in-active. Which means the channelInactive(ChannelHandlerContext) was triggered. By default, this will just call decode(ChannelHandlerContext, ByteBuf, List) but sub-classes may override this for some special cleanup operation.

Annotations

@Override

findEndOfString	back to summary
private static int findEndOfString(byte[] sb, int start, int end)

findNonSPLenient	back to summary
private static int findNonSPLenient(byte[] sb, int offset, int end)

findNonWhitespace	back to summary
private static int findNonWhitespace(byte[] sb, int offset, int end)

findSPLenient	back to summary
private static int findSPLenient(byte[] sb, int offset, int end)

getChunkSize	back to summary
private static int getChunkSize(byte[] hex, int start, int length)

handlerRemoved0 back to summary

protected void handlerRemoved0(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0.

Doc from io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0.

Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

handleTransferEncodingChunkedWithContentLength

back to summary

protected void handleTransferEncodingChunkedWithContentLength(HttpMessage message)

Invoked when a message with both a "Transfer-Encoding: chunked" and a "Content-Length" header field is detected. The default behavior is to remove the Content-Length field, but this method could be overridden to change the behavior (to, e.g., throw an exception and produce an invalid message).

See: https://tools.ietf.org/html/rfc7230#section-3.3.3

    If a message is received with both a Transfer-Encoding and a
    Content-Length header field, the Transfer-Encoding overrides the
    Content-Length.  Such a message might indicate an attempt to
    perform request smuggling (Section 9.5) or response splitting
    (Section 9.4) and ought to be handled as an error.  A sender MUST
    remove the received Content-Length field prior to forwarding such
    a message downstream.

Also see: https://github.com/apache/tomcat/blob/b693d7c1981fa7f51e58bc8c8e72e3fe80b7b773/ java/org/apache/coyote/http11/Http11Processor.java#L747-L755 https://github.com/nginx/nginx/blob/0ad4393e30c119d250415cb769e3d8bc8dce5186/ src/http/ngx_http_request.c#L1946-L1953

invalidChunk	back to summary
private HttpContent invalidChunk(ByteBuf in, Exception cause)

invalidMessage	back to summary
private HttpMessage invalidMessage(HttpMessage current, ByteBuf in, Exception cause)

isContentAlwaysEmpty	back to summary
protected boolean isContentAlwaysEmpty(HttpMessage msg)

isControlOrWhitespaceAsciiChar	back to summary
private static boolean isControlOrWhitespaceAsciiChar(byte b)

isDecodingRequest	back to summary
protected abstract boolean isDecodingRequest()

isOWS	back to summary
private static boolean isOWS(byte ch)

isSPLenient	back to summary
private static boolean isSPLenient(byte c)

isSwitchingToNonHttp1Protocol	back to summary
protected boolean isSwitchingToNonHttp1Protocol(HttpResponse msg) Returns true if the server switched to a different protocol than HTTP/1.0 or HTTP/1.1, e.g. HTTP/2 or Websocket. Returns false if the upgrade happened in a different layer, e.g. upgrade from HTTP/1.1 to HTTP/1.1 over TLS.

isValidating	back to summary
protected boolean isValidating(HttpHeadersFactory headersFactory)

isWhitespace	back to summary
private static boolean isWhitespace(byte b)

langAsciiString	back to summary
private static String langAsciiString(final byte[] asciiContent, int start, int length) This method shouldn't exist: look at https://bugs.openjdk.org/browse/JDK-8295496 for more context

readHeaders	back to summary
private HttpObjectDecoder.State readHeaders(ByteBuf buffer)

readTrailingHeaders	back to summary
private LastHttpContent readTrailingHeaders(ByteBuf buffer)

reset	back to summary
public void reset() Resets the state of the decoder so that it is ready to decode a new message. This method is useful for handling a rejected request with `Expect: 100-continue` header.

resetNow	back to summary
private void resetNow()

skipWhiteSpaces	back to summary
private static int skipWhiteSpaces(byte[] hex, int start, int length) It skips any whitespace char and return the number of skipped bytes.

splitFirstWordInitialLine	back to summary
protected String splitFirstWordInitialLine(final byte[] asciiContent, int start, int length)

splitHeader	back to summary
private void splitHeader(byte[] line, int start, int length)

splitHeaderName	back to summary
protected AsciiString splitHeaderName(byte[] sb, int start, int length)

splitInitialLine	back to summary
private String[] splitInitialLine(ByteBuf asciiBuffer)

splitSecondWordInitialLine	back to summary
protected String splitSecondWordInitialLine(final byte[] asciiContent, int start, int length)

splitThirdWordInitialLine	back to summary
protected String splitThirdWordInitialLine(final byte[] asciiContent, int start, int length)

userEventTriggered back to summary

public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception

Overrides io.netty.handler.codec.ByteToMessageDecoder.userEventTriggered.

Implements io.netty.channel.ChannelInboundHandler.userEventTriggered.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.userEventTriggered.

Calls ChannelHandlerContext#fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Annotations

@Override

io.netty.handler.codec.http back to summary

private Class HttpObjectDecoder.HeaderParser

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser

Known Direct Subclasses

io.netty.handler.codec.http.HttpObjectDecoder.LineParser

Field Summary

Modifier and Type	Field and Description
protected final int	maxLength
protected final ByteBuf	seq
pack-priv int	size

Constructor Summary

Access	Constructor and Description
pack-priv	HeaderParser(ByteBuf seq, int maxLength)

Method Summary

Modifier and Type	Method and Description
protected TooLongFrameException	newException(int maxLength)
public ByteBuf	parse(ByteBuf buffer)
public void	reset()

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

Field Detail

maxLength	back to summary
protected final int maxLength

seq	back to summary
protected final ByteBuf seq

size	back to summary
pack-priv int size

Constructor Detail

HeaderParser	back to summary
pack-priv HeaderParser(ByteBuf seq, int maxLength)

Method Detail

newException	back to summary
protected TooLongFrameException newException(int maxLength)

parse	back to summary
public ByteBuf parse(ByteBuf buffer)

reset	back to summary
public void reset()

io.netty.handler.codec.http back to summary

private final Class HttpObjectDecoder.LineParser

Class Inheritance

extends HeaderParser

java.lang.Object
io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser
io.netty.handler.codec.http.HttpObjectDecoder.LineParser

Field Summary

Inherited from io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser:: maxLength seq size

Constructor Summary

Access	Constructor and Description
pack-priv	LineParser(ByteBuf seq, int maxLength)

Method Summary

Modifier and Type	Method and Description
protected TooLongFrameException	newException(int maxLength) Overrides io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser.newException.
public ByteBuf	parse(ByteBuf buffer) Overrides io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser.parse.
private boolean	skipControlChars(ByteBuf buffer, int readableBytes, int readerIndex)

Inherited from io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser:: reset

Constructor Detail

LineParser	back to summary
pack-priv LineParser(ByteBuf seq, int maxLength)

Method Detail

newException

back to summary

protected TooLongFrameException newException(int maxLength)

Overrides io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser.newException.

Annotations

@Override

parse

back to summary

public ByteBuf parse(ByteBuf buffer)

Overrides io.netty.handler.codec.http.HttpObjectDecoder.HeaderParser.parse.

Annotations

@Override

skipControlChars	back to summary
private boolean skipControlChars(ByteBuf buffer, int readableBytes, int readerIndex)

io.netty.handler.codec.http back to summary

private final Enum HttpObjectDecoder.State

Class Inheritance

extends Enum<HttpObjectDecoder.State>

java.lang.Object
java.lang.Enum
io.netty.handler.codec.http.HttpObjectDecoder.State

The internal state of HttpObjectDecoder. Internal use only.

Field Summary

Modifier and Type	Field and Description
public static final HttpObjectDecoder.State	BAD_MESSAGE
public static final HttpObjectDecoder.State	READ_CHUNK_DELIMITER
public static final HttpObjectDecoder.State	READ_CHUNK_FOOTER
public static final HttpObjectDecoder.State	READ_CHUNK_SIZE
public static final HttpObjectDecoder.State	READ_CHUNKED_CONTENT
public static final HttpObjectDecoder.State	READ_FIXED_LENGTH_CONTENT
public static final HttpObjectDecoder.State	READ_HEADER
public static final HttpObjectDecoder.State	READ_INITIAL
public static final HttpObjectDecoder.State	READ_VARIABLE_LENGTH_CONTENT
public static final HttpObjectDecoder.State	SKIP_CONTROL_CHARS
public static final HttpObjectDecoder.State	UPGRADED

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static HttpObjectDecoder.State	valueOf(String name)
public static HttpObjectDecoder.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BAD_MESSAGE	back to summary
public static final HttpObjectDecoder.State BAD_MESSAGE

READ_CHUNK_DELIMITER	back to summary
public static final HttpObjectDecoder.State READ_CHUNK_DELIMITER

READ_CHUNK_FOOTER	back to summary
public static final HttpObjectDecoder.State READ_CHUNK_FOOTER

READ_CHUNK_SIZE	back to summary
public static final HttpObjectDecoder.State READ_CHUNK_SIZE

READ_CHUNKED_CONTENT	back to summary
public static final HttpObjectDecoder.State READ_CHUNKED_CONTENT

READ_FIXED_LENGTH_CONTENT	back to summary
public static final HttpObjectDecoder.State READ_FIXED_LENGTH_CONTENT

READ_HEADER	back to summary
public static final HttpObjectDecoder.State READ_HEADER

READ_INITIAL	back to summary
public static final HttpObjectDecoder.State READ_INITIAL

READ_VARIABLE_LENGTH_CONTENT	back to summary
public static final HttpObjectDecoder.State READ_VARIABLE_LENGTH_CONTENT

SKIP_CONTROL_CHARS	back to summary
public static final HttpObjectDecoder.State SKIP_CONTROL_CHARS

UPGRADED	back to summary
public static final HttpObjectDecoder.State UPGRADED

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static HttpObjectDecoder.State valueOf(String name)

values	back to summary
public static HttpObjectDecoder.State[] values()

public abstract Class HttpObjectDecoder

Parameters that prevents excessive memory consumption

Parameters that control parsing behavior

Chunked Content

Extensibility

Header Validation

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HttpObjectDecoder.HeaderParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpObjectDecoder.LineParser

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Enum HttpObjectDecoder.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail