Class HttpContentDecompressor

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.codec.http.HttpContentDecoder

io.netty.handler.codec.http.HttpContentDecompressor

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class HttpContentDecompressor
extends HttpContentDecoder

Decompresses an HttpMessage and an HttpContent compressed in gzip or deflate encoding. For more information on how this handler modifies the message, please refer to HttpContentDecoder.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Field Summary

Fields inherited from class HttpContentDecoder

ctx

Modifier and Type	Field	Description
protected ChannelHandlerContext	ctx

Constructor Summary

Constructors

Constructor	Description
HttpContentDecompressor()	Deprecated. Use HttpContentDecompressor(int).
HttpContentDecompressor(boolean strict)	Deprecated. Use HttpContentDecompressor(boolean, int).
HttpContentDecompressor(boolean strict, int maxAllocation)	Create a new HttpContentDecompressor.
HttpContentDecompressor(int maxAllocation)	Create a new HttpContentDecompressor in non-strict mode.

Method Summary

Modifier and Type	Method	Description
protected EmbeddedChannel	newContentDecoder(String contentEncoding)	Returns a new EmbeddedChannel that decodes the HTTP message content encoded in the specified contentEncoding.

Methods inherited from class HttpContentDecoder

channelInactive, channelReadComplete, decode, getTargetContentEncoding, handlerAdded, handlerRemoved

Modifier and Type	Method	Description
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, HttpObject msg, List<Object> out)	Decode from one message to an other.
protected String	getTargetContentEncoding(String contentEncoding)	Returns the expected content encoding of the decoded content.
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.

Methods inherited from class MessageToMessageDecoder

acceptInboundMessage, channelRead

Modifier and Type	Method	Description
boolean	acceptInboundMessage(Object msg)	Returns true if the given message should be handled.
void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

HttpContentDecompressor

@Deprecated
public HttpContentDecompressor()

Deprecated.

Use HttpContentDecompressor(int).

Create a new HttpContentDecompressor in non-strict mode.

HttpContentDecompressor

public HttpContentDecompressor(int maxAllocation)

Create a new HttpContentDecompressor in non-strict mode.

Parameters:

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

HttpContentDecompressor

@Deprecated
public HttpContentDecompressor(boolean strict)

Deprecated.

Use HttpContentDecompressor(boolean, int).

Create a new HttpContentDecompressor.

Parameters:

strict - if true use strict handling of deflate if used, otherwise handle it in a more lenient fashion.

HttpContentDecompressor

public HttpContentDecompressor(boolean strict,
 int maxAllocation)

Create a new HttpContentDecompressor.

Parameters:

strict - if true use strict handling of deflate if used, otherwise handle it in a more lenient fashion.

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

Method Details

newContentDecoder

protected EmbeddedChannel newContentDecoder(String contentEncoding)
                                     throws Exception

Description copied from class: HttpContentDecoder

Returns a new EmbeddedChannel that decodes the HTTP message content encoded in the specified contentEncoding.

Specified by:

newContentDecoder in class HttpContentDecoder

Parameters:

contentEncoding - the value of the "Content-Encoding" header

Returns:

a new EmbeddedChannel if the specified encoding is supported. null otherwise (alternatively, you can throw an exception to block unknown encoding).

Throws:

Exception