Package io.helidon.webserver.websocket
Class WsConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WsConfig>
java.lang.Object
io.helidon.webserver.websocket.WsConfig.BuilderBase<BUILDER,PROTOTYPE>
- Type Parameters:
BUILDER
- type of the builder extending this abstract builderPROTOTYPE
- type of the prototype interface that would be built byPrototype.Builder.buildPrototype()
- All Implemented Interfaces:
Prototype.Builder<BUILDER,
,PROTOTYPE> Prototype.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 Object
implements Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for
WsConfig
.-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
Generated implementation of the prototype, can be extended by descendant prototype implementations. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionWebSocket origins.addOrigins
(Set<? extends String> origins) WebSocket origins.config()
If this instance was configured, this would be the config instance used.Update builder from configuration (node of this type).Update this builder from an existing prototype instance.from
(WsConfig.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.int
Max WebSocket frame size supported by the server on a read operation.maxFrameLength
(int maxFrameLength) Max WebSocket frame size supported by the server on a read operation.name()
Name of this configuration.Name of this configuration.origins()
WebSocket origins.WebSocket origins.protected void
Handles providers and decorators.toString()
protected void
Validates required properties.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
Methods inherited from interface io.helidon.builder.api.Prototype.ConfiguredBuilder
discoverService, discoverServices
-
Constructor Details
-
BuilderBase
protected BuilderBase()Protected to support extensibility.
-
-
Method Details
-
from
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
Update this builder from an existing prototype builder instance.- Parameters:
builder
- existing builder prototype to update this builder from- Returns:
- updated builder instance
-
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 interfacePrototype.ConfiguredBuilder<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
-
origins
WebSocket origins.- Parameters:
origins
- origins- Returns:
- updated builder instance
- See Also:
-
addOrigins
WebSocket origins.- Parameters:
origins
- origins- Returns:
- updated builder instance
- See Also:
-
addOrigin
WebSocket origins.- Parameters:
origin
- origins- Returns:
- updated builder instance
- See Also:
-
name
Name of this configuration.- Parameters:
name
- configuration name- Returns:
- updated builder instance
- See Also:
-
maxFrameLength
Max WebSocket frame size supported by the server on a read operation. Default is 1 MB.- Parameters:
maxFrameLength
- max frame size to read- Returns:
- updated builder instance
- See Also:
-
origins
WebSocket origins.- Returns:
- the origins
-
name
Name of this configuration.- Returns:
- the name
-
maxFrameLength
public int maxFrameLength()Max WebSocket frame size supported by the server on a read operation. Default is 1 MB.- Returns:
- the max frame length
-
config
If this instance was configured, this would be the config instance used.- Returns:
- config node used to configure this builder, or empty if not configured
-
toString
-
preBuildPrototype
protected void preBuildPrototype()Handles providers and decorators. -
validatePrototype
protected void validatePrototype()Validates required properties.
-