Module io.helidon.webserver.websocket

Package io.helidon.webserver.websocket

Class WsUpgradeProvider

java.lang.Object

io.helidon.webserver.websocket.WsUpgradeProvider

All Implemented Interfaces:

Http1UpgradeProvider<io.helidon.webserver.websocket.WsConfig>

Direct Known Subclasses:

TyrusUpgradeProvider

public class WsUpgradeProvider
extends Object
implements Http1UpgradeProvider<io.helidon.webserver.websocket.WsConfig>

ServiceLoader provider implementation for upgrade from HTTP/1.1 to WebSocket.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONFIG_NAME	WebSocket server connection provider configuration node name.

Constructor Summary

Constructors

Constructor	Description
WsUpgradeProvider()	Deprecated. This constructor is only to be used by ServiceLoader, use WsUpgrader.create(WsConfig) for manual setup

Method Summary

Modifier and Type	Method	Description
Http1Upgrader	create(io.helidon.webserver.websocket.WsConfig config, ProtocolConfigs configs)	Creates an instance of HTTP/HTTP/1.1 connection upgrader.
Class<io.helidon.webserver.websocket.WsConfig>	protocolConfigType()	Type of supported configuration.
String	protocolType()	Provider's type.

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_NAME

protected static final String CONFIG_NAME

WebSocket server connection provider configuration node name.

See Also:

• Constant Field Values

Constructor Details

WsUpgradeProvider

@Deprecated
public WsUpgradeProvider()

Deprecated.

This constructor is only to be used by ServiceLoader, use WsUpgrader.create(WsConfig) for manual setup

Create a new instance with default configuration.

Method Details

protocolType

public String protocolType()

Description copied from interface: Http1UpgradeProvider

Provider's type.

Specified by:

protocolType in interface Http1UpgradeProvider<io.helidon.webserver.websocket.WsConfig>

Returns:

protocol type (also the type expected in configuration)

protocolConfigType

public Class<io.helidon.webserver.websocket.WsConfig> protocolConfigType()

Description copied from interface: Http1UpgradeProvider

Type of supported configuration.

Specified by:

protocolConfigType in interface Http1UpgradeProvider<io.helidon.webserver.websocket.WsConfig>

Returns:

protocol config type

create

public Http1Upgrader create(io.helidon.webserver.websocket.WsConfig config,
 ProtocolConfigs configs)

Description copied from interface: Http1UpgradeProvider

Creates an instance of HTTP/HTTP/1.1 connection upgrader.

Specified by:

create in interface Http1UpgradeProvider<io.helidon.webserver.websocket.WsConfig>

Parameters:

config - configuration of this protocol

configs - configuration for possible nested protocols

Returns:

new server HTTP/1.1 connection upgrade selector