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

java.lang.Object

io.helidon.websocket.WsProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>

io.helidon.webserver.websocket.WsConfig.BuilderBase<BUILDER, PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER, PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Direct Known Subclasses:

WsConfig.Builder

Enclosing interface:

WsConfig

public abstract static class WsConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>
extends WsProtocolConfig.BuilderBase<BUILDER, PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Fluent API builder base for WsConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WsConfig.BuilderBase.WsConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class WsProtocolConfig.BuilderBase

WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

Modifier and Type	Class	Description
protected static class	WsProtocolConfig.BuilderBase.WsProtocolConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addOrigin(String origin)	WebSocket origins.
BUILDER	addOrigins(Set<String> origins)	WebSocket origins.
BUILDER	clearOrigins()	Clear all origins.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(WsConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(WsConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
int	maxFrameLength()	Max WebSocket frame size supported by the server on a read operation.
BUILDER	maxFrameLength(int maxFrameLength)	Max WebSocket frame size supported by the server on a read operation.
String	name()	Name of this configuration.
BUILDER	name(String name)	Name of this configuration.
Set<String>	origins()	WebSocket origins.
BUILDER	origins(Set<String> origins)	WebSocket origins.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class WsProtocolConfig.BuilderBase

config, from, from, maxBufferedMessageSize, maxBufferedMessageSize

Modifier and Type	Method	Description
protected Optional<Config>	config()	Configuration used to configure this instance.
BUILDER	from(WsProtocolConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(WsProtocolConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Size	maxBufferedMessageSize()	Maximum size of a WebSocket message buffered for delivery to a listener.
BUILDER	maxBufferedMessageSize(Size maxBufferedMessageSize)	Maximum size of a WebSocket message buffered for delivery to a listener.

Methods inherited from class Object

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

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(WsConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(WsConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>

Overrides:

config in class WsProtocolConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

clearOrigins

public BUILDER clearOrigins()

Clear all origins.

Returns:

updated builder instance

See Also:

• origins()

origins

public BUILDER origins(Set<String> origins)

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.

Parameters:

origins - origins

Returns:

updated builder instance

See Also:

• origins()

addOrigins

public BUILDER addOrigins(Set<String> origins)

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.

Parameters:

origins - origins

Returns:

updated builder instance

See Also:

• origins()

addOrigin

public BUILDER addOrigin(String origin)

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.

Parameters:

origin - add single origins

Returns:

updated builder instance

See Also:

• origins()

name

public BUILDER name(String name)

Name of this configuration.

Parameters:

name - configuration name

Returns:

updated builder instance

See Also:

• name()

maxFrameLength

public BUILDER maxFrameLength(int maxFrameLength)

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

Parameters:

maxFrameLength - max frame size to read

Returns:

updated builder instance

See Also:

• maxFrameLength()

origins

public Set<String> origins()

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.

Returns:

origins

name

public String name()

Name of this configuration.

Returns:

configuration name

maxFrameLength

public int maxFrameLength()

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

Returns:

max frame size to read

toString

public String toString()

Overrides:

toString in class WsProtocolConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class WsProtocolConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class WsProtocolConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>