Class HttpResponseDecoder
- java.lang.Object
-
- org.jboss.netty.channel.SimpleChannelUpstreamHandler
-
- org.jboss.netty.handler.codec.frame.FrameDecoder
-
- org.jboss.netty.handler.codec.replay.ReplayingDecoder<HttpMessageDecoder.State>
-
- org.jboss.netty.handler.codec.http.HttpMessageDecoder
-
- org.jboss.netty.handler.codec.http.HttpResponseDecoder
-
- All Implemented Interfaces:
ChannelHandler
,ChannelUpstreamHandler
,LifeCycleAwareChannelHandler
- Direct Known Subclasses:
HttpClientCodec.Decoder
public class HttpResponseDecoder extends HttpMessageDecoder
DecodesChannelBuffer
s intoHttpResponse
s andHttpChunk
s.Parameters that prevents excessive memory consumption
Name Meaning maxInitialLineLength
The maximum length of the initial line (e.g. "HTTP/1.0 200 OK"
) If the length of the initial line exceeds this value, aTooLongFrameException
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 exceeds this value, the transfer encoding of the decoded response will be converted to 'chunked' and the content will be split into multiple HttpChunk
s. If the transfer encoding of the HTTP response 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 handleHttpChunk
s in your handler, insertHttpChunkAggregator
after this decoder in theChannelPipeline
.Decoding a response for a HEAD request
Unlike other HTTP requests, the successful response of a HEAD request does not have any content even if there is Content-Length header. Because
HttpResponseDecoder
is not able to determine if the response currently being decoded is associated with a HEAD request, you must overrideHttpMessageDecoder.isContentAlwaysEmpty(HttpMessage)
to return true for the response of the HEAD request.If you are writing an HTTP client that issues a HEAD request, please use
HttpClientCodec
instead of this decoder. It will perform additional state management to handle the responses for HEAD requests correctly.Decoding a response for a CONNECT request
You also need to do additional state management to handle the response of a CONNECT request properly, like you did for HEAD. One difference is that the decoder should stop decoding completely after decoding the successful 200 response since the connection is not an HTTP connection anymore.
HttpClientCodec
also handles this edge case correctly, so you have to useHttpClientCodec
if you are writing an HTTP client that issues a CONNECT request.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.jboss.netty.handler.codec.http.HttpMessageDecoder
HttpMessageDecoder.State
-
Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Field Summary
-
Fields inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder
cumulation, DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS
-
-
Constructor Summary
Constructors Constructor Description HttpResponseDecoder()
Creates a new instance with the defaultmaxInitialLineLength (4096
},maxHeaderSize (8192)
, andmaxChunkSize (8192)
.HttpResponseDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize)
Creates a new instance with the specified parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected HttpMessage
createMessage(java.lang.String[] initialLine)
protected boolean
isDecodingRequest()
-
Methods inherited from class org.jboss.netty.handler.codec.http.HttpMessageDecoder
decode, isContentAlwaysEmpty
-
Methods inherited from class org.jboss.netty.handler.codec.replay.ReplayingDecoder
checkpoint, checkpoint, cleanup, decode, decodeLast, decodeLast, getState, internalBuffer, messageReceived, setState
-
Methods inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder
actualReadableBytes, afterAdd, afterRemove, appendToCumulation, beforeAdd, beforeRemove, channelClosed, channelDisconnected, exceptionCaught, extractFrame, getMaxCumulationBufferCapacity, getMaxCumulationBufferComponents, isUnfold, newCumulationBuffer, replace, setMaxCumulationBufferCapacity, setMaxCumulationBufferComponents, setUnfold, unfoldAndFireMessageReceived, updateCumulation
-
Methods inherited from class org.jboss.netty.channel.SimpleChannelUpstreamHandler
channelBound, channelConnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, handleUpstream, writeComplete
-
-
-
-
Constructor Detail
-
HttpResponseDecoder
public HttpResponseDecoder()
Creates a new instance with the defaultmaxInitialLineLength (4096
},maxHeaderSize (8192)
, andmaxChunkSize (8192)
.
-
HttpResponseDecoder
public HttpResponseDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize)
Creates a new instance with the specified parameters.
-
-
Method Detail
-
createMessage
protected HttpMessage createMessage(java.lang.String[] initialLine)
- Specified by:
createMessage
in classHttpMessageDecoder
-
isDecodingRequest
protected boolean isDecodingRequest()
- Specified by:
isDecodingRequest
in classHttpMessageDecoder
-
-