io.netty.handler.codec.http

Class HttpObjectAggregator

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundMessageHandlerAdapter<I>

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

io.netty.handler.codec.http.HttpObjectAggregator

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleInboundMessageHandler<HttpObject>, io.netty.channel.ChannelInboundMessageHandler<HttpObject>, io.netty.channel.ChannelStateHandler

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

A ChannelHandler that aggregates an HttpMessage and its following HttpContents into a single HttpMessage 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("decoder", new HttpRequestDecoder());
 p.addLast("aggregator", new HttpObjectAggregator(1048576));
 ...
 p.addLast("encoder", new HttpResponseEncoder());
 p.addLast("handler", new HttpRequestHandler());
 

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

Fields inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

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

Method Summary

Methods

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

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

messageReceived

Methods inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

acceptInboundMessage, beginMessageReceived, endMessageReceived, freeInboundBuffer, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeRemove, exceptionCaught

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.ChannelStateHandler

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeRemove, exceptionCaught

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. If the length of the aggregated content exceeds this value, a TooLongFrameException will be raised.

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 Object decode(io.netty.channel.ChannelHandlerContext ctx,
            HttpObject msg)
                 throws Exception

Specified by:

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

Throws:

Exception

beforeAdd

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

Specified by:

beforeAdd in interface io.netty.channel.ChannelHandler

Overrides:

beforeAdd in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception