Module io.helidon.webserver.websocket

Package io.helidon.webserver.websocket

Class WebsocketUpgradeCodecProvider

java.lang.Object

io.helidon.webserver.websocket.WebsocketUpgradeCodecProvider

All Implemented Interfaces:

UpgradeCodecProvider

public class WebsocketUpgradeCodecProvider
extends Object
implements UpgradeCodecProvider

Service providing WebSocket upgrade codec for Helidon webserver.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.spi.UpgradeCodecProvider

UpgradeCodecProvider.RoutedUpgrade

Constructor Summary

Constructors

Constructor	Description
WebsocketUpgradeCodecProvider()	Deprecated. Only intended for service loader, do not instantiate

Method Summary

Modifier and Type	Method	Description
CharSequence	clearTextProtocol()	Name of the protocol expected in Upgrade header during HTTP upgrade request for using decoder provided by this supplier.
Optional<UpgradeCodecProvider.RoutedUpgrade>	routedUpgrade(Router router, io.netty.handler.codec.http.HttpRequest request)	Prepare a routed protocol upgrade.
Optional<String>	tlsProtocol()	Name of the protocol expected by ALPN negotiation for using this protocol, prior-knowledge decoder is expected to be used.
io.netty.handler.codec.http.HttpServerUpgradeHandler.UpgradeCodec	upgradeCodec(io.netty.handler.codec.http.HttpServerCodec httpServerCodec, Router router, int maxContentLength)	Codec used by the HttpServerUpgradeHandler when clearTextProtocol() matches.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.webserver.spi.UpgradeCodecProvider

priorKnowledgeDecoder

Constructor Details

WebsocketUpgradeCodecProvider

@Deprecated
public WebsocketUpgradeCodecProvider()

Deprecated.

Only intended for service loader, do not instantiate

Creates a new WebsocketUpgradeCodecProvider.

Method Details

clearTextProtocol

public CharSequence clearTextProtocol()

Description copied from interface: UpgradeCodecProvider

Name of the protocol expected in Upgrade header during HTTP upgrade request for using decoder provided by this supplier.

Specified by:

clearTextProtocol in interface UpgradeCodecProvider

Returns:

protocol name

tlsProtocol

public Optional<String> tlsProtocol()

Description copied from interface: UpgradeCodecProvider

Name of the protocol expected by ALPN negotiation for using this protocol, prior-knowledge decoder is expected to be used.

Specified by:

tlsProtocol in interface UpgradeCodecProvider

Returns:

name of the protocol supported by ALPN or empty optional

upgradeCodec

public io.netty.handler.codec.http.HttpServerUpgradeHandler.UpgradeCodec upgradeCodec(io.netty.handler.codec.http.HttpServerCodec httpServerCodec,
 Router router,
 int maxContentLength)

Description copied from interface: UpgradeCodecProvider

Codec used by the HttpServerUpgradeHandler when clearTextProtocol() matches.

Specified by:

upgradeCodec in interface UpgradeCodecProvider

Parameters:

httpServerCodec - For replacing HttpResponseEncoder and HttpRequestDecoder when using HttpServerUpgradeHandler

router - set of all configured routings

maxContentLength - maximum length of the content of an upgrade request

Returns:

upgrade codec

routedUpgrade

public Optional<UpgradeCodecProvider.RoutedUpgrade> routedUpgrade(Router router,
 io.netty.handler.codec.http.HttpRequest request)

Description copied from interface: UpgradeCodecProvider

Prepare a routed protocol upgrade.

Specified by:

routedUpgrade in interface UpgradeCodecProvider

Parameters:

router - router with configured routings

request - upgrade request

Returns:

routed upgrade, or empty optional to continue as ordinary HTTP