Package io.netty.handler.codec.http
Class HttpRequestDecoder
- 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
-
- All Implemented Interfaces:
ChannelHandler,ChannelInboundHandler
- Direct Known Subclasses:
HttpServerCodec.HttpServerRequestDecoder
public class HttpRequestDecoder extends HttpObjectDecoder
DecodesByteBufs intoHttpRequests andHttpContents.Parameters that prevents excessive memory consumption
Name Meaning maxInitialLineLengthThe maximum length of the initial line (e.g. "GET / HTTP/1.0") If the length of the initial line exceeds this value, aTooLongFrameExceptionwill be raised.maxHeaderSizeThe maximum length of all headers. If the sum of the length of each header exceeds this value, a TooLongFrameExceptionwill be raised.maxChunkSizeThe 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 HttpContents. 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 handleHttpContents in your handler, insertHttpObjectAggregatorafter this decoder in theChannelPipeline.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder
ByteToMessageDecoder.Cumulator
-
Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Field Summary
-
Fields inherited from class io.netty.handler.codec.http.HttpObjectDecoder
DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS, DEFAULT_CHUNKED_SUPPORTED, DEFAULT_INITIAL_BUFFER_SIZE, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_VALIDATE_HEADERS, validateHeaders
-
Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
-
Constructor Summary
Constructors Constructor Description HttpRequestDecoder()Creates a new instance with the defaultmaxInitialLineLength (4096),maxHeaderSize (8192), andmaxChunkSize (8192).HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize)Creates a new instance with the specified parameters.HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders)HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize)HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected HttpMessagecreateInvalidMessage()protected HttpMessagecreateMessage(java.lang.String[] initialLine)protected booleanisDecodingRequest()-
Methods inherited from class io.netty.handler.codec.http.HttpObjectDecoder
decode, decodeLast, handleTransferEncodingChunkedWithContentLength, isContentAlwaysEmpty, isSwitchingToNonHttp1Protocol, reset, userEventTriggered
-
Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode
-
Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught
-
Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, isSharable
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.netty.channel.ChannelHandler
handlerAdded
-
-
-
-
Constructor Detail
-
HttpRequestDecoder
public HttpRequestDecoder()
Creates a new instance with the defaultmaxInitialLineLength (4096),maxHeaderSize (8192), andmaxChunkSize (8192).
-
HttpRequestDecoder
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize)Creates a new instance with the specified parameters.
-
HttpRequestDecoder
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders)
-
HttpRequestDecoder
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize)
-
HttpRequestDecoder
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)
-
-
Method Detail
-
createMessage
protected HttpMessage createMessage(java.lang.String[] initialLine) throws java.lang.Exception
- Specified by:
createMessagein classHttpObjectDecoder- Throws:
java.lang.Exception
-
createInvalidMessage
protected HttpMessage createInvalidMessage()
- Specified by:
createInvalidMessagein classHttpObjectDecoder
-
isDecodingRequest
protected boolean isDecodingRequest()
- Specified by:
isDecodingRequestin classHttpObjectDecoder
-
-