io.netty.handler.codec.http

Class HttpContentEncoder

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelHandlerAdapter

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

io.netty.handler.codec.http.HttpContentEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelInboundMessageHandler<HttpMessage>, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundHandler, io.netty.channel.ChannelOutboundMessageHandler<Object>, io.netty.channel.ChannelStateHandler

Direct Known Subclasses:

HttpContentCompressor

public abstract class HttpContentEncoder
extends io.netty.handler.codec.MessageToMessageCodec<HttpMessage,HttpMessage,Object,Object>

Encodes the content of the outbound HttpResponse and HttpChunk. The original content is replaced with the new content encoded by the EncoderEmbedder, which is created by beginEncode(HttpMessage, String). Once encoding is finished, the value of the 'Content-Encoding' header is set to the target content encoding, as returned by beginEncode(HttpMessage, String). Also, the 'Content-Length' header is updated to the length of the encoded content. If there is no supported or allowed encoding in the corresponding HttpRequest's "Accept-Encoding" header, beginEncode(HttpMessage, String) should return null so that no encoding occurs (i.e. pass-through).

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

This handler must be placed after HttpMessageEncoder in the pipeline so that this handler can intercept HTTP responses before HttpMessageEncoder converts them into ByteBufs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpContentEncoder.Result

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	afterRemove(io.netty.channel.ChannelHandlerContext ctx)
protected abstract HttpContentEncoder.Result	beginEncode(HttpMessage msg, String acceptEncoding) Prepare to encode the HTTP message content.
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
HttpMessage	decode(io.netty.channel.ChannelHandlerContext ctx, HttpMessage msg)
Object	encode(io.netty.channel.ChannelHandlerContext ctx, Object msg)
boolean	isDecodable(Object msg)
boolean	isEncodable(Object msg)

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

flush, inboundBufferUpdated, newInboundBuffer, newOutboundBuffer

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, close, connect, deregister, disconnect

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

bind, close, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

HttpContentEncoder

protected HttpContentEncoder()

Creates a new instance.

Method Detail

isDecodable

public boolean isDecodable(Object msg)
                    throws Exception

Overrides:

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

Throws:

Exception

decode

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

Specified by:

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

Throws:

Exception

isEncodable

public boolean isEncodable(Object msg)
                    throws Exception

Overrides:

isEncodable in class io.netty.handler.codec.MessageToMessageCodec<HttpMessage,HttpMessage,Object,Object>

Throws:

Exception

encode

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

Specified by:

encode in class io.netty.handler.codec.MessageToMessageCodec<HttpMessage,HttpMessage,Object,Object>

Throws:

Exception

beginEncode

protected abstract HttpContentEncoder.Result beginEncode(HttpMessage msg,
                                    String acceptEncoding)
                                                  throws Exception

Prepare to encode the HTTP message content.

Parameters:

msg - the HTTP message whose content should be encoded

acceptEncoding - the value of the "Accept-Encoding" header

Returns:

the result of preparation, which is composed of the determined target content encoding and a new EncoderEmbedder that encodes the content into the target content encoding. null if acceptEncoding is unsupported or rejected and thus the content should be handled as-is (i.e. no encoding).

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