Class WsConfig.BuilderBase.WsConfigImpl

java.lang.Object

io.helidon.websocket.WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

io.helidon.webserver.websocket.WsConfig.BuilderBase.WsConfigImpl

All Implemented Interfaces:

Prototype.Api, NamedService, ProtocolConfig, WsConfig, WsProtocolConfig

Enclosing class:

WsConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>

protected static class WsConfig.BuilderBase.WsConfigImpl
extends WsProtocolConfig.BuilderBase.WsProtocolConfigImpl
implements WsConfig

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface WsConfig

WsConfig.Builder, WsConfig.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	WsConfig.Builder	Fluent API builder for WsConfig.
static class	WsConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>	Fluent API builder base for WsConfig.

Nested classes/interfaces inherited from interface WsProtocolConfig

WsProtocolConfig.Builder, WsProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	WsProtocolConfig.Builder	Fluent API builder for WsProtocolConfig.
static class	WsProtocolConfig.BuilderBase<BUILDER extends WsProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsProtocolConfig>	Fluent API builder base for WsProtocolConfig.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WsConfigImpl(WsConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
int	maxFrameLength()	Max WebSocket frame size supported by the server on a read operation.
String	name()	Name of this configuration.
Set<String>	origins()	WebSocket origins.
String	toString()

Methods inherited from class WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

maxBufferedMessageSize

Modifier and Type	Method	Description
Size	maxBufferedMessageSize()	Maximum size of a WebSocket message buffered for delivery to a listener.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ProtocolConfig

enabled, transportBindingTypes

Modifier and Type	Method	Description
default boolean	enabled()	Whether this protocol configuration is enabled.
default Set<String>	transportBindingTypes()	Transport binding provider keys compatible with this protocol.

Methods inherited from interface WsConfig

type

Modifier and Type	Method	Description
default String	type()	Protocol configuration type.

Constructor Details

WsConfigImpl

protected WsConfigImpl(WsConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

origins

public Set<String> origins()

Description copied from interface: WsConfig

WebSocket origins. If this set is empty, requests with an Origin header must match the request Host header authority. If this set is non-empty, it acts as an explicit allowlist. Requests without an Origin header are allowed.

Specified by:

origins in interface WsConfig

Returns:

origins

name

public String name()

Description copied from interface: WsConfig

Name of this configuration.

Specified by:

name in interface NamedService

Specified by:

name in interface WsConfig

Returns:

configuration name

maxFrameLength

public int maxFrameLength()

Description copied from interface: WsConfig

Max WebSocket frame size supported by the server on a read operation. Default is 1 MiB.

Specified by:

maxFrameLength in interface WsConfig

Returns:

max frame size to read

toString

public String toString()

Overrides:

toString in class WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

equals

public boolean equals(Object o)

Overrides:

equals in class WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

hashCode

public int hashCode()

Overrides:

hashCode in class WsProtocolConfig.BuilderBase.WsProtocolConfigImpl