io.netty.handler.codec.http2

Class Http2ServerUpgradeCodec

java.lang.Object

io.netty.handler.codec.http2.Http2ServerUpgradeCodec

All Implemented Interfaces:

HttpServerUpgradeHandler.UpgradeCodec

public class Http2ServerUpgradeCodec
extends Object
implements HttpServerUpgradeHandler.UpgradeCodec

Server-side codec for performing a cleartext upgrade from HTTP/1.x to HTTP/2.

Constructor Summary

Constructors

Constructor and Description
Http2ServerUpgradeCodec(Http2ConnectionHandler connectionHandler) Creates the codec using a default name for the connection handler when adding to the pipeline.
Http2ServerUpgradeCodec(String handlerName, Http2ConnectionHandler connectionHandler) Creates the codec providing an upgrade to the given handler for HTTP/2.

Method Summary

Methods

Modifier and Type	Method and Description
void	prepareUpgradeResponse(ChannelHandlerContext ctx, FullHttpRequest upgradeRequest, FullHttpResponse upgradeResponse) Adds any headers to the 101 Switching protocols response that are appropriate for this protocol.
String	protocol() Returns the name of the protocol supported by this codec, as indicated by the HttpHeaderNames.UPGRADE header.
Collection<String>	requiredUpgradeHeaders() Gets all protocol-specific headers required by this protocol for a successful upgrade.
void	upgradeTo(ChannelHandlerContext ctx, FullHttpRequest upgradeRequest, FullHttpResponse upgradeResponse) Performs an HTTP protocol upgrade from the source codec.

Methods inherited from class java.lang.Object

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

Constructor Detail

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(Http2ConnectionHandler connectionHandler)

Creates the codec using a default name for the connection handler when adding to the pipeline.

Parameters:

connectionHandler - the HTTP/2 connection handler.

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(String handlerName,
                       Http2ConnectionHandler connectionHandler)

Creates the codec providing an upgrade to the given handler for HTTP/2.

Parameters:

handlerName - the name of the HTTP/2 connection handler to be used in the pipeline.

connectionHandler - the HTTP/2 connection handler.

Method Detail

protocol

public String protocol()

Description copied from interface: HttpServerUpgradeHandler.UpgradeCodec

Returns the name of the protocol supported by this codec, as indicated by the HttpHeaderNames.UPGRADE header.

Specified by:

protocol in interface HttpServerUpgradeHandler.UpgradeCodec

requiredUpgradeHeaders

public Collection<String> requiredUpgradeHeaders()

Description copied from interface: HttpServerUpgradeHandler.UpgradeCodec

Gets all protocol-specific headers required by this protocol for a successful upgrade. Any supplied header will be required to appear in the HttpHeaderNames.CONNECTION header as well.

Specified by:

requiredUpgradeHeaders in interface HttpServerUpgradeHandler.UpgradeCodec

prepareUpgradeResponse

public void prepareUpgradeResponse(ChannelHandlerContext ctx,
                          FullHttpRequest upgradeRequest,
                          FullHttpResponse upgradeResponse)

Description copied from interface: HttpServerUpgradeHandler.UpgradeCodec

Adds any headers to the 101 Switching protocols response that are appropriate for this protocol.

Specified by:

prepareUpgradeResponse in interface HttpServerUpgradeHandler.UpgradeCodec

upgradeTo

public void upgradeTo(ChannelHandlerContext ctx,
             FullHttpRequest upgradeRequest,
             FullHttpResponse upgradeResponse)

Description copied from interface: HttpServerUpgradeHandler.UpgradeCodec

Performs an HTTP protocol upgrade from the source codec. This method is responsible for adding all handlers required for the new protocol.

Specified by:

upgradeTo in interface HttpServerUpgradeHandler.UpgradeCodec

Parameters:

ctx - the context for the current handler.

upgradeRequest - the request that triggered the upgrade to this protocol. The upgraded protocol is responsible for sending the response.

upgradeResponse - a 101 Switching Protocols response that is populated with the HttpHeaderNames.CONNECTION and HttpHeaderNames.UPGRADE headers. The protocol is required to send this before sending any other frames back to the client. The headers may be augmented as necessary by the protocol before sending.