Module io.helidon.webserver.websocket

Package io.helidon.webserver.websocket

Class WsUpgrader

java.lang.Object

io.helidon.webserver.websocket.WsUpgrader

All Implemented Interfaces:

Http1Upgrader

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 io.helidon.http.HeaderName	EXTENSIONS	Websocket protocol header name.
static final io.helidon.http.HeaderName	PROTOCOL	Websocket protocol header name.
protected static final String	SUPPORTED_VERSION	Supported version.
protected static final io.helidon.http.Header	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 io.helidon.http.HeaderName	WS_KEY	Websocket key header name.
static final io.helidon.http.HeaderName	WS_VERSION	Websocket version header name.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WsUpgrader(WsConfig wsConfig)

Method Summary

Modifier and Type	Method	Description
protected boolean	anyOrigin()
static WsUpgrader	create(WsConfig config)	WebSocket upgrader for HTTP/1.
protected String	hash(ConnectionContext ctx, String wsKey)
protected Set<String>	origins()
String	supportedProtocol()
ServerConnection	upgrade(ConnectionContext ctx, io.helidon.http.HttpPrologue prologue, io.helidon.http.WritableHeaders<?> headers)

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 io.helidon.http.HeaderName WS_KEY

Websocket key header name.

WS_VERSION

public static final io.helidon.http.HeaderName WS_VERSION

Websocket version header name.

PROTOCOL

public static final io.helidon.http.HeaderName PROTOCOL

Websocket protocol header name.

EXTENSIONS

public static final io.helidon.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 io.helidon.http.Header SUPPORTED_VERSION_HEADER

Supported version header.

Constructor Details

WsUpgrader

protected WsUpgrader(WsConfig wsConfig)

Method Details

create

public static WsUpgrader create(WsConfig config)

WebSocket upgrader for HTTP/1.

Parameters:

config - configuration of web socket protocol

Returns:

a new upgrader

supportedProtocol

public String supportedProtocol()

Specified by:

supportedProtocol in interface Http1Upgrader

upgrade

public ServerConnection upgrade(ConnectionContext ctx,
 io.helidon.http.HttpPrologue prologue,
 io.helidon.http.WritableHeaders<?> headers)

Specified by:

upgrade in interface Http1Upgrader

anyOrigin

protected boolean anyOrigin()

origins

protected Set<String> origins()

hash

protected String hash(ConnectionContext ctx,
 String wsKey)