Package io.netty.handler.codec.http

Class HttpServerUpgradeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

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

io.netty.handler.codec.http.HttpObjectAggregator

io.netty.handler.codec.http.HttpServerUpgradeHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class HttpServerUpgradeHandler
extends HttpObjectAggregator

A server-side handler that receives HTTP requests and optionally performs a protocol switch if the requested protocol is supported. Once an upgrade is performed, this handler removes itself from the pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpServerUpgradeHandler.SourceCodec	The source codec that is used in the pipeline initially.
static interface	HttpServerUpgradeHandler.UpgradeCodec	A codec that the source can be upgraded to.
static interface	HttpServerUpgradeHandler.UpgradeCodecFactory	Creates a new HttpServerUpgradeHandler.UpgradeCodec for the requested protocol name.
static class	HttpServerUpgradeHandler.UpgradeEvent	User event that is fired to notify about the completion of an HTTP upgrade to another protocol.

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	failedAggregationStart
private boolean	handlingUpgrade
private HttpHeadersFactory	headersFactory
private boolean	removeAfterFirstRequest
private HttpServerUpgradeHandler.SourceCodec	sourceCodec
private HttpHeadersFactory	trailersFactory
private HttpServerUpgradeHandler.UpgradeCodecFactory	upgradeCodecFactory

Constructor Summary

Constructors

Constructor	Description
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory)	Constructs the upgrader with the supported codecs.
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength)	Constructs the upgrader with the supported codecs.
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength, boolean validateHeaders)	Constructs the upgrader with the supported codecs.
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength, HttpHeadersFactory headersFactory, HttpHeadersFactory trailersFactory)	Constructs the upgrader with the supported codecs.
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength, HttpHeadersFactory headersFactory, HttpHeadersFactory trailersFactory, boolean removeAfterFirstRequest)	Constructs the upgrader with the supported codecs.

Method Summary

Modifier and Type	Method	Description
protected FullHttpMessage	beginAggregation(HttpMessage start, ByteBuf content)	Creates a new aggregated message from the specified start message and the specified content.
private FullHttpResponse	createUpgradeResponse(java.lang.CharSequence upgradeProtocol)	Creates the 101 Switching Protocols response message.
protected void	decode(ChannelHandlerContext ctx, HttpObject msg, java.util.List<java.lang.Object> out)	Decode from one message to an other.
protected boolean	shouldHandleUpgradeRequest(HttpRequest req)	Determines whether the specified upgrade HttpRequest should be handled by this handler or not.
private static java.util.List<java.lang.CharSequence>	splitHeader(java.lang.CharSequence header)	Splits a comma-separated header value.
private boolean	upgrade(ChannelHandlerContext ctx, FullHttpRequest request)	Attempts to upgrade to the protocol(s) identified by the HttpHeaderNames.UPGRADE header (if provided in the request).

Methods inherited from class io.netty.handler.codec.http.HttpObjectAggregator

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

Methods inherited from class io.netty.handler.codec.MessageAggregator

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

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Field Detail

sourceCodec

private final HttpServerUpgradeHandler.SourceCodec sourceCodec

upgradeCodecFactory

private final HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory

headersFactory

private final HttpHeadersFactory headersFactory

trailersFactory

private final HttpHeadersFactory trailersFactory

removeAfterFirstRequest

private final boolean removeAfterFirstRequest

handlingUpgrade

private boolean handlingUpgrade

failedAggregationStart

private boolean failedAggregationStart

Constructor Detail

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory)

Constructs the upgrader with the supported codecs.

The handler instantiated by this constructor will reject an upgrade request with non-empty content. It should not be a concern because an upgrade request is most likely a GET request. If you have a client that sends a non-GET upgrade request, please consider using HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int) to specify the maximum length of the content of an upgrade request.

Parameters:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength)

Constructs the upgrader with the supported codecs.

Parameters:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

maxContentLength - the maximum length of the content of an upgrade request

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength,
                                boolean validateHeaders)

Constructs the upgrader with the supported codecs.

Parameters:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

maxContentLength - the maximum length of the content of an upgrade request

validateHeaders - validate the header names and values of the upgrade response.

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength,
                                HttpHeadersFactory headersFactory,
                                HttpHeadersFactory trailersFactory)

Constructs the upgrader with the supported codecs.

Parameters:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

maxContentLength - the maximum length of the content of an upgrade request

headersFactory - The HttpHeadersFactory to use for headers. The recommended default factory is DefaultHttpHeadersFactory.headersFactory().

trailersFactory - The HttpHeadersFactory to use for trailers. The recommended default factory is DefaultHttpHeadersFactory.trailersFactory().

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength,
                                HttpHeadersFactory headersFactory,
                                HttpHeadersFactory trailersFactory,
                                boolean removeAfterFirstRequest)

Constructs the upgrader with the supported codecs.

Parameters:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

maxContentLength - the maximum length of the content of an upgrade request

headersFactory - The HttpHeadersFactory to use for headers. The recommended default factory is DefaultHttpHeadersFactory.headersFactory().

trailersFactory - The HttpHeadersFactory to use for trailers. The recommended default factory is DefaultHttpHeadersFactory.trailersFactory().

removeAfterFirstRequest - true if the handler should remove itself after the first request was processed (even if it was not an upgrade request), false otherwise.

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
                      HttpObject msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.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:

java.lang.Exception - is thrown if an error occurs

beginAggregation

protected FullHttpMessage beginAggregation(HttpMessage start,
                                           ByteBuf content)
                                    throws java.lang.Exception

Description copied from class: MessageAggregator

Creates a new aggregated message from the specified start message and the specified content. If the start message implements ByteBufHolder, its content is appended to the specified content. This aggregator will continue to append the received content to the specified content.

Overrides:

beginAggregation in class HttpObjectAggregator

Throws:

java.lang.Exception

shouldHandleUpgradeRequest

protected boolean shouldHandleUpgradeRequest(HttpRequest req)

Determines whether the specified upgrade HttpRequest should be handled by this handler or not. This method will be invoked only when the request contains an Upgrade header. It always returns true by default, which means any request with an Upgrade header will be handled. You can override this method to ignore certain Upgrade headers, for example:

{@code

upgrade

private boolean upgrade(ChannelHandlerContext ctx,
                        FullHttpRequest request)

Attempts to upgrade to the protocol(s) identified by the HttpHeaderNames.UPGRADE header (if provided in the request).

Parameters:

ctx - the context for this handler.

request - the HTTP request.

Returns:

true if the upgrade occurred, otherwise false.

createUpgradeResponse

private FullHttpResponse createUpgradeResponse(java.lang.CharSequence upgradeProtocol)

Creates the 101 Switching Protocols response message.

splitHeader

private static java.util.List<java.lang.CharSequence> splitHeader(java.lang.CharSequence header)

Splits a comma-separated header value. The returned set is case-insensitive and contains each part with whitespace removed.