Encodes the content of the outbound HttpResponse and HttpContent. The original content is replaced with the new content encoded by the EmbeddedChannel, which is created by beginEncode(HttpResponse, String). Once encoding is finished, the value of the 'Content-Encoding' header is set to the target content encoding, as returned by beginEncode(HttpResponse, 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(HttpResponse, 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(HttpResponse, String) properly to make this class functional. For example, refer to the source code of HttpContentCompressor.

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

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	HttpContentEncoder.Result
private static enum	HttpContentEncoder.State

Field Summary

Modifier and Type	Field and Description
private final Queue<CharSequence>	acceptEncodingQueue
private EmbeddedChannel	encoder Hides io.netty.handler.codec.MessageToMessageCodec.encoder.
private HttpContentEncoder.State	state
private static final CharSequence	ZERO_LENGTH_CONNECT
private static final CharSequence	ZERO_LENGTH_HEAD

Constructor Summary

Access	Constructor and Description
public	HttpContentEncoder()

Method Summary

Modifier and Type	Method and Description
public boolean	acceptOutboundMessage(Object the message msg) Overrides io.netty.handler.codec.MessageToMessageCodec.acceptOutboundMessage. Returns `true` if and only if the specified message can be encoded by this codec.
protected abstract HttpContentEncoder.Result	Returns: the result of preparation, which is composed of the determined target content encoding and a new `EmbeddedChannel` 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). beginEncode(HttpResponse the http response httpResponse, String the value of the `"Accept-Encoding"` header acceptEncoding) Prepare to encode the HTTP message content.
public void	channelInactive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelInactive. Implements io.netty.channel.ChannelInboundHandler.channelInactive. Calls `ChannelHandlerContext#fireChannelInactive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
private void	cleanup()
private void	cleanupSafely(ChannelHandlerContext ctx)
protected void	decode(ChannelHandlerContext ctx, HttpRequest msg, List<Object> out) Implements abstract io.netty.handler.codec.MessageToMessageCodec.decode.
protected void	encode(ChannelHandlerContext ctx, HttpObject msg, List<Object> out) Implements abstract io.netty.handler.codec.MessageToMessageCodec.encode.
private void	encode(ByteBuf in, List<Object> out)
private boolean	encodeContent(HttpContent c, List<Object> out)
private void	encodeFullResponse(HttpResponse newRes, HttpContent content, List<Object> out)
private static void	ensureContent(HttpObject msg)
private static void	ensureHeaders(HttpObject msg)
private void	fetchEncoderOutput(List<Object> out)
private void	finishEncode(List<Object> out)
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
private static boolean	isPassthru(HttpVersion version, int code, CharSequence httpMethod)

Inherited from io.netty.handler.codec.MessageToMessageCodec:: acceptInboundMessage channelRead write

Field Detail

acceptEncodingQueue	back to summary
private final Queue<CharSequence> acceptEncodingQueue

encoder	back to summary
private EmbeddedChannel encoder Hides io.netty.handler.codec.MessageToMessageCodec.encoder.

state	back to summary
private HttpContentEncoder.State state

ZERO_LENGTH_CONNECT	back to summary
private static final CharSequence ZERO_LENGTH_CONNECT

ZERO_LENGTH_HEAD	back to summary
private static final CharSequence ZERO_LENGTH_HEAD

Constructor Detail

HttpContentEncoder	back to summary
public HttpContentEncoder()

Method Detail

acceptOutboundMessage back to summary

acceptOutboundMessage	back to summary
public boolean acceptOutboundMessage(Object msg) throws Exception Overrides io.netty.handler.codec.MessageToMessageCodec.acceptOutboundMessage. Doc from io.netty.handler.codec.MessageToMessageCodec.acceptOutboundMessage. Returns `true` if and only if the specified message can be encoded by this codec. Parameters msg:Object the message Annotations @Override

public boolean acceptOutboundMessage(Object msg) throws Exception

Overrides io.netty.handler.codec.MessageToMessageCodec.acceptOutboundMessage.

Doc from io.netty.handler.codec.MessageToMessageCodec.acceptOutboundMessage.

Returns true if and only if the specified message can be encoded by this codec.

Parameters

msg:Object: the message

Annotations

@Override

beginEncode back to summary

beginEncode	back to summary
protected abstract HttpContentEncoder.Result beginEncode(HttpResponse httpResponse, String acceptEncoding) throws Exception Prepare to encode the HTTP message content. Parameters httpResponse:HttpResponse the http response acceptEncoding:String the value of the `"Accept-Encoding"` header Returns:HttpContentEncoder.Result the result of preparation, which is composed of the determined target content encoding and a new `EmbeddedChannel` 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).

protected abstract HttpContentEncoder.Result beginEncode(HttpResponse httpResponse, String acceptEncoding) throws Exception

Prepare to encode the HTTP message content.

Parameters

httpResponse:HttpResponse: the http response
acceptEncoding:String: the value of the "Accept-Encoding" header

Returns:HttpContentEncoder.Result

the result of preparation, which is composed of the determined target content encoding and a new EmbeddedChannel 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).

channelInactive back to summary

channelInactive	back to summary
public void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelInactive. Implements io.netty.channel.ChannelInboundHandler.channelInactive. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelInactive. Calls `ChannelHandlerContext#fireChannelInactive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelInactive.

Implements io.netty.channel.ChannelInboundHandler.channelInactive.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelInactive.

Calls ChannelHandlerContext#fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Annotations

@Override

cleanup	back to summary
private void cleanup()

cleanupSafely	back to summary
private void cleanupSafely(ChannelHandlerContext ctx)

decode	back to summary
protected void decode(ChannelHandlerContext ctx, HttpRequest msg, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.MessageToMessageCodec.decode. Annotations @Override

decode

back to summary

protected void decode(ChannelHandlerContext ctx, HttpRequest msg, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.MessageToMessageCodec.decode.

Annotations

@Override

encode	back to summary
protected void encode(ChannelHandlerContext ctx, HttpObject msg, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.MessageToMessageCodec.encode. Annotations @Override

encode

back to summary

protected void encode(ChannelHandlerContext ctx, HttpObject msg, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.MessageToMessageCodec.encode.

Annotations

@Override

encode	back to summary
private void encode(ByteBuf in, List<Object> out)

encodeContent	back to summary
private boolean encodeContent(HttpContent c, List<Object> out)

encodeFullResponse	back to summary
private void encodeFullResponse(HttpResponse newRes, HttpContent content, List<Object> out)

ensureContent	back to summary
private static void ensureContent(HttpObject msg)

ensureHeaders	back to summary
private static void ensureHeaders(HttpObject msg)

fetchEncoderOutput	back to summary
private void fetchEncoderOutput(List<Object> out)

finishEncode	back to summary
private void finishEncode(List<Object> out)

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Doc from io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved.

Implements io.netty.channel.ChannelHandler.handlerRemoved.

Doc from io.netty.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

isPassthru	back to summary
private static boolean isPassthru(HttpVersion version, int code, CharSequence httpMethod)

io.netty.handler.codec.http back to summary

public final Class HttpContentEncoder.Result

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.codec.http.HttpContentEncoder.Result

Field Summary

Modifier and Type	Field and Description
private final EmbeddedChannel	contentEncoder
private final String	targetContentEncoding

Constructor Summary

Access	Constructor and Description
public	Result(String targetContentEncoding, EmbeddedChannel contentEncoder)

Method Summary

Modifier and Type	Method and Description
public EmbeddedChannel	contentEncoder()
public String	targetContentEncoding()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

contentEncoder	back to summary
private final EmbeddedChannel contentEncoder

targetContentEncoding	back to summary
private final String targetContentEncoding

Constructor Detail

Result	back to summary
public Result(String targetContentEncoding, EmbeddedChannel contentEncoder)

Method Detail

contentEncoder	back to summary
public EmbeddedChannel contentEncoder()

targetContentEncoding	back to summary
public String targetContentEncoding()

io.netty.handler.codec.http back to summary

private final Enum HttpContentEncoder.State

Class Inheritance

extends Enum<HttpContentEncoder.State>

java.lang.Object
java.lang.Enum
io.netty.handler.codec.http.HttpContentEncoder.State

Field Summary

Modifier and Type	Field and Description
public static final HttpContentEncoder.State	AWAIT_CONTENT
public static final HttpContentEncoder.State	AWAIT_HEADERS
public static final HttpContentEncoder.State	PASS_THROUGH

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static HttpContentEncoder.State	valueOf(String name)
public static HttpContentEncoder.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AWAIT_CONTENT	back to summary
public static final HttpContentEncoder.State AWAIT_CONTENT

AWAIT_HEADERS	back to summary
public static final HttpContentEncoder.State AWAIT_HEADERS

PASS_THROUGH	back to summary
public static final HttpContentEncoder.State PASS_THROUGH

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static HttpContentEncoder.State valueOf(String name)

values	back to summary
public static HttpContentEncoder.State[] values()

public abstract Class HttpContentEncoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class HttpContentEncoder.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum HttpContentEncoder.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail