Module io.helidon.nima.websocket.webserver

Package io.helidon.nima.websocket.webserver

Class WsUpgradeProvider

java.lang.Object

io.helidon.nima.websocket.webserver.WsUpgradeProvider

All Implemented Interfaces:

Http1UpgradeProvider

Direct Known Subclasses:

TyrusUpgradeProvider

public class WsUpgradeProvider
extends Object
implements Http1UpgradeProvider

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WsUpgradeProvider.AbstractBuilder<B extends WsUpgradeProvider.AbstractBuilder<B,T>,T>	Abstract Fluent API builder for WsUpgradeProvider and child classes.
static final class	WsUpgradeProvider.Builder	Fluent API builder for WsUpgradeProvider.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	WsUpgradeProvider()	Deprecated. This constructor is only to be used by ServiceLoader, use builder()
protected	WsUpgradeProvider(WsUpgradeProvider.AbstractBuilder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
static WsUpgradeProvider.Builder	builder()	New builder.
Set<String>	configKeys()	Provider's specific configuration node name.
Http1Upgrader	create(Function<String,Config> config)	Creates an instance of HTTP/HTTP/1.1 connection upgrader.
protected Set<String>	origins()

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

HTTP/2 server connection provider configuration node name.

See Also:

• Constant Field Values

Constructor Details

WsUpgradeProvider

protected WsUpgradeProvider(WsUpgradeProvider.AbstractBuilder<?,?> builder)

WsUpgradeProvider

@Deprecated
public WsUpgradeProvider()

Deprecated.

This constructor is only to be used by ServiceLoader, use builder()

Create a new instance with default configuration.

Method Details

builder

public static WsUpgradeProvider.Builder builder()

New builder.

Returns:

builder

configKeys

public Set<String> configKeys()

Description copied from interface: Http1UpgradeProvider

Provider's specific configuration node name.

Specified by:

configKeys in interface Http1UpgradeProvider

Returns:

name of the node to request

create

public Http1Upgrader create(Function<String,Config> config)

Description copied from interface: Http1UpgradeProvider

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

Specified by:

create in interface Http1UpgradeProvider

Parameters:

config - Config configuration function that provides a value for any Http1UpgradeProvider.configKeys()

Returns:

new server HTTP/1.1 connection upgrade selector

origins

protected Set<String> origins()