Module io.helidon.webserver

Package io.helidon.webserver

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

java.lang.Object

io.helidon.webserver.ListenerConfig.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webserver.WebServerConfig.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:

WebServerConfig.Builder

Enclosing interface:

WebServerConfig

public abstract static class WebServerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>
extends ListenerConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for WebServer.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class io.helidon.webserver.ListenerConfig.BuilderBase

ListenerConfig.BuilderBase.ListenerConfigImpl

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BUILDER	addFeature(ServerFeature feature)	Server features allow customization of the server, listeners, or routings.
BUILDER	addFeatures(List<? extends ServerFeature> features)	Server features allow customization of the server, listeners, or routings.
BUILDER	addSockets(Map<String,? extends ListenerConfig> sockets)	Socket configurations.
BUILDER	clearServerContext()	Clear existing value of this property.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
List<ServerFeature>	features()	Server features allow customization of the server, listeners, or routings.
BUILDER	features(List<? extends ServerFeature> features)	Server features allow customization of the server, listeners, or routings.
BUILDER	featuresDiscoverServices(boolean discoverServices)	Server features allow customization of the server, listeners, or routings.
BUILDER	from(WebServerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(WebServerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
BUILDER	putSocket(String key, ListenerConfig socket)	Socket configurations.
BUILDER	putSocket(String key, Consumer<ListenerConfig.Builder> consumer)	Socket configurations.
BUILDER	routing(String socket, HttpRouting.Builder routing)	Add Http routing for an additional socket.
BUILDER	routing(String socket, Consumer<HttpRouting.Builder> consumer)	Add Http routing for an additional socket.
Optional<Context>	serverContext()	Context for the WebServer, if none defined, a new one will be created with global context as the root.
BUILDER	serverContext(Context serverContext)	Context for the WebServer, if none defined, a new one will be created with global context as the root.
BUILDER	serverContext(Consumer<Context.Builder> consumer)	Context for the WebServer, if none defined, a new one will be created with global context as the root.
boolean	shutdownHook()	When true the webserver registers a shutdown hook with the JVM Runtime.
BUILDER	shutdownHook(boolean shutdownHook)	When true the webserver registers a shutdown hook with the JVM Runtime.
Map<String,ListenerConfig>	sockets()	Socket configurations.
BUILDER	sockets(Map<String,? extends ListenerConfig> sockets)	Socket configurations.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.webserver.ListenerConfig.BuilderBase

addConnectionSelector, addConnectionSelectors, addListenerSocketOptions, addProtocol, addProtocols, address, address, addRouting, addRoutings, backlog, backlog, clearConcurrencyLimit, clearConnectionConfig, clearContentEncoding, clearDirectHandlers, clearListenerContext, clearMediaContext, clearReceiveBufferSize, clearRequestedUriDiscoveryContext, clearRouting, clearTls, concurrencyLimit, concurrencyLimit, connectionConfig, connectionConfig, connectionConfig, connectionOptions, connectionOptions, connectionOptions, connectionOptions, connectionSelectors, connectionSelectors, contentEncoding, contentEncoding, contentEncoding, contentEncoding, directHandlers, directHandlers, directHandlers, enableProxyProtocol, enableProxyProtocol, errorHandling, errorHandling, errorHandling, errorHandling, from, from, host, host, idleConnectionPeriod, idleConnectionPeriod, idleConnectionTimeout, idleConnectionTimeout, ignoreInvalidNamedRouting, ignoreInvalidNamedRouting, listenerContext, listenerContext, listenerContext, listenerSocketOptions, listenerSocketOptions, maxConcurrentRequests, maxConcurrentRequests, maxInMemoryEntity, maxInMemoryEntity, maxPayloadSize, maxPayloadSize, maxTcpConnections, maxTcpConnections, mediaContext, mediaContext, mediaContext, mediaContext, name, name, port, port, protocols, protocols, protocolsDiscoverServices, putListenerSocketOption, receiveBufferSize, receiveBufferSize, requestedUriDiscoveryContext, requestedUriDiscoveryContext, requestedUriDiscoveryContext, restoreResponseHeaders, restoreResponseHeaders, routing, routing, routing, routings, routings, shutdownGracePeriod, shutdownGracePeriod, smartAsyncWrites, smartAsyncWrites, tls, tls, tls, tls, writeBufferSize, writeBufferSize, writeQueueLength, writeQueueLength

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(WebServerConfig 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(WebServerConfig.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

routing

public BUILDER routing(String socket,
 Consumer<HttpRouting.Builder> consumer)

Add Http routing for an additional socket.

Parameters:

socket - name of the socket

consumer - HTTP Routing for the given socket name

Returns:

updated builder instance

routing

public BUILDER routing(String socket,
 HttpRouting.Builder routing)

Add Http routing for an additional socket.

Parameters:

socket - name of the socket

routing - HTTP Routing for the given socket name

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

Overrides:

config in class ListenerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>

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

Overrides:

config in class ListenerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>

Parameters:

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

Returns:

updated builder instance

shutdownHook

public BUILDER shutdownHook(boolean shutdownHook)

When true the webserver registers a shutdown hook with the JVM Runtime.

Defaults to true. Set this to false such that a shutdown hook is not registered.

Parameters:

shutdownHook - whether to register a shutdown hook

Returns:

updated builder instance

See Also:

• shutdownHook()

sockets

public BUILDER sockets(Map<String,? extends ListenerConfig> sockets)

Socket configurations. Note that socket named "@default" cannot be used, configure the values on the server directly. This method replaces all values with the new ones.

Parameters:

sockets - map of listener configurations, except for the default one

Returns:

updated builder instance

See Also:

• sockets()

addSockets

public BUILDER addSockets(Map<String,? extends ListenerConfig> sockets)

Socket configurations. Note that socket named "@default" cannot be used, configure the values on the server directly. This method keeps existing values, then puts all new values into the map.

Parameters:

sockets - map of listener configurations, except for the default one

Returns:

updated builder instance

See Also:

• sockets()

putSocket

public BUILDER putSocket(String key,
 ListenerConfig socket)

Socket configurations. Note that socket named "@default" cannot be used, configure the values on the server directly. This method adds a new value to the map, or replaces it if the key already exists.

Parameters:

key - key to add or replace

socket - new value for the key

Returns:

updated builder instance

See Also:

• sockets()

putSocket

public BUILDER putSocket(String key,
 Consumer<ListenerConfig.Builder> consumer)

Socket configurations. Note that socket named "@default" cannot be used, configure the values on the server directly. This method adds a new value to the map, or replaces it if the key already exists.

Parameters:

key - key to add or replace

consumer - builder consumer to create new value for the key

Returns:

updated builder instance

See Also:

• sockets()

featuresDiscoverServices

public BUILDER featuresDiscoverServices(boolean discoverServices)

Server features allow customization of the server, listeners, or routings.

Parameters:

discoverServices - whether to discover implementations through service loader

Returns:

updated builder instance

See Also:

• features()

features

public BUILDER features(List<? extends ServerFeature> features)

Server features allow customization of the server, listeners, or routings.

Parameters:

features - server features

Returns:

updated builder instance

See Also:

• features()

addFeatures

public BUILDER addFeatures(List<? extends ServerFeature> features)

Server features allow customization of the server, listeners, or routings.

Parameters:

features - server features

Returns:

updated builder instance

See Also:

• features()

addFeature

public BUILDER addFeature(ServerFeature feature)

Server features allow customization of the server, listeners, or routings.

Parameters:

feature - server features

Returns:

updated builder instance

See Also:

• features()

clearServerContext

public BUILDER clearServerContext()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• serverContext()

serverContext

public BUILDER serverContext(Context serverContext)

Context for the WebServer, if none defined, a new one will be created with global context as the root.

Parameters:

serverContext - server context

Returns:

updated builder instance

See Also:

• serverContext()

serverContext

public BUILDER serverContext(Consumer<Context.Builder> consumer)

Context for the WebServer, if none defined, a new one will be created with global context as the root.

Parameters:

consumer - server context

Returns:

updated builder instance

See Also:

• serverContext()

shutdownHook

public boolean shutdownHook()

When true the webserver registers a shutdown hook with the JVM Runtime.

Defaults to true. Set this to false such that a shutdown hook is not registered.

Returns:

the shutdown hook

sockets

public Map<String,ListenerConfig> sockets()

Socket configurations. Note that socket named "@default" cannot be used, configure the values on the server directly.

Returns:

the sockets

features

public List<ServerFeature> features()

Server features allow customization of the server, listeners, or routings.

Returns:

the features

serverContext

public Optional<Context> serverContext()

Context for the WebServer, if none defined, a new one will be created with global context as the root.

Returns:

the server context

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Overrides:

config in class ListenerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class ListenerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class ListenerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class ListenerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends WebServerConfig>