Module io.helidon.webclient.websocket

Package io.helidon.webclient.websocket

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

java.lang.Object

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

io.helidon.webclient.websocket.WsClientProtocolConfig.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>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

WsClientProtocolConfig.Builder

Enclosing interface:

WsClientProtocolConfig

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

Fluent API builder base for WsClientProtocolConfig.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class io.helidon.websocket.WsProtocolConfig.BuilderBase

WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BUILDER	addSubProtocol(String subProtocol)	WebSocket sub-protocols requested by the client.
BUILDER	addSubProtocols(List<String> subProtocols)	WebSocket sub-protocols requested by the client.
BUILDER	clearSubProtocols()	Clear all subProtocols.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(WsClientProtocolConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(WsClientProtocolConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Size	maxFrameSize()	Maximum WebSocket frame payload size accepted by the client, from 1 B through Integer.MAX_VALUE bytes; the default is 1 MiB, replacing the earlier effectively unbounded behavior, and exceeding the configured limit causes the client to close the connection with status code 1009 (Message Too Big).
BUILDER	maxFrameSize(Size maxFrameSize)	Maximum WebSocket frame payload size accepted by the client, from 1 B through Integer.MAX_VALUE bytes; the default is 1 MiB, replacing the earlier effectively unbounded behavior, and exceeding the configured limit causes the client to close the connection with status code 1009 (Message Too Big).
String	name()	Name of this protocol configuration.
BUILDER	name(String name)	Name of this protocol configuration.
protected void	preBuildPrototype()	Handles providers and decorators.
List<String>	subProtocols()	WebSocket sub-protocols requested by the client.
BUILDER	subProtocols(List<String> subProtocols)	WebSocket sub-protocols requested by the client.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.websocket.WsProtocolConfig.BuilderBase

config, from, from, maxBufferedMessageSize, maxBufferedMessageSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(WsClientProtocolConfig 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(WsClientProtocolConfig.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

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.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 WsClientProtocolConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsClientProtocolConfig>

Overrides:

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

Parameters:

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

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 WsClientProtocolConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsClientProtocolConfig>

Overrides:

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

Parameters:

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

Returns:

updated builder instance

name

public BUILDER name(String name)

Name of this protocol configuration.

Parameters:

name - protocol configuration name

Returns:

updated builder instance

See Also:

• name()

clearSubProtocols

public BUILDER clearSubProtocols()

Clear all subProtocols.

Returns:

updated builder instance

See Also:

• subProtocols()

subProtocols

public BUILDER subProtocols(List<String> subProtocols)

WebSocket sub-protocols requested by the client.

Parameters:

subProtocols - requested WebSocket sub-protocols

Returns:

updated builder instance

See Also:

• subProtocols()

addSubProtocols

public BUILDER addSubProtocols(List<String> subProtocols)

WebSocket sub-protocols requested by the client.

Parameters:

subProtocols - requested WebSocket sub-protocols

Returns:

updated builder instance

See Also:

• subProtocols()

addSubProtocol

public BUILDER addSubProtocol(String subProtocol)

WebSocket sub-protocols requested by the client.

Parameters:

subProtocol - add single requested WebSocket sub-protocols

Returns:

updated builder instance

See Also:

• subProtocols()

maxFrameSize

public BUILDER maxFrameSize(Size maxFrameSize)

Maximum WebSocket frame payload size accepted by the client, from 1 B through Integer.MAX_VALUE bytes; the default is 1 MiB, replacing the earlier effectively unbounded behavior, and exceeding the configured limit causes the client to close the connection with status code 1009 (Message Too Big).

Parameters:

maxFrameSize - maximum frame payload size

Returns:

updated builder instance

See Also:

• maxFrameSize()

name

public String name()

Name of this protocol configuration.

Returns:

protocol configuration name

subProtocols

public List<String> subProtocols()

WebSocket sub-protocols requested by the client.

Returns:

requested WebSocket sub-protocols

maxFrameSize

public Size maxFrameSize()

Maximum WebSocket frame payload size accepted by the client, from 1 B through Integer.MAX_VALUE bytes; the default is 1 MiB, replacing the earlier effectively unbounded behavior, and exceeding the configured limit causes the client to close the connection with status code 1009 (Message Too Big).

Returns:

maximum frame payload size

toString

public String toString()

Overrides:

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

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

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

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

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