io.netty.handler.codec.http

类 HttpContentDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<HttpObject>

io.netty.handler.codec.http.HttpContentDecoder

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

直接已知子类:

HttpContentDecompressor

public abstract class HttpContentDecoder
extends MessageToMessageDecoder<HttpObject>

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.

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
protected ChannelHandlerContext	ctx

构造器概要

构造器

构造器和说明
HttpContentDecoder()

方法概要

限定符和类型	方法和说明
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, HttpObject msg, java.util.List<java.lang.Object> out) Decode from one message to an other.
protected java.lang.String	getTargetContentEncoding(java.lang.String contentEncoding) Returns the expected content encoding of the decoded content.
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
protected abstract EmbeddedChannel	newContentDecoder(java.lang.String contentEncoding) Returns a new EmbeddedChannel that decodes the HTTP message content encoded in the specified contentEncoding.

从类继承的方法 io.netty.handler.codec.MessageToMessageDecoder

acceptInboundMessage, channelRead

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

ctx

protected ChannelHandlerContext ctx

构造器详细资料

HttpContentDecoder

public HttpContentDecoder()

方法详细资料

decode

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

从类复制的说明: MessageToMessageDecoder

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

指定者:

decode 在类中 MessageToMessageDecoder<HttpObject>

参数:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

out - the List to which decoded messages should be added

抛出:

java.lang.Exception - is thrown if an error occurs

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelReadComplete 在接口中 ChannelInboundHandler

覆盖:

channelReadComplete 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

newContentDecoder

protected abstract EmbeddedChannel newContentDecoder(java.lang.String contentEncoding)
                                              throws java.lang.Exception

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

参数:

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

返回:

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

抛出:

java.lang.Exception

getTargetContentEncoding

protected java.lang.String getTargetContentEncoding(java.lang.String contentEncoding)
                                             throws java.lang.Exception

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

参数:

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

返回:

the expected content encoding of the new content

抛出:

java.lang.Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerRemoved 在接口中 ChannelHandler

覆盖:

handlerRemoved 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelInactive 在接口中 ChannelInboundHandler

覆盖:

channelInactive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception