Module io.helidon.microprofile.tyrus

Package io.helidon.microprofile.tyrus

Class TyrusUpgrader

java.lang.Object

io.helidon.webserver.websocket.WsUpgrader

io.helidon.microprofile.tyrus.TyrusUpgrader

All Implemented Interfaces:

Http1RoutedUpgrader, Http1Upgrader

public class TyrusUpgrader
extends WsUpgrader
implements Http1RoutedUpgrader

Tyrus connection upgrade provider.

Field Summary

Fields inherited from class io.helidon.webserver.websocket.WsUpgrader

EXTENSIONS, PROTOCOL, SUPPORTED_VERSION, SUPPORTED_VERSION_HEADER, SWITCHING_PROTOCOL_PREFIX, SWITCHING_PROTOCOLS_SUFFIX, WS_KEY, WS_VERSION

Method Summary

Modifier and Type	Method	Description
static TyrusUpgrader	create(WsConfig config)	Create a new configured instance of Tyrus upgrader.
protected Set<String>	origins()
Optional<Http1RoutedUpgrade>	routedUpgrade(ConnectionContext ctx, HttpPrologue prologue, WritableHeaders<?> headers)	Prepare an upgrade that should run through HTTP routing filters and route policies before the protocol switch is completed.
ServerConnection	upgrade(ConnectionContext ctx, HttpPrologue prologue, WritableHeaders<?> headers)	Upgrade connection.

Methods inherited from class io.helidon.webserver.websocket.WsUpgrader

anyOrigin, hash, isWebSocketUpgrade, supportedProtocol, validateOrigin

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.http1.spi.Http1Upgrader

supportedProtocol

Method Details

create

public static TyrusUpgrader create(WsConfig config)

Create a new configured instance of Tyrus upgrader.

Parameters:

config - configuration of WebSocket

Returns:

a new HTTP/1 upgrader

upgrade

public ServerConnection upgrade(ConnectionContext ctx,
 HttpPrologue prologue,
 WritableHeaders<?> headers)

Description copied from interface: Http1Upgrader

Upgrade connection.

Specified by:

upgrade in interface Http1Upgrader

Overrides:

upgrade in class WsUpgrader

Parameters:

ctx - connection context

prologue - http prologue of the upgrade request

headers - http headers of the upgrade request

Returns:

a new connection to use instead of the original Http1Connection, or null if the connection cannot be upgraded

routedUpgrade

public Optional<Http1RoutedUpgrade> routedUpgrade(ConnectionContext ctx,
 HttpPrologue prologue,
 WritableHeaders<?> headers)

Description copied from interface: Http1RoutedUpgrader

Prepare an upgrade that should run through HTTP routing filters and route policies before the protocol switch is completed.

Specified by:

routedUpgrade in interface Http1RoutedUpgrader

Parameters:

ctx - connection context

prologue - http prologue of the upgrade request

headers - http headers of the upgrade request

Returns:

prepared routed upgrade, or an empty optional to continue with ordinary HTTP routing

origins

protected Set<String> origins()

Overrides:

origins in class WsUpgrader