Class WsConfig.Builder

java.lang.Object

io.helidon.websocket.WsProtocolConfig.BuilderBase<WsConfig.Builder, WsConfig>

io.helidon.webserver.websocket.WsConfig.BuilderBase<WsConfig.Builder, WsConfig>

io.helidon.webserver.websocket.WsConfig.Builder

All Implemented Interfaces:

Prototype.Builder<WsConfig.Builder, WsConfig>, Builder<WsConfig.Builder, WsConfig>, ConfigBuilderSupport.ConfiguredBuilder<WsConfig.Builder, WsConfig>, Supplier<WsConfig>

Enclosing interface:

WsConfig

public static class WsConfig.Builder
extends WsConfig.BuilderBase<WsConfig.Builder, WsConfig>
implements Builder<WsConfig.Builder, WsConfig>

Fluent API builder for WsConfig.

Nested Class Summary

Nested classes/interfaces inherited from class WsConfig.BuilderBase

WsConfig.BuilderBase.WsConfigImpl

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.

Method Summary

Modifier and Type	Method	Description
WsConfig	build()	Create an instance from this builder.
WsConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class WsConfig.BuilderBase

addOrigin, addOrigins, clearOrigins, config, from, from, maxFrameLength, maxFrameLength, name, name, origins, origins, preBuildPrototype, toString, validatePrototype

Modifier and Type	Method	Description
WsConfig.Builder	addOrigin(String origin)	WebSocket origins.
WsConfig.Builder	addOrigins(Set<String> origins)	WebSocket origins.
WsConfig.Builder	clearOrigins()	Clear all origins.
WsConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
WsConfig.Builder	from(WsConfig prototype)	Update this builder from an existing prototype instance.
WsConfig.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.
WsConfig.Builder	maxFrameLength(int maxFrameLength)	Max WebSocket frame size supported by the server on a read operation.
String	name()	Name of this configuration.
WsConfig.Builder	name(String name)	Name of this configuration.
Set<String>	origins()	WebSocket origins.
WsConfig.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.
WsConfig.Builder	from(WsProtocolConfig prototype)	Update this builder from an existing prototype instance.
WsConfig.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.
WsConfig.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 Builder

get, identity, update

Modifier and Type	Method	Description
default WsConfig	get()
default WsConfig.Builder	identity()	Instance of this builder as the correct type.
default WsConfig.Builder	update(Consumer<WsConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default WsConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public WsConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<WsConfig.Builder, WsConfig>

Returns:

an instance of the setup object created from this builder

build

public WsConfig build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<WsConfig.Builder, WsConfig>

Returns:

instance of the built type