Netty/Codec/HTTP 4.1.107.Final · io.netty.handler.codec.http.HttpContentDecoder

Decodes the content of the received HttpRequest and HttpContent. The original content is replaced with the new content decoded by the EmbeddedChannel, 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 HttpObjectDecoder in the pipeline so that this handler can intercept HTTP requests after HttpObjectDecoder converts ByteBufs into HTTP requests.

Field Summary

Modifier and Type	Field and Description
private boolean	continueResponse
protected ChannelHandlerContext	ctx
private EmbeddedChannel	decoder
pack-priv static final String	IDENTITY
private boolean	needRead

Constructor Summary

Access	Constructor and Description
public	HttpContentDecoder()

Method Summary

Modifier and Type	Method and Description
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`.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete. Implements io.netty.channel.ChannelInboundHandler.channelReadComplete. Calls `ChannelHandlerContext#fireChannelReadComplete()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
private void	cleanup()
private void	cleanupSafely(ChannelHandlerContext ctx)
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, HttpObject the message to decode to an other one msg, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other.
private void	decode(ByteBuf in, List<Object> out)
private void	decodeContent(HttpContent c, List<Object> out)
private void	fetchDecoderOutput(List<Object> out)
private void	finishDecode(List<Object> out)
protected String	Returns: the expected content encoding of the new content getTargetContentEncoding(String the value of the `"Content-Encoding"` header contentEncoding) Returns the expected content encoding of the decoded content.
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
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.
protected abstract EmbeddedChannel	Returns: a new `EmbeddedChannel` if the specified encoding is supported. `null` otherwise (alternatively, you can throw an exception to block unknown encoding). newContentDecoder(String the value of the `"Content-Encoding"` header contentEncoding) Returns a new `EmbeddedChannel` that decodes the HTTP message content encoded in the specified `contentEncoding`.

Inherited from io.netty.handler.codec.MessageToMessageDecoder:: acceptInboundMessage channelRead

Field Detail

continueResponse	back to summary
private boolean continueResponse

ctx	back to summary
protected ChannelHandlerContext ctx

decoder	back to summary
private EmbeddedChannel decoder

IDENTITY	back to summary
pack-priv static final String IDENTITY

needRead	back to summary
private boolean needRead

Constructor Detail

HttpContentDecoder	back to summary
public HttpContentDecoder()

Method Detail

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

channelReadComplete back to summary

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

public void channelReadComplete(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete.

Implements io.netty.channel.ChannelInboundHandler.channelReadComplete.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete.

Calls ChannelHandlerContext#fireChannelReadComplete() 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

decode	back to summary
protected void decode(ChannelHandlerContext ctx, HttpObject msg, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Doc from io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other. This method will be called for each written message that can be handled by this decoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:HttpObject the message to decode to an other one out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

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

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

Doc from io.netty.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:HttpObject: the message to decode to an other one
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

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

decodeContent	back to summary
private void decodeContent(HttpContent c, List<Object> out)

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

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

getTargetContentEncoding back to summary

getTargetContentEncoding	back to summary
protected String getTargetContentEncoding(String contentEncoding) throws Exception Returns the expected content encoding of the decoded content. This getMethod returns `"identity"` by default, which is the case for most decoders. Parameters contentEncoding:String the value of the `"Content-Encoding"` header Returns:String the expected content encoding of the new content

protected String getTargetContentEncoding(String contentEncoding) throws Exception

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

Parameters

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

Returns:String

the expected content encoding of the new content

handlerAdded back to summary

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

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Doc from io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

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

newContentDecoder back to summary

newContentDecoder	back to summary
protected abstract EmbeddedChannel newContentDecoder(String contentEncoding) throws Exception Returns a new `EmbeddedChannel` that decodes the HTTP message content encoded in the specified `contentEncoding`. Parameters contentEncoding:String the value of the `"Content-Encoding"` header Returns:EmbeddedChannel a new `EmbeddedChannel` if the specified encoding is supported. `null` otherwise (alternatively, you can throw an exception to block unknown encoding).

protected abstract EmbeddedChannel newContentDecoder(String contentEncoding) throws Exception

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

Parameters

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

Returns:EmbeddedChannel

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

public abstract Class HttpContentDecoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail