Class HttpMessageEncoder

java.lang.Object

org.jboss.netty.handler.codec.oneone.OneToOneEncoder

org.jboss.netty.handler.codec.http.HttpMessageEncoder

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler

Direct Known Subclasses:

HttpRequestEncoder, HttpResponseEncoder, RtspMessageEncoder

public abstract class HttpMessageEncoder
extends OneToOneEncoder

Encodes an HttpMessage or an HttpChunk into a ChannelBuffer.

Extensibility

Please note that this encoder is designed to be extended to implement a protocol derived from HTTP, such as RTSP and ICAP. To implement the encoder of such a derived protocol, extend this class and implement all abstract methods properly.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte[]	CRLF
private static final ChannelBuffer	LAST_CHUNK
private boolean	transferEncodingChunked

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpMessageEncoder()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
private static byte	c2b(char c)
protected Object	encode(ChannelHandlerContext ctx, Channel channel, Object msg)	Transforms the specified message into another message and return the transformed message.
protected static void	encodeAscii(String s, ChannelBuffer buf)
private static void	encodeHeader(ChannelBuffer buf, String header, String value)
private static void	encodeHeaders(ChannelBuffer buf, HttpMessage message)
protected abstract void	encodeInitialLine(ChannelBuffer buf, HttpMessage message)
private static void	encodeTrailingHeaders(ChannelBuffer buf, HttpChunkTrailer trailer)

Methods inherited from class OneToOneEncoder

doEncode, handleDownstream

Methods inherited from class Object

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

Field Details

CRLF

private static final byte[] CRLF

LAST_CHUNK

private static final ChannelBuffer LAST_CHUNK

transferEncodingChunked

private volatile boolean transferEncodingChunked

Constructor Details

HttpMessageEncoder

protected HttpMessageEncoder()

Creates a new instance.

Method Details

encode

protected Object encode(ChannelHandlerContext ctx,
 Channel channel,
 Object msg)
                 throws Exception

Description copied from class: OneToOneEncoder

Transforms the specified message into another message and return the transformed message. Note that you can not return null, unlike you can in OneToOneDecoder.decode(ChannelHandlerContext, Channel, Object); you must return something, at least ChannelBuffers.EMPTY_BUFFER.

Specified by:

encode in class OneToOneEncoder

Throws:

Exception

encodeHeaders

private static void encodeHeaders(ChannelBuffer buf,
 HttpMessage message)

encodeTrailingHeaders

private static void encodeTrailingHeaders(ChannelBuffer buf,
 HttpChunkTrailer trailer)

encodeHeader

private static void encodeHeader(ChannelBuffer buf,
 String header,
 String value)
                          throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

encodeAscii

protected static void encodeAscii(String s,
 ChannelBuffer buf)

c2b

private static byte c2b(char c)

encodeInitialLine

protected abstract void encodeInitialLine(ChannelBuffer buf,
 HttpMessage message)
                                   throws Exception

Throws:

Exception