org.jboss.netty.handler.codec.http

类 HttpContentEncoder

java.lang.Object

org.jboss.netty.channel.SimpleChannelHandler

org.jboss.netty.handler.codec.http.HttpContentEncoder

所有已实现的接口:

ChannelDownstreamHandler, ChannelHandler, ChannelUpstreamHandler, LifeCycleAwareChannelHandler

直接已知子类:

HttpContentCompressor

public abstract class HttpContentEncoder
extends SimpleChannelHandler
implements LifeCycleAwareChannelHandler

Encodes the content of the outbound HttpResponse and HttpChunk. The original content is replaced with the new content encoded by the EncoderEmbedder, which is created by newContentEncoder(HttpMessage, String). Once encoding 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 encoded content. If there is no supported encoding in the corresponding HttpRequest's "Accept-Encoding" header, newContentEncoder(HttpMessage, 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 newContentEncoder(HttpMessage, String) and getTargetContentEncoding(String) properly to make this class functional. For example, refer to the source code of HttpContentCompressor.

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

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

限定符	构造器和说明
protected	HttpContentEncoder() 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 abstract java.lang.String	getTargetContentEncoding(java.lang.String acceptEncoding) Returns the expected content encoding of the encoded content.
void	messageReceived(ChannelHandlerContext ctx, MessageEvent e) Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.
protected abstract EncoderEmbedder<ChannelBuffer>	newContentEncoder(HttpMessage msg, java.lang.String acceptEncoding) Returns a new EncoderEmbedder that encodes the HTTP message content.
void	writeRequested(ChannelHandlerContext ctx, MessageEvent e) Invoked when Channel.write(Object) is called.

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

bindRequested, channelBound, channelConnected, channelDisconnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, closeRequested, connectRequested, disconnectRequested, exceptionCaught, handleDownstream, handleUpstream, setInterestOpsRequested, unbindRequested, writeComplete

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

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

构造器详细资料

HttpContentEncoder

protected HttpContentEncoder()

Creates a new instance.

方法详细资料

messageReceived

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

从类复制的说明: SimpleChannelHandler

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

覆盖:

messageReceived 在类中 SimpleChannelHandler

抛出:

java.lang.Exception

writeRequested

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

从类复制的说明: SimpleChannelHandler

Invoked when Channel.write(Object) is called.

覆盖:

writeRequested 在类中 SimpleChannelHandler

抛出:

java.lang.Exception

channelClosed

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

从类复制的说明: SimpleChannelHandler

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

覆盖:

channelClosed 在类中 SimpleChannelHandler

抛出:

java.lang.Exception

newContentEncoder

protected abstract EncoderEmbedder<ChannelBuffer> newContentEncoder(HttpMessage msg,
                                               java.lang.String acceptEncoding)
                                                             throws java.lang.Exception

Returns a new EncoderEmbedder that encodes the HTTP message content.

参数:

acceptEncoding - the value of the "Accept-Encoding" header

返回:

a new EncoderEmbedder if there is a supported encoding in acceptEncoding. null otherwise.

抛出:

java.lang.Exception

getTargetContentEncoding

protected abstract java.lang.String getTargetContentEncoding(java.lang.String acceptEncoding)
                                                      throws java.lang.Exception

Returns the expected content encoding of the encoded content.

参数:

acceptEncoding - the value of the "Accept-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