org.jboss.netty.handler.codec.http

类 HttpContentDecoder

java.lang.Object

org.jboss.netty.channel.SimpleChannelUpstreamHandler

org.jboss.netty.handler.codec.http.HttpContentDecoder

所有已实现的接口:

ChannelHandler, ChannelUpstreamHandler, LifeCycleAwareChannelHandler

直接已知子类:

HttpContentDecompressor

public abstract class HttpContentDecoder
extends SimpleChannelUpstreamHandler
implements LifeCycleAwareChannelHandler

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

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

限定符	构造器和说明
protected	HttpContentDecoder() Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
void	afterAdd(ChannelHandlerContext ctx)
void	afterRemove(ChannelHandlerContext ctx)
void	beforeAdd(ChannelHandlerContext ctx)
void	beforeRemove(ChannelHandlerContext ctx)
void	channelClosed(ChannelHandlerContext ctx, ChannelStateEvent e) Invoked when a Channel was closed and all its related resources were released.
protected java.lang.String	getTargetContentEncoding(java.lang.String contentEncoding) Returns the expected content encoding of the decoded content.
void	messageReceived(ChannelHandlerContext ctx, MessageEvent e) Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.
protected abstract DecoderEmbedder<ChannelBuffer>	newContentDecoder(java.lang.String contentEncoding) Returns a new DecoderEmbedder that decodes the HTTP message content encoded in the specified contentEncoding.

从类继承的方法 org.jboss.netty.channel.SimpleChannelUpstreamHandler

channelBound, channelConnected, channelDisconnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, exceptionCaught, handleUpstream, writeComplete

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

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

构造器详细资料

HttpContentDecoder

protected HttpContentDecoder()

Creates a new instance.

方法详细资料

messageReceived

public void messageReceived(ChannelHandlerContext ctx,
                   MessageEvent e)
                     throws java.lang.Exception

从类复制的说明: SimpleChannelUpstreamHandler

Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.

覆盖:

messageReceived 在类中 SimpleChannelUpstreamHandler

抛出:

java.lang.Exception

channelClosed

public void channelClosed(ChannelHandlerContext ctx,
                 ChannelStateEvent e)
                   throws java.lang.Exception

从类复制的说明: SimpleChannelUpstreamHandler

Invoked when a Channel was closed and all its related resources were released.

覆盖:

channelClosed 在类中 SimpleChannelUpstreamHandler

抛出:

java.lang.Exception

newContentDecoder

protected abstract DecoderEmbedder<ChannelBuffer> newContentDecoder(java.lang.String contentEncoding)
                                                             throws java.lang.Exception

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

参数:

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

返回:

a new DecoderEmbedder 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 method 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

beforeAdd

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

指定者:

beforeAdd 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception

afterAdd

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

指定者:

afterAdd 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception

beforeRemove

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

指定者:

beforeRemove 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception

afterRemove

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

指定者:

afterRemove 在接口中 LifeCycleAwareChannelHandler

抛出:

java.lang.Exception