io.netty.handler.codec.http2

Class Http2ServerUpgradeCodec

java.lang.Object

io.netty.handler.codec.http2.Http2ServerUpgradeCodec

All Implemented Interfaces:

HttpServerUpgradeHandler.UpgradeCodec

@UnstableApi
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(Http2Codec http2Codec) Creates the codec using a default name for the connection handler when adding to the pipeline.
Http2ServerUpgradeCodec(Http2ConnectionHandler connectionHandler) Creates the codec using a default name for the connection handler when adding to the pipeline.
Http2ServerUpgradeCodec(String handlerName, Http2Codec http2Codec) Creates the codec providing an upgrade to the given handler for HTTP/2.
Http2ServerUpgradeCodec(String handlerName, Http2ConnectionHandler connectionHandler) Creates the codec providing an upgrade to the given handler for HTTP/2.

Method Summary

Modifier and Type	Method and Description
boolean	prepareUpgradeResponse(ChannelHandlerContext ctx, FullHttpRequest upgradeRequest, HttpHeaders headers) Prepares the upgradeHeaders for a protocol update based upon the contents of upgradeRequest.
Collection<CharSequence>	requiredUpgradeHeaders() Gets all protocol-specific headers required by this protocol for a successful upgrade.
void	upgradeTo(ChannelHandlerContext ctx, FullHttpRequest upgradeRequest) 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(Http2Codec http2Codec)

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

Parameters:

http2Codec - the HTTP/2 multiplexing 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, or null to auto-generate the name

connectionHandler - the HTTP/2 connection handler

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(String handlerName,
                               Http2Codec http2Codec)

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.

http2Codec - the HTTP/2 multiplexing handler.

Method Detail

requiredUpgradeHeaders

public Collection<CharSequence> 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 boolean prepareUpgradeResponse(ChannelHandlerContext ctx,
                                      FullHttpRequest upgradeRequest,
                                      HttpHeaders headers)

Description copied from interface: HttpServerUpgradeHandler.UpgradeCodec

Prepares the upgradeHeaders for a protocol update based upon the contents of upgradeRequest. This method returns a boolean value to proceed or abort the upgrade in progress. If false is returned, the upgrade is aborted and the upgradeRequest will be passed through the inbound pipeline as if no upgrade was performed. If true is returned, the upgrade will proceed to the next step which invokes HttpServerUpgradeHandler.UpgradeCodec.upgradeTo(io.netty.channel.ChannelHandlerContext, io.netty.handler.codec.http.FullHttpRequest). When returning true, you can add headers to the upgradeHeaders so that they are added to the 101 Switching protocols response.

Specified by:

prepareUpgradeResponse in interface HttpServerUpgradeHandler.UpgradeCodec

upgradeTo

public void upgradeTo(ChannelHandlerContext ctx,
                      FullHttpRequest upgradeRequest)

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.