Module io.helidon.nima.websocket.webserver

Package io.helidon.nima.websocket.webserver

Class WsUpgrader

java.lang.Object

io.helidon.nima.websocket.webserver.WsUpgrader

All Implemented Interfaces:

Http1Upgrader

Direct Known Subclasses:

TyrusUpgrader

public class WsUpgrader
extends Object
implements Http1Upgrader

Http1Upgrader implementation to upgrade from HTTP/1.1 to WebSocket.

Field Summary

Fields

Modifier and Type	Field	Description
static final Http.HeaderName	EXTENSIONS	Websocket protocol header name.
static final Http.HeaderName	PROTOCOL	Websocket protocol header name.
protected static final String	SUPPORTED_VERSION	Supported version.
protected static final Http.HeaderValue	SUPPORTED_VERSION_HEADER	Supported version header.
protected static final String	SWITCHING_PROTOCOL_PREFIX	Switching response prefix.
protected static final String	SWITCHING_PROTOCOLS_SUFFIX	Switching response suffix.
static final Http.HeaderName	WS_KEY	Websocket key header name.
static final Http.HeaderName	WS_VERSION	Websocket version header name.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WsUpgrader(Set<String> origins)

Method Summary

Modifier and Type	Method	Description
protected boolean	anyOrigin()
protected String	hash(ConnectionContext ctx, String wsKey)
protected Set<String>	origins()
String	supportedProtocol()	Expected value of the protocol upgrade, such as h2c, or websocket.
ServerConnection	upgrade(ConnectionContext ctx, HttpPrologue prologue, WritableHeaders<?> headers)	Upgrade connection.

Methods inherited from class java.lang.Object

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

Field Details

WS_KEY

public static final Http.HeaderName WS_KEY

Websocket key header name.

WS_VERSION

public static final Http.HeaderName WS_VERSION

Websocket version header name.

PROTOCOL

public static final Http.HeaderName PROTOCOL

Websocket protocol header name.

EXTENSIONS

public static final Http.HeaderName EXTENSIONS

Websocket protocol header name.

SWITCHING_PROTOCOL_PREFIX

protected static final String SWITCHING_PROTOCOL_PREFIX

Switching response prefix.

See Also:

• Constant Field Values

SWITCHING_PROTOCOLS_SUFFIX

protected static final String SWITCHING_PROTOCOLS_SUFFIX

Switching response suffix.

See Also:

• Constant Field Values

SUPPORTED_VERSION

protected static final String SUPPORTED_VERSION

Supported version.

See Also:

• Constant Field Values

SUPPORTED_VERSION_HEADER

protected static final Http.HeaderValue SUPPORTED_VERSION_HEADER

Supported version header.

Constructor Details

WsUpgrader

protected WsUpgrader(Set<String> origins)

Method Details

supportedProtocol

public String supportedProtocol()

Description copied from interface: Http1Upgrader

Expected value of the protocol upgrade, such as h2c, or websocket. If an implementation supports multiple protocols, please implement this selector for each protocol

Specified by:

supportedProtocol in interface Http1Upgrader

Returns:

supported protocol

upgrade

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

Description copied from interface: Http1Upgrader

Upgrade connection.

Specified by:

upgrade in interface Http1Upgrader

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

anyOrigin

protected boolean anyOrigin()

origins

protected Set<String> origins()

hash

protected String hash(ConnectionContext ctx,
 String wsKey)