io.netty.handler.codec.http

Class HttpContentDecoder

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.codec.http.HttpContentDecoder

All Implemented Interfaces:

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

Direct Known Subclasses:

HttpContentDecompressor

public abstract class HttpContentDecoder
extends io.netty.handler.codec.MessageToMessageDecoder<Object,Object>

Decodes the content of the received HttpRequest and HttpChunk. The original content is replaced with the new content decoded by the DecoderEmbedder, which is created by newContentDecoder(String). Once decoding is finished, the value of the 'Content-Encoding' header is set to the target content encoding, as returned by getTargetContentEncoding(String). Also, the 'Content-Length' header is updated to the length of the decoded content. If the content encoding of the original is not supported by the decoder, newContentDecoder(String) should return null so that no decoding occurs (i.e. pass-through).

Please note that this is an abstract class. You have to extend this class and implement newContentDecoder(String) properly to make this class functional. For example, refer to the source code of HttpContentDecompressor.

This handler must be placed after HttpMessageDecoder in the pipeline so that this handler can intercept HTTP requests after HttpMessageDecoder converts ByteBufs into HTTP requests.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpContentDecoder() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterRemove(io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
Object	decode(io.netty.channel.ChannelHandlerContext ctx, Object msg)
protected String	getTargetContentEncoding(String contentEncoding) Returns the expected content encoding of the decoded content.
boolean	isDecodable(Object msg)
protected abstract io.netty.channel.embedded.EmbeddedByteChannel	newContentDecoder(String contentEncoding) Returns a new DecoderEmbedder that decodes the HTTP message content encoded in the specified contentEncoding.

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

inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, beforeAdd, beforeRemove, channelActive, 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, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

HttpContentDecoder

protected HttpContentDecoder()

Creates a new instance.

Method Detail

isDecodable

public boolean isDecodable(Object msg)
                    throws Exception

Overrides:

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

Throws:

Exception

decode

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

Specified by:

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

Throws:

Exception

newContentDecoder

protected abstract io.netty.channel.embedded.EmbeddedByteChannel newContentDecoder(String contentEncoding)
                                                                            throws Exception

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

Parameters:

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

Returns:

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

Throws:

Exception

getTargetContentEncoding

protected String getTargetContentEncoding(String contentEncoding)
                                   throws Exception

Returns the expected content encoding of the decoded content. This method returns "identity" by default, which is the case for most decoders.

Parameters:

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

Returns:

the expected content encoding of the new content

Throws:

Exception

afterRemove

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

Specified by:

afterRemove in interface io.netty.channel.ChannelHandler

Overrides:

afterRemove in class io.netty.channel.ChannelStateHandlerAdapter

Throws:

Exception

channelInactive

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

Specified by:

channelInactive in interface io.netty.channel.ChannelStateHandler

Overrides:

channelInactive in class io.netty.channel.ChannelStateHandlerAdapter

Throws:

Exception