Class HttpResponseEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<Object>

io.netty.handler.codec.http.HttpObjectEncoder<HttpResponse>

io.netty.handler.codec.http.HttpResponseEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

public class HttpResponseEncoder
extends HttpObjectEncoder<HttpResponse>

Encodes an HttpResponse or an HttpContent into a ByteBuf.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Constructor Summary

Constructors

Constructor	Description
HttpResponseEncoder()

Method Summary

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
protected void	encodeInitialLine(ByteBuf buf, HttpResponse response)
protected boolean	isContentAlwaysEmpty(HttpResponse msg)	Determine whether a message has a content or not.
protected void	sanitizeHeadersBeforeEncode(HttpResponse msg, boolean isAlwaysEmpty)	Allows to sanitize headers of the message before encoding these.

Methods inherited from class HttpObjectEncoder

encode, encodeAscii, encodeHeaders, write

Modifier and Type	Method	Description
protected void	encode(ChannelHandlerContext ctx, Object msg, List<Object> out)	Encode from one message to an other.
protected static void	encodeAscii(String s, ByteBuf buf)	Deprecated.
protected void	encodeHeaders(HttpHeaders headers, ByteBuf buf)	Encode the HttpHeaders into a ByteBuf.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	read(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Deprecated. is part of ChannelInboundHandler
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.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

HttpResponseEncoder

public HttpResponseEncoder()

Method Details

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Description copied from class: MessageToMessageEncoder

Returns true if the given message should be handled. If false it will be passed to the next ChannelOutboundHandler in the ChannelPipeline.

Overrides:

acceptOutboundMessage in class HttpObjectEncoder<HttpResponse>

Throws:

Exception

encodeInitialLine

protected void encodeInitialLine(ByteBuf buf,
 HttpResponse response)
                          throws Exception

Specified by:

encodeInitialLine in class HttpObjectEncoder<HttpResponse>

Throws:

Exception

sanitizeHeadersBeforeEncode

protected void sanitizeHeadersBeforeEncode(HttpResponse msg,
 boolean isAlwaysEmpty)

Description copied from class: HttpObjectEncoder

Allows to sanitize headers of the message before encoding these.

Overrides:

sanitizeHeadersBeforeEncode in class HttpObjectEncoder<HttpResponse>

isContentAlwaysEmpty

protected boolean isContentAlwaysEmpty(HttpResponse msg)

Description copied from class: HttpObjectEncoder

Determine whether a message has a content or not. Some message may have headers indicating a content without having an actual content, e.g the response to an HEAD or CONNECT request.

Overrides:

isContentAlwaysEmpty in class HttpObjectEncoder<HttpResponse>

Parameters:

msg - the message to test

Returns:

true to signal the message has no content