io.netty.handler.codec.http

Class HttpChunkAggregator

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<Object,HttpMessage>

io.netty.handler.codec.http.HttpChunkAggregator

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelInboundMessageHandler<Object>, io.netty.channel.ChannelStateHandler

public class HttpChunkAggregator
extends io.netty.handler.codec.MessageToMessageDecoder<Object,HttpMessage>

A ChannelHandler that aggregates an HttpMessage and its following HttpChunks into a single HttpMessage with no following HttpChunks. It is useful when you don't want to take care of HTTP messages whose transfer encoding is 'chunked'. Insert this handler after HttpMessageDecoder in the ChannelPipeline:

 ChannelPipeline p = ...;
 ...
 p.addLast("decoder", new HttpRequestDecoder());
 p.addLast("aggregator", new HttpChunkAggregator(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

Constructor Summary

Constructors

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

Method Summary

Methods

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

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

inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, afterRemove, beforeRemove, channelActive, channelInactive, channelRegistered, channelUnregistered, exceptionCaught, userEventTriggered

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, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeRemove, exceptionCaught, userEventTriggered

Field Detail

DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

public static final int DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

See Also:

Constant Field Values

Constructor Detail

HttpChunkAggregator

public HttpChunkAggregator(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.

isDecodable

public boolean isDecodable(Object msg)
                    throws Exception

Overrides:

isDecodable in class io.netty.handler.codec.MessageToMessageDecoder<Object,HttpMessage>

Throws:

Exception

decode

public HttpMessage decode(io.netty.channel.ChannelHandlerContext ctx,
                 Object msg)
                   throws Exception

Specified by:

decode in class io.netty.handler.codec.MessageToMessageDecoder<Object,HttpMessage>

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

Throws:

Exception