io.netty.handler.codec.http

Class HttpObjectAggregator

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.codec.http.HttpObjectAggregator

All Implemented Interfaces:

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

public class HttpObjectAggregator
extends io.netty.handler.codec.MessageToMessageDecoder<HttpObject>

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, HttpObject msg, List<Object> out)
int	getMaxCumulationBufferComponents() Returns the maximum number of components in the cumulation buffer.
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
void	setMaxCumulationBufferComponents(int maxCumulationBufferComponents) Sets the maximum number of components in the cumulation buffer.

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

acceptInboundMessage, 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

Field Detail

DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

public static final int DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

See Also:

Constant Field Values

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, a TooLongFrameException will be raised.

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, a TooLongFrameException will be raised.

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

getMaxCumulationBufferComponents

public final int getMaxCumulationBufferComponents()

Returns the maximum number of components in the cumulation buffer. If the number of the components in the cumulation buffer exceeds this value, the components of the cumulation buffer are consolidated into a single component, involving memory copies. The default value of this property is DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS.

setMaxCumulationBufferComponents

public final void setMaxCumulationBufferComponents(int maxCumulationBufferComponents)

Sets the maximum number of components in the cumulation buffer. If the number of the components in the cumulation buffer exceeds this value, the components of the cumulation buffer are consolidated into a single component, involving memory copies. The default value of this property is DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS and its minimum allowed value is 2.

decode

protected void decode(io.netty.channel.ChannelHandlerContext ctx,
          HttpObject msg,
          List<Object> out)
               throws Exception

Specified by:

decode in class io.netty.handler.codec.MessageToMessageDecoder<HttpObject>

Throws:

Exception

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

handlerRemoved

public void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
                    throws Exception

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception