public abstract class HttpObjectDecoder extends ByteToMessageDecoder
ByteBuf
s into HttpMessage
s and
HttpContent
s.
Name | Meaning |
---|---|
maxInitialLineLength |
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
TooLongFrameException will be raised. |
maxHeaderSize |
The maximum length of all headers. If the sum of the length of each
header exceeds this value, a TooLongFrameException will be raised. |
maxChunkSize |
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. |
maxChunkSize
or
the transfer encoding of the HTTP message is 'chunked', this decoder
generates one HttpMessage
instance and its following
HttpContent
s 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:
HttpRequest
,HttpContent
whose content is 'abcdefghijklmnopqrstuvwxyz'
,LastHttpContent
whose content is '1234567890abcdef'
, which marks
the end of the content.HttpContent
s 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.
Modifier and Type | Class and Description |
---|---|
private static class |
HttpObjectDecoder.HeaderParser |
private static class |
HttpObjectDecoder.LineParser |
private static class |
HttpObjectDecoder.State
The internal state of
HttpObjectDecoder . |
ByteToMessageDecoder.Cumulator
ChannelHandler.Sharable
Modifier and Type | Field and Description |
---|---|
private boolean |
chunkedSupported |
private long |
chunkSize |
private long |
contentLength |
private HttpObjectDecoder.State |
currentState |
private static java.lang.String |
EMPTY_VALUE |
private HttpObjectDecoder.HeaderParser |
headerParser |
private HttpObjectDecoder.LineParser |
lineParser |
private int |
maxChunkSize |
private HttpMessage |
message |
private java.lang.CharSequence |
name |
private boolean |
resetRequested |
private LastHttpContent |
trailer |
protected boolean |
validateHeaders |
private java.lang.CharSequence |
value |
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
Modifier | 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)
Creates a new instance with the specified parameters.
|
protected |
HttpObjectDecoder(int maxInitialLineLength,
int maxHeaderSize,
int maxChunkSize,
boolean chunkedSupported,
boolean validateHeaders)
Creates a new instance with the specified parameters.
|
protected |
HttpObjectDecoder(int maxInitialLineLength,
int maxHeaderSize,
int maxChunkSize,
boolean chunkedSupported,
boolean validateHeaders,
int initialBufferSize) |
Modifier and Type | Method and Description |
---|---|
private long |
contentLength() |
protected abstract HttpMessage |
createInvalidMessage() |
protected abstract HttpMessage |
createMessage(java.lang.String[] initialLine) |
protected void |
decode(ChannelHandlerContext ctx,
ByteBuf buffer,
java.util.List<java.lang.Object> out)
Decode the from one
ByteBuf to an other. |
protected void |
decodeLast(ChannelHandlerContext ctx,
ByteBuf in,
java.util.List<java.lang.Object> out)
Is called one last time when the
ChannelHandlerContext goes in-active. |
private static int |
findEndOfString(AppendableCharSequence sb) |
private static int |
findNonWhitespace(AppendableCharSequence sb,
int offset) |
private static int |
findWhitespace(AppendableCharSequence sb,
int offset) |
private static int |
getChunkSize(java.lang.String hex) |
private HttpContent |
invalidChunk(ByteBuf in,
java.lang.Exception cause) |
private HttpMessage |
invalidMessage(ByteBuf in,
java.lang.Exception cause) |
protected boolean |
isContentAlwaysEmpty(HttpMessage msg) |
protected abstract boolean |
isDecodingRequest() |
private HttpObjectDecoder.State |
readHeaders(ByteBuf buffer) |
private LastHttpContent |
readTrailingHeaders(ByteBuf buffer) |
void |
reset()
Resets the state of the decoder so that it is ready to decode a new message.
|
private void |
resetNow() |
private static boolean |
skipControlCharacters(ByteBuf buffer) |
private void |
splitHeader(AppendableCharSequence sb) |
private static java.lang.String[] |
splitInitialLine(AppendableCharSequence sb) |
void |
userEventTriggered(ChannelHandlerContext ctx,
java.lang.Object evt)
Calls
ChannelHandlerContext.fireUserEventTriggered(Object) to forward
to the next ChannelInboundHandler in the ChannelPipeline . |
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught
handlerAdded, isSharable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
handlerAdded
private static final java.lang.String EMPTY_VALUE
private final int maxChunkSize
private final boolean chunkedSupported
protected final boolean validateHeaders
private final HttpObjectDecoder.HeaderParser headerParser
private final HttpObjectDecoder.LineParser lineParser
private HttpMessage message
private long chunkSize
private long contentLength
private volatile boolean resetRequested
private java.lang.CharSequence name
private java.lang.CharSequence value
private LastHttpContent trailer
private HttpObjectDecoder.State currentState
protected HttpObjectDecoder()
maxInitialLineLength (4096
}, maxHeaderSize (8192)
, and
maxChunkSize (8192)
.protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported)
protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders)
protected HttpObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean chunkedSupported, boolean validateHeaders, int initialBufferSize)
protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, java.util.List<java.lang.Object> out) throws java.lang.Exception
ByteToMessageDecoder
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
.decode
in class ByteToMessageDecoder
ctx
- the ChannelHandlerContext
which this ByteToMessageDecoder
belongs tobuffer
- the ByteBuf
from which to read dataout
- the List
to which decoded messages should be addedjava.lang.Exception
- is thrown if an error accourprotected void decodeLast(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
ByteToMessageDecoder
ChannelHandlerContext
goes in-active. Which means the
ByteToMessageDecoder.channelInactive(ChannelHandlerContext)
was triggered.
By default this will just call ByteToMessageDecoder.decode(ChannelHandlerContext, ByteBuf, List)
but sub-classes may
override this for some special cleanup operation.decodeLast
in class ByteToMessageDecoder
java.lang.Exception
public void userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt) throws java.lang.Exception
ChannelInboundHandlerAdapter
ChannelHandlerContext.fireUserEventTriggered(Object)
to forward
to the next ChannelInboundHandler
in the ChannelPipeline
.
Sub-classes may override this method to change behavior.userEventTriggered
in interface ChannelInboundHandler
userEventTriggered
in class ByteToMessageDecoder
java.lang.Exception
protected boolean isContentAlwaysEmpty(HttpMessage msg)
public void reset()
Expect: 100-continue
header.private void resetNow()
private HttpMessage invalidMessage(ByteBuf in, java.lang.Exception cause)
private HttpContent invalidChunk(ByteBuf in, java.lang.Exception cause)
private static boolean skipControlCharacters(ByteBuf buffer)
private HttpObjectDecoder.State readHeaders(ByteBuf buffer)
private long contentLength()
private LastHttpContent readTrailingHeaders(ByteBuf buffer)
protected abstract boolean isDecodingRequest()
protected abstract HttpMessage createMessage(java.lang.String[] initialLine) throws java.lang.Exception
java.lang.Exception
protected abstract HttpMessage createInvalidMessage()
private static int getChunkSize(java.lang.String hex)
private static java.lang.String[] splitInitialLine(AppendableCharSequence sb)
private void splitHeader(AppendableCharSequence sb)
private static int findNonWhitespace(AppendableCharSequence sb, int offset)
private static int findWhitespace(AppendableCharSequence sb, int offset)
private static int findEndOfString(AppendableCharSequence sb)