Package io.netty.handler.codec.http

Class HttpObjectAggregator

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<I>

io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

io.netty.handler.codec.http.HttpObjectAggregator

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

Direct Known Subclasses:

HttpClientUpgradeHandler, HttpServerUpgradeHandler

public class HttpObjectAggregator
extends io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

A ChannelHandler that aggregates an HttpMessage and its following HttpContents into a single FullHttpRequest or FullHttpResponse (depending on if it used to handle requests or responses) with no following HttpContents. It is useful when you don't want to take care of HTTP messages whose transfer encoding is 'chunked'. Insert this handler after HttpResponseDecoder in the ChannelPipeline if being used to handle responses, or after HttpRequestDecoder and HttpResponseEncoder in the ChannelPipeline if being used to handle requests.

  ChannelPipeline p = ...;
  ...
  p.addLast("decoder", new HttpRequestDecoder());
  p.addLast("encoder", new HttpResponseEncoder());
  p.addLast("aggregator", new HttpObjectAggregator(1048576));
  ...
  p.addLast("handler", new HttpRequestHandler());
  

For convenience, consider putting a HttpServerCodec before the HttpObjectAggregator as it functions as both a HttpRequestDecoder and a HttpResponseEncoder.

Be aware that HttpObjectAggregator may end up sending a HttpResponse:

Response Status	Condition When Sent
100 Continue	A '100-continue' expectation is received and the 'content-length' doesn't exceed maxContentLength
417 Expectation Failed	A '100-continue' expectation is received and the 'content-length' exceeds maxContentLength
413 Request Entity Too Large	Either the 'content-length' or the bytes received so far exceed maxContentLength

See Also:

FullHttpRequest, FullHttpResponse, HttpResponseDecoder, HttpServerCodec

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
HttpObjectAggregator(int maxContentLength)	Creates a new instance.
HttpObjectAggregator(int maxContentLength, boolean closeOnExpectationFailed)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	aggregate(FullHttpMessage aggregated, HttpContent content)
protected FullHttpMessage	beginAggregation(HttpMessage start, io.netty.buffer.ByteBuf content)
protected boolean	closeAfterContinueResponse(Object msg)
protected void	finishAggregation(FullHttpMessage aggregated)
protected void	handleOversizedMessage(io.netty.channel.ChannelHandlerContext ctx, HttpMessage oversized)
protected boolean	ignoreContentAfterContinueResponse(Object msg)
protected boolean	isAggregated(HttpObject msg)
protected boolean	isContentLengthInvalid(HttpMessage start, int maxContentLength)
protected boolean	isContentMessage(HttpObject msg)
protected boolean	isLastContentMessage(HttpContent msg)
protected boolean	isStartMessage(HttpObject msg)
protected Object	newContinueResponse(HttpMessage start, int maxContentLength, io.netty.channel.ChannelPipeline pipeline)

Methods inherited from class io.netty.handler.codec.MessageAggregator

acceptInboundMessage, channelInactive, channelReadComplete, ctx, decode, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, releaseCurrentMessage, setMaxCumulationBufferComponents

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpObjectAggregator

public HttpObjectAggregator(int maxContentLength)

Creates a new instance.

Parameters:

maxContentLength - the maximum length of the aggregated content in bytes. If the length of the aggregated content exceeds this value, handleOversizedMessage(ChannelHandlerContext, HttpMessage) will be called.

HttpObjectAggregator

public HttpObjectAggregator(int maxContentLength,
                            boolean closeOnExpectationFailed)

Creates a new instance.

Parameters:

maxContentLength - the maximum length of the aggregated content in bytes. If the length of the aggregated content exceeds this value, handleOversizedMessage(ChannelHandlerContext, HttpMessage) will be called.

closeOnExpectationFailed - If a 100-continue response is detected but the content length is too large then true means close the connection. otherwise the connection will remain open and data will be consumed and discarded until the next request is received.

Method Detail

isStartMessage

protected boolean isStartMessage(HttpObject msg)
                          throws Exception

Specified by:

isStartMessage in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception

isContentMessage

protected boolean isContentMessage(HttpObject msg)
                            throws Exception

Specified by:

isContentMessage in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception

isLastContentMessage

protected boolean isLastContentMessage(HttpContent msg)
                                throws Exception

Specified by:

isLastContentMessage in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception

isAggregated

protected boolean isAggregated(HttpObject msg)
                        throws Exception

Specified by:

isAggregated in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception

isContentLengthInvalid

protected boolean isContentLengthInvalid(HttpMessage start,
                                         int maxContentLength)

Specified by:

isContentLengthInvalid in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

newContinueResponse

protected Object newContinueResponse(HttpMessage start,
                                     int maxContentLength,
                                     io.netty.channel.ChannelPipeline pipeline)

Specified by:

newContinueResponse in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

closeAfterContinueResponse

protected boolean closeAfterContinueResponse(Object msg)

Specified by:

closeAfterContinueResponse in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

ignoreContentAfterContinueResponse

protected boolean ignoreContentAfterContinueResponse(Object msg)

Specified by:

ignoreContentAfterContinueResponse in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

beginAggregation

protected FullHttpMessage beginAggregation(HttpMessage start,
                                           io.netty.buffer.ByteBuf content)
                                    throws Exception

Specified by:

beginAggregation in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception

aggregate

protected void aggregate(FullHttpMessage aggregated,
                         HttpContent content)
                  throws Exception

Overrides:

aggregate in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception

finishAggregation

protected void finishAggregation(FullHttpMessage aggregated)
                          throws Exception

Overrides:

finishAggregation in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception

handleOversizedMessage

protected void handleOversizedMessage(io.netty.channel.ChannelHandlerContext ctx,
                                      HttpMessage oversized)
                               throws Exception

Overrides:

handleOversizedMessage in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception