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 HttpObjectDecoder in the ChannelPipeline:

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

Be aware that you need to have the HttpResponseEncoder or HttpRequestEncoder before the HttpObjectAggregator in the ChannelPipeline.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
HttpObjectAggregator(int maxContentLength) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	aggregate(FullHttpMessage aggregated, HttpContent content)
protected FullHttpMessage	beginAggregation(HttpMessage start, io.netty.buffer.ByteBuf content)
protected long	contentLength(HttpMessage start)
protected void	finishAggregation(FullHttpMessage aggregated)
protected void	handleOversizedMessage(io.netty.channel.ChannelHandlerContext ctx, HttpMessage oversized)
protected boolean	hasContentLength(HttpMessage start)
protected boolean	isAggregated(HttpObject msg)
protected boolean	isContentMessage(HttpObject msg)
protected boolean	isLastContentMessage(HttpContent msg)
protected boolean	isStartMessage(HttpObject msg)
protected Object	newContinueResponse(HttpMessage start)

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

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

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

channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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. If the length of the aggregated content exceeds this value, handleOversizedMessage(ChannelHandlerContext, HttpMessage) will be called.

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

hasContentLength

protected boolean hasContentLength(HttpMessage start)
                            throws Exception

Specified by:

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

Throws:

Exception

contentLength

protected long contentLength(HttpMessage start)
                      throws Exception

Specified by:

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

Throws:

Exception

newContinueResponse

protected Object newContinueResponse(HttpMessage start)
                              throws Exception

Specified by:

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

Throws:

Exception

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