Netty 5.0.0.Alpha5 · io.netty5.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 Decompressor, which is created by newContentDecoder(CharSequence). 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(CharSequence) 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(CharSequence) 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 Buffers into HTTP requests.

Field Summary

Modifier and Type	Field and Description
private boolean	continueResponse
protected ChannelHandlerContext	ctx
private Decompressor	decompressor
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 default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`.
private void	cleanup()
private void	cleanupSafely(ChannelHandlerContext ctx)
protected void	decodeAndClose(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, HttpObject the message to decode to another one msg) Overrides io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose. Decode from one message to another.
private void	decodeContent(ChannelHandlerContext ctx, HttpContent<?> c)
private void	fireChannelRead(ChannelHandlerContext ctx, Object msg)
protected String	Returns: the expected content encoding of the new content getTargetContentEncoding(CharSequence the value of the `"Content-Encoding"` header contentEncoding) Returns the expected content encoding of the decoded content.
public void	handlerAdded(ChannelHandlerContext ctx) Overrides default io.netty5.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 default io.netty5.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
protected abstract Decompressor	Returns: a new `Decompressor` if the specified encoding is supported. `null` otherwise (alternatively, you can throw an exception to block unknown encoding). newContentDecoder(CharSequence the value of the `"Content-Encoding"` header contentEncoding) Returns a new `Decompressor` that decodes the HTTP message content encoded in the specified `contentEncoding`.

Inherited from io.netty5.handler.codec.MessageToMessageDecoder:: acceptInboundMessage channelRead decode

Field Detail

continueResponse	back to summary
private boolean continueResponse

ctx	back to summary
protected ChannelHandlerContext ctx

decompressor	back to summary
private Decompressor decompressor

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 default io.netty5.channel.ChannelHandler.channelInactive. Doc from io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelInactive.

Doc from io.netty5.channel.ChannelHandler.channelInactive.

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Annotations

@Override

channelReadComplete back to summary

channelReadComplete	back to summary
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Doc from io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`. If `ChannelOption#AUTO_READ` is off, no further attempt to read an inbound data from the current `Channel` will be made until `ChannelOutboundInvoker#read(ReadBufferAllocator)` is called. Annotations @Override

public void channelReadComplete(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelReadComplete.

Doc from io.netty5.channel.ChannelHandler.channelReadComplete.

Invoked when the last message read by the current read operation has been consumed by channelRead(ChannelHandlerContext, Object). If ChannelOption#AUTO_READ is off, no further attempt to read an inbound data from the current Channel will be made until ChannelOutboundInvoker#read(ReadBufferAllocator) is called.

Annotations

@Override

cleanup	back to summary
private void cleanup()

cleanupSafely	back to summary
private void cleanupSafely(ChannelHandlerContext ctx)

decodeAndClose back to summary

decodeAndClose	back to summary
protected void decodeAndClose(ChannelHandlerContext ctx, HttpObject msg) throws Exception Overrides io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose. Doc from io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose. Decode from one message to another. This method will be called for each written message that can be handled by this decoder. The message will not be automatically disposed of after this call. Instead, the responsibility of ensuring that messages are disposed of falls upon the implementor of this method. Subclasses that wish to have incoming messages automatically disposed of should instead override the `decodeAndClose(ChannelHandlerContext, Object)` method. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:HttpObject the message to decode to another one Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decodeAndClose(ChannelHandlerContext ctx, HttpObject msg) throws Exception

Overrides io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose.

Doc from io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose.

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

The message will not be automatically disposed of after this call. Instead, the responsibility of ensuring that messages are disposed of falls upon the implementor of this method.

Subclasses that wish to have incoming messages automatically disposed of should instead override the decodeAndClose(ChannelHandlerContext, Object) method.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:HttpObject: the message to decode to another one

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

decodeContent	back to summary
private void decodeContent(ChannelHandlerContext ctx, HttpContent<?> c)

fireChannelRead	back to summary
private void fireChannelRead(ChannelHandlerContext ctx, Object msg)

getTargetContentEncoding back to summary

getTargetContentEncoding	back to summary
protected String getTargetContentEncoding(CharSequence 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:CharSequence the value of the `"Content-Encoding"` header Returns:String the expected content encoding of the new content

protected String getTargetContentEncoding(CharSequence 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:CharSequence: 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 default io.netty5.channel.ChannelHandler.handlerAdded. Doc from io.netty5.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 default io.netty5.channel.ChannelHandler.handlerAdded.

Doc from io.netty5.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 default io.netty5.channel.ChannelHandler.handlerRemoved. Doc from io.netty5.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 default io.netty5.channel.ChannelHandler.handlerRemoved.

Doc from io.netty5.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 Decompressor newContentDecoder(CharSequence contentEncoding) throws Exception Returns a new `Decompressor` that decodes the HTTP message content encoded in the specified `contentEncoding`. Parameters contentEncoding:CharSequence the value of the `"Content-Encoding"` header Returns:Decompressor a new `Decompressor` if the specified encoding is supported. `null` otherwise (alternatively, you can throw an exception to block unknown encoding).

protected abstract Decompressor newContentDecoder(CharSequence contentEncoding) throws Exception

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

Parameters

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

Returns:Decompressor

a new Decompressor 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