Class HttpClientUpgradeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.codec.MessageAggregator<HttpObject, HttpMessage, HttpContent, FullHttpMessage>

io.netty.handler.codec.http.HttpObjectAggregator

io.netty.handler.codec.http.HttpClientUpgradeHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class HttpClientUpgradeHandler
extends HttpObjectAggregator
implements ChannelOutboundHandler

Client-side handler for handling an HTTP upgrade handshake to another protocol. When the first HTTP request is sent, this handler will add all appropriate headers to perform an upgrade to the new protocol. If the upgrade fails (i.e. response is not 101 Switching Protocols), this handler simply removes itself from the pipeline. If the upgrade is successful, upgrades the pipeline to the new protocol.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpClientUpgradeHandler.SourceCodec	The source codec that is used in the pipeline initially.
static interface	HttpClientUpgradeHandler.UpgradeCodec	A codec that the source can be upgraded to.
static enum	HttpClientUpgradeHandler.UpgradeEvent	User events that are fired to notify about upgrade status.

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
HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec, HttpClientUpgradeHandler.UpgradeCodec upgradeCodec, int maxContentLength)	Constructs the client upgrade handler.

Method Summary

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Called once a bind operation is made.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a close operation is made.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Called once a connect operation is made.
protected void	decode(ChannelHandlerContext ctx, HttpObject msg, List<Object> out)	Decode from one message to an other.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a deregister operation is made from the current registered EventLoop.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a disconnect operation is made.
void	flush(ChannelHandlerContext ctx)	Called once a flush operation is made.
void	read(ChannelHandlerContext ctx)	Intercepts ChannelHandlerContext.read().
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Called once a write operation is made.

Methods inherited from class HttpObjectAggregator

aggregate, beginAggregation, closeAfterContinueResponse, finishAggregation, handleOversizedMessage, ignoreContentAfterContinueResponse, isAggregated, isContentLengthInvalid, isContentMessage, isLastContentMessage, isStartMessage, newContinueResponse

Modifier and Type	Method	Description
protected void	aggregate(FullHttpMessage aggregated, HttpContent content)	Transfers the information provided by the specified content message to the specified aggregated message.
protected FullHttpMessage	beginAggregation(HttpMessage start, ByteBuf content)	Creates a new aggregated message from the specified start message and the specified content.
protected boolean	closeAfterContinueResponse(Object msg)	Determine if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written.
protected void	finishAggregation(FullHttpMessage aggregated)	Invoked when the specified aggregated message is about to be passed to the next handler in the pipeline.
protected void	handleOversizedMessage(ChannelHandlerContext ctx, HttpMessage oversized)	Invoked when an incoming request exceeds the maximum content length.
protected boolean	ignoreContentAfterContinueResponse(Object msg)	Determine if all objects for the current request/response should be ignored or not.
protected boolean	isAggregated(HttpObject msg)	Returns true if and only if the specified message is already aggregated.
protected boolean	isContentLengthInvalid(HttpMessage start, int maxContentLength)	Determine if the message start's content length is known, and if it greater than maxContentLength.
protected boolean	isContentMessage(HttpObject msg)	Returns true if and only if the specified message is a content message.
protected boolean	isLastContentMessage(HttpContent msg)	Returns true if and only if the specified message is the last content message.
protected boolean	isStartMessage(HttpObject msg)	Returns true if and only if the specified message is a start message.
protected Object	newContinueResponse(HttpMessage start, int maxContentLength, ChannelPipeline pipeline)	Returns the 'continue response' for the specified start message if necessary.

Methods inherited from class MessageAggregator

acceptInboundMessage, channelInactive, channelReadComplete, ctx, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, releaseCurrentMessage, setMaxCumulationBufferComponents

Modifier and Type	Method	Description
boolean	acceptInboundMessage(Object msg)	Returns true if the given message should be handled.
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 final ChannelHandlerContext	ctx()
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.
final boolean	isHandlingOversizedMessage()	Deprecated. This method will be removed in future releases.
final int	maxContentLength()	Returns the maximum allowed length of the aggregated message in bytes.
final int	maxCumulationBufferComponents()	Returns the maximum number of components in the cumulation buffer.
protected final void	releaseCurrentMessage()
final void	setMaxCumulationBufferComponents(int maxCumulationBufferComponents)	Sets the maximum number of components in the cumulation buffer.

Methods inherited from class MessageToMessageDecoder

channelRead

Modifier and Type	Method	Description
void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
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

HttpClientUpgradeHandler

public HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec,
 HttpClientUpgradeHandler.UpgradeCodec upgradeCodec,
 int maxContentLength)

Constructs the client upgrade handler.

Parameters:

sourceCodec - the codec that is being used initially.

upgradeCodec - the codec that the client would like to upgrade to.

maxContentLength - the maximum length of the aggregated content.

Method Details

bind

public void bind(ChannelHandlerContext ctx,
 SocketAddress localAddress,
 ChannelPromise promise)
          throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a bind operation is made.

Specified by:

bind in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the bind operation is made

localAddress - the SocketAddress to which it should bound

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

connect

public void connect(ChannelHandlerContext ctx,
 SocketAddress remoteAddress,
 SocketAddress localAddress,
 ChannelPromise promise)
             throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a connect operation is made.

Specified by:

connect in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the connect operation is made

remoteAddress - the SocketAddress to which it should connect

localAddress - the SocketAddress which is used as source on connect

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

disconnect

public void disconnect(ChannelHandlerContext ctx,
 ChannelPromise promise)
                throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a disconnect operation is made.

Specified by:

disconnect in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

close

public void close(ChannelHandlerContext ctx,
 ChannelPromise promise)
           throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a close operation is made.

Specified by:

close in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

deregister

public void deregister(ChannelHandlerContext ctx,
 ChannelPromise promise)
                throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a deregister operation is made from the current registered EventLoop.

Specified by:

deregister in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

read

public void read(ChannelHandlerContext ctx)
          throws Exception

Description copied from interface: ChannelOutboundHandler

Intercepts ChannelHandlerContext.read().

Specified by:

read in interface ChannelOutboundHandler

Throws:

Exception

write

public void write(ChannelHandlerContext ctx,
 Object msg,
 ChannelPromise promise)
           throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called

Specified by:

write in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

flush

public void flush(ChannelHandlerContext ctx)
           throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

Specified by:

flush in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

Throws:

Exception - thrown if an error occurs

decode

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

Description copied from class: MessageToMessageDecoder

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

Overrides:

decode in class MessageAggregator<HttpObject, HttpMessage, HttpContent, FullHttpMessage>

Parameters:

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

Throws:

Exception - is thrown if an error occurs