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>

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

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 ListenerConfig.BuilderBase

ListenerConfig.BuilderBase.ListenerConfigImpl

Modifier and Type	Class	Description
protected static class	ListenerConfig.BuilderBase.ListenerConfigImpl	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	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	clearFeatures()	Clear all features.
BUILDER	clearServerContext()	Clear existing value of serverContext.
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.
boolean	featuresDiscoverServices()	Service discovery flag for features().
BUILDER	featuresDiscoverServices(boolean featuresDiscoverServices)	Service discovery flag for features().
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.
BUILDER	serverContext(Supplier<? extends Context> supplier)	Context for the WebServer, if none defined, a new one will be created with global context as the root.
Optional<ServiceRegistry>	serviceRegistry()	Service registry used to discover providers and services.
BUILDER	serviceRegistry(ServiceRegistry serviceRegistry)	Service registry used to discover providers and services.
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 ListenerConfig.BuilderBase

addBinding, addBinding, addBinding, addBindings, addConnectionSelector, addConnectionSelectorProvider, addConnectionSelectorProviders, addConnectionSelectors, addListenerSocketOptions, addProtocol, addProtocols, address, address, addRouting, addRoutings, addVirtualHost, addVirtualHost, addVirtualHosts, backlog, backlog, bindAddress, bindAddress, bindings, bindings, bindingsDiscoverServices, bindingsDiscoverServices, clearBindAddress, clearBindings, clearConcurrencyLimit, clearConnectionSelectorProviders, clearConnectionSelectors, clearContentEncoding, clearDirectHandlers, clearListenerContext, clearMediaContext, clearProtocols, clearProxyProtocol, clearRequestedUriDiscoveryContext, clearRouting, clearRoutings, clearTls, clearVirtualHosts, concurrencyLimit, concurrencyLimit, concurrencyLimitDiscoverServices, concurrencyLimitDiscoverServices, config, connectionOptions, connectionOptions, connectionOptions, connectionOptions, connectionSelectorProviders, connectionSelectorProviders, connectionSelectorProvidersDiscoverServices, connectionSelectorProvidersDiscoverServices, connectionSelectors, connectionSelectors, contentEncoding, contentEncoding, contentEncoding, contentEncoding, contentEncoding, directHandlers, directHandlers, directHandlers, directHandlers, enableProxyProtocol, enableProxyProtocol, errorHandling, errorHandling, errorHandling, errorHandling, from, from, host, host, idleConnectionPeriod, idleConnectionPeriod, idleConnectionTimeout, idleConnectionTimeout, ignoreInvalidNamedRouting, ignoreInvalidNamedRouting, listenerContext, listenerContext, listenerContext, listenerContext, listenerSocketOptions, listenerSocketOptions, maxConcurrentRequests, maxConcurrentRequests, maxConnections, maxConnections, maxInMemoryEntity, maxInMemoryEntity, maxPayloadSize, maxPayloadSize, maxTcpConnections, maxTcpConnections, mediaContext, mediaContext, mediaContext, mediaContext, mediaContext, name, name, port, port, protocols, protocols, protocolsDiscoverServices, protocolsDiscoverServices, proxyProtocol, proxyProtocol, proxyProtocol, proxyProtocol, putListenerSocketOption, requestedUriDiscoveryContext, requestedUriDiscoveryContext, requestedUriDiscoveryContext, requestedUriDiscoveryContext, restoreResponseHeaders, restoreResponseHeaders, routing, routing, routing, routings, routings, shutdownGracePeriod, shutdownGracePeriod, smartAsyncWrites, smartAsyncWrites, sni, sni, sni, sni, tls, tls, tls, tls, tls, useNio, useNio, virtualHosts, virtualHosts, writeBufferSize, writeBufferSize, writeQueueLength, writeQueueLength

Modifier and Type	Method	Description
BUILDER	addBinding(TransportBindingFactory binding)	Transport bindings that serve this listener are configured as one object keyed by binding type; list form and nested name or type are invalid, and built-in TCP remains enabled unless bindings.tcp.enabled=false.
BUILDER	addBinding(TcpTransportConfig config)	Add a TCP transport binding from configuration.
BUILDER	addBinding(UdsTransportConfig config)	Add a Unix domain socket transport binding from configuration.
BUILDER	addBindings(List<? extends TransportBindingFactory> bindings)	Transport bindings that serve this listener are configured as one object keyed by binding type; list form and nested name or type are invalid, and built-in TCP remains enabled unless bindings.tcp.enabled=false.
BUILDER	addConnectionSelector(ServerConnectionSelector connectionSelector)	Explicitly defined connection selectors to be used with this socket.
BUILDER	addConnectionSelectorProvider(ServerConnectionSelectorProvider connectionSelectorProvider)	Providers of connection selectors discovered for this listener.
BUILDER	addConnectionSelectorProviders(List<? extends ServerConnectionSelectorProvider> connectionSelectorProviders)	Providers of connection selectors discovered for this listener.
BUILDER	addConnectionSelectors(List<? extends ServerConnectionSelector> connectionSelectors)	Explicitly defined connection selectors to be used with this socket.
BUILDER	addListenerSocketOptions(Map<SocketOption<?>, ?> listenerSocketOptions)	Server listener socket options.
BUILDER	addProtocol(ProtocolConfig protocol)	Configuration of protocols.
BUILDER	addProtocols(List<? extends ProtocolConfig> protocols)	Configuration of protocols.
Optional<InetAddress>	address()	Address to use.
BUILDER	address(InetAddress address)	Address to use.
BUILDER	addRouting(Builder<?, ? extends Routing> routing)	List of all routings (possibly for multiple protocols).
BUILDER	addRoutings(List<Builder<?, ? extends Routing>> routings)	List of all routings (possibly for multiple protocols).
BUILDER	addVirtualHost(VirtualHostConfig virtualHost)	Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-nio=true).
BUILDER	addVirtualHost(Consumer<VirtualHostConfig.Builder> consumer)	Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-nio=true).
BUILDER	addVirtualHosts(List<? extends VirtualHostConfig> virtualHosts)	Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-nio=true).
int	backlog()	Accept backlog.
BUILDER	backlog(int backlog)	Accept backlog.
Optional<SocketAddress>	bindAddress()	The TCP address to bind to (<host>:<port>); Unix domain addresses are rejected and must instead use bindings.uds.socket.
BUILDER	bindAddress(SocketAddress bindAddress)	The TCP address to bind to (<host>:<port>); Unix domain addresses are rejected and must instead use bindings.uds.socket.
List<TransportBindingFactory>	bindings()	Transport bindings that serve this listener are configured as one object keyed by binding type; list form and nested name or type are invalid, and built-in TCP remains enabled unless bindings.tcp.enabled=false.
BUILDER	bindings(List<? extends TransportBindingFactory> bindings)	Transport bindings that serve this listener are configured as one object keyed by binding type; list form and nested name or type are invalid, and built-in TCP remains enabled unless bindings.tcp.enabled=false.
boolean	bindingsDiscoverServices()	Service discovery flag for ListenerConfig.BuilderBase.bindings().
BUILDER	bindingsDiscoverServices(boolean bindingsDiscoverServices)	Service discovery flag for ListenerConfig.BuilderBase.bindings().
BUILDER	clearBindAddress()	Clear existing value of bindAddress.
BUILDER	clearBindings()	Clear all bindings.
BUILDER	clearConcurrencyLimit()	Clear existing value of concurrencyLimit.
BUILDER	clearConnectionSelectorProviders()	Clear all connectionSelectorProviders.
BUILDER	clearConnectionSelectors()	Clear all connectionSelectors.
BUILDER	clearContentEncoding()	Clear existing value of contentEncoding.
BUILDER	clearDirectHandlers()	Clear existing value of directHandlers.
BUILDER	clearListenerContext()	Clear existing value of listenerContext.
BUILDER	clearMediaContext()	Clear existing value of mediaContext.
BUILDER	clearProtocols()	Clear all protocols.
BUILDER	clearProxyProtocol()	Clear existing value of proxyProtocol.
BUILDER	clearRequestedUriDiscoveryContext()	Clear existing value of requestedUriDiscoveryContext.
BUILDER	clearRouting()	Clear existing value of routing.
BUILDER	clearRoutings()	Clear all routings.
BUILDER	clearTls()	Clear existing value of tls.
BUILDER	clearVirtualHosts()	Clear all virtualHosts.
Optional<Limit>	concurrencyLimit()	Concurrency limit to use to limit concurrent execution of incoming requests.
BUILDER	concurrencyLimit(Limit concurrencyLimit)	Concurrency limit to use to limit concurrent execution of incoming requests.
boolean	concurrencyLimitDiscoverServices()	Service discovery flag for ListenerConfig.BuilderBase.concurrencyLimit().
BUILDER	concurrencyLimitDiscoverServices(boolean concurrencyLimitDiscoverServices)	Service discovery flag for ListenerConfig.BuilderBase.concurrencyLimit().
protected Optional<Config>	config()	Configuration used to configure this instance.
Optional<SocketOptions>	connectionOptions()	Options for connections accepted by this listener.
BUILDER	connectionOptions(SocketOptions connectionOptions)	Options for connections accepted by this listener.
BUILDER	connectionOptions(Consumer<SocketOptions.Builder> consumer)	Options for connections accepted by this listener.
BUILDER	connectionOptions(Supplier<? extends SocketOptions> supplier)	Options for connections accepted by this listener.
List<ServerConnectionSelectorProvider>	connectionSelectorProviders()	Providers of connection selectors discovered for this listener.
BUILDER	connectionSelectorProviders(List<? extends ServerConnectionSelectorProvider> connectionSelectorProviders)	Providers of connection selectors discovered for this listener.
boolean	connectionSelectorProvidersDiscoverServices()	Service discovery flag for ListenerConfig.BuilderBase.connectionSelectorProviders().
BUILDER	connectionSelectorProvidersDiscoverServices(boolean connectionSelectorProvidersDiscoverServices)	Service discovery flag for ListenerConfig.BuilderBase.connectionSelectorProviders().
List<ServerConnectionSelector>	connectionSelectors()	Explicitly defined connection selectors to be used with this socket.
BUILDER	connectionSelectors(List<? extends ServerConnectionSelector> connectionSelectors)	Explicitly defined connection selectors to be used with this socket.
Optional<ContentEncodingContext>	contentEncoding()	Configure the listener specific ContentEncodingContext.
BUILDER	contentEncoding(ContentEncodingContext contentEncoding)	Configure the listener specific ContentEncodingContext.
BUILDER	contentEncoding(ContentEncodingContextConfig contentEncoding)	Configure the listener specific ContentEncodingContext.
BUILDER	contentEncoding(Consumer<ContentEncodingContextConfig.Builder> consumer)	Configure the listener specific ContentEncodingContext.
BUILDER	contentEncoding(Supplier<? extends ContentEncodingContext> supplier)	Configure the listener specific ContentEncodingContext.
Optional<DirectHandlers>	directHandlers()	Direct handlers specific for this listener.
BUILDER	directHandlers(DirectHandlers directHandlers)	Direct handlers specific for this listener.
BUILDER	directHandlers(Consumer<DirectHandlers.Builder> consumer)	Direct handlers specific for this listener.
BUILDER	directHandlers(Supplier<? extends DirectHandlers> supplier)	Direct handlers specific for this listener.
boolean	enableProxyProtocol()	Deprecated, for removal: This API element is subject to removal in a future version. use ListenerConfig.BuilderBase.proxyProtocol() instead
BUILDER	enableProxyProtocol(boolean enableProxyProtocol)	Deprecated, for removal: This API element is subject to removal in a future version. use ListenerConfig.BuilderBase.proxyProtocol() instead
ErrorHandling	errorHandling()	Configuration for this listener's error handling.
BUILDER	errorHandling(ErrorHandling errorHandling)	Configuration for this listener's error handling.
BUILDER	errorHandling(Consumer<ErrorHandling.Builder> consumer)	Configuration for this listener's error handling.
BUILDER	errorHandling(Supplier<? extends ErrorHandling> supplier)	Configuration for this listener's error handling.
BUILDER	from(ListenerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ListenerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	host()	Host of the default socket.
BUILDER	host(String host)	Host of the default socket.
Duration	idleConnectionPeriod()	How often should we check for ListenerConfig.BuilderBase.idleConnectionTimeout().
BUILDER	idleConnectionPeriod(Duration idleConnectionPeriod)	How often should we check for ListenerConfig.BuilderBase.idleConnectionTimeout().
Duration	idleConnectionTimeout()	How long should we wait before closing a connection that has no traffic on it.
BUILDER	idleConnectionTimeout(Duration idleConnectionTimeout)	How long should we wait before closing a connection that has no traffic on it.
boolean	ignoreInvalidNamedRouting()	If set to true, any named routing configured that does not have an associated named listener will NOT cause an exception to be thrown (default behavior is to throw an exception).
BUILDER	ignoreInvalidNamedRouting(boolean ignoreInvalidNamedRouting)	If set to true, any named routing configured that does not have an associated named listener will NOT cause an exception to be thrown (default behavior is to throw an exception).
Optional<Context>	listenerContext()	Listener scoped context to be used as a parent for webserver request contexts (if used).
BUILDER	listenerContext(Context listenerContext)	Listener scoped context to be used as a parent for webserver request contexts (if used).
BUILDER	listenerContext(Consumer<Context.Builder> consumer)	Listener scoped context to be used as a parent for webserver request contexts (if used).
BUILDER	listenerContext(Supplier<? extends Context> supplier)	Listener scoped context to be used as a parent for webserver request contexts (if used).
Map<SocketOption<?>, Object>	listenerSocketOptions()	Server listener socket options.
BUILDER	listenerSocketOptions(Map<SocketOption<?>, ?> listenerSocketOptions)	Server listener socket options.
int	maxConcurrentRequests()	Limits the number of requests that can be executed at the same time (the number of active virtual threads of requests).
BUILDER	maxConcurrentRequests(int maxConcurrentRequests)	Limits the number of requests that can be executed at the same time (the number of active virtual threads of requests).
int	maxConnections()	Limits listener-wide connection admission shared by all connection-oriented bindings.
BUILDER	maxConnections(int maxConnections)	Limits listener-wide connection admission shared by all connection-oriented bindings.
int	maxInMemoryEntity()	If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance when writing it.
BUILDER	maxInMemoryEntity(int maxInMemoryEntity)	If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance when writing it.
long	maxPayloadSize()	Maximal number of bytes an entity may have.
BUILDER	maxPayloadSize(long maxPayloadSize)	Maximal number of bytes an entity may have.
int	maxTcpConnections()	Deprecated, for removal: This API element is subject to removal in a future version. This option is deprecated, use ListenerConfig.BuilderBase.maxConnections instead
BUILDER	maxTcpConnections(int maxTcpConnections)	Deprecated, for removal: This API element is subject to removal in a future version. This option is deprecated, use ListenerConfig.BuilderBase.maxConnections instead
Optional<MediaContext>	mediaContext()	Configure the listener specific MediaContext.
BUILDER	mediaContext(MediaContext mediaContext)	Configure the listener specific MediaContext.
BUILDER	mediaContext(MediaContextConfig mediaContext)	Configure the listener specific MediaContext.
BUILDER	mediaContext(Consumer<MediaContextConfig.Builder> consumer)	Configure the listener specific MediaContext.
BUILDER	mediaContext(Supplier<? extends MediaContext> supplier)	Configure the listener specific MediaContext.
String	name()	Name of this socket.
BUILDER	name(String name)	Name of this socket.
int	port()	Port of the default socket.
BUILDER	port(int port)	Port of the default socket.
List<ProtocolConfig>	protocols()	Configuration of protocols.
BUILDER	protocols(List<? extends ProtocolConfig> protocols)	Configuration of protocols.
boolean	protocolsDiscoverServices()	Service discovery flag for ListenerConfig.BuilderBase.protocols().
BUILDER	protocolsDiscoverServices(boolean protocolsDiscoverServices)	Service discovery flag for ListenerConfig.BuilderBase.protocols().
Optional<ProxyProtocolConfig>	proxyProtocol()	PROXY protocol configuration.
BUILDER	proxyProtocol(ProxyProtocolConfig proxyProtocol)	PROXY protocol configuration.
BUILDER	proxyProtocol(Consumer<ProxyProtocolConfig.Builder> consumer)	PROXY protocol configuration.
BUILDER	proxyProtocol(Supplier<? extends ProxyProtocolConfig> supplier)	PROXY protocol configuration.
<TYPE> BUILDER	putListenerSocketOption(SocketOption<TYPE> key, TYPE listenerSocketOption)	Server listener socket options.
Optional<RequestedUriDiscoveryContext>	requestedUriDiscoveryContext()	Requested URI discovery context.
BUILDER	requestedUriDiscoveryContext(RequestedUriDiscoveryContext requestedUriDiscoveryContext)	Requested URI discovery context.
BUILDER	requestedUriDiscoveryContext(Consumer<RequestedUriDiscoveryContext.Builder> consumer)	Requested URI discovery context.
BUILDER	requestedUriDiscoveryContext(Supplier<? extends RequestedUriDiscoveryContext> supplier)	Requested URI discovery context.
boolean	restoreResponseHeaders()	Copy and restore response headers before and after passing a request to Jersey for processing.
BUILDER	restoreResponseHeaders(boolean restoreResponseHeaders)	Copy and restore response headers before and after passing a request to Jersey for processing.
Optional<HttpRouting.Builder>	routing()	Http routing.
BUILDER	routing(HttpRouting.Builder routing)	Http routing.
BUILDER	routing(Consumer<HttpRouting.Builder> builderConsumer)	Customize HTTP routing of this listener.
List<Builder<?, ? extends Routing>>	routings()	List of all routings (possibly for multiple protocols).
BUILDER	routings(List<Builder<?, ? extends Routing>> routings)	List of all routings (possibly for multiple protocols).
Duration	shutdownGracePeriod()	Grace period in ISO 8601 duration format to allow running tasks to complete before listener's shutdown.
BUILDER	shutdownGracePeriod(Duration shutdownGracePeriod)	Grace period in ISO 8601 duration format to allow running tasks to complete before listener's shutdown.
boolean	smartAsyncWrites()	If enabled and ListenerConfig.BuilderBase.writeQueueLength() is greater than 1, then start with async writes but possibly switch to sync writes if async queue size is always below a certain threshold.
BUILDER	smartAsyncWrites(boolean smartAsyncWrites)	If enabled and ListenerConfig.BuilderBase.writeQueueLength() is greater than 1, then start with async writes but possibly switch to sync writes if async queue size is always below a certain threshold.
SniConfig	sni()	Listener-scoped server TLS SNI policy.
BUILDER	sni(SniConfig sni)	Listener-scoped server TLS SNI policy.
BUILDER	sni(Consumer<SniConfig.Builder> consumer)	Listener-scoped server TLS SNI policy.
BUILDER	sni(Supplier<? extends SniConfig> supplier)	Listener-scoped server TLS SNI policy.
Optional<Tls>	tls()	Listener TLS configuration.
BUILDER	tls(Tls tls)	Listener TLS configuration.
BUILDER	tls(TlsConfig tls)	Listener TLS configuration.
BUILDER	tls(Consumer<TlsConfig.Builder> consumer)	Listener TLS configuration.
BUILDER	tls(Supplier<? extends Tls> supplier)	Listener TLS configuration.
boolean	useNio()	Whether to use an NIO socket channel instead of a socket; Unix domain socket bindings always use NIO and ignore this setting, while listener TLS virtual hosts require it to be true.
BUILDER	useNio(boolean useNio)	Whether to use an NIO socket channel instead of a socket; Unix domain socket bindings always use NIO and ignore this setting, while listener TLS virtual hosts require it to be true.
List<VirtualHostConfig>	virtualHosts()	Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-nio=true).
BUILDER	virtualHosts(List<? extends VirtualHostConfig> virtualHosts)	Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-nio=true).
int	writeBufferSize()	Initial buffer size in bytes of BufferedOutputStream created internally to write data to a socket connection.
BUILDER	writeBufferSize(int writeBufferSize)	Initial buffer size in bytes of BufferedOutputStream created internally to write data to a socket connection.
int	writeQueueLength()	Number of buffers queued for write operations.
BUILDER	writeQueueLength(int writeQueueLength)	Number of buffers queued for write operations.

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

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 - consumer of builder for new value

Returns:

updated builder instance

See Also:

• sockets()

clearFeatures

public BUILDER clearFeatures()

Clear all features.

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 - add single server features

Returns:

updated builder instance

See Also:

• features()

clearServerContext

public BUILDER clearServerContext()

Clear existing value of serverContext.

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 - consumer of builder of server context

Returns:

updated builder instance

See Also:

• serverContext()

serverContext

public BUILDER serverContext(Supplier<? extends Context> supplier)

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

Parameters:

supplier - supplier of server context

Returns:

updated builder instance

See Also:

• serverContext()

featuresDiscoverServices

public BUILDER featuresDiscoverServices(boolean featuresDiscoverServices)

Service discovery flag for features(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.

Parameters:

featuresDiscoverServices - whether to enable automatic service discovery

Returns:

updated builder instance

See Also:

• featuresDiscoverServices()

serviceRegistry

public BUILDER serviceRegistry(ServiceRegistry serviceRegistry)

Service registry used to discover providers and services. Provide an explicit registry instance to use.

If not configured, the GlobalServiceRegistry would be used to discover services.

Parameters:

serviceRegistry - service registry to use

Returns:

updated builder instance

See Also:

• serviceRegistry()

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:

whether to register a 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:

map of listener configurations, except for the default one

features

public List<ServerFeature> features()

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

Returns:

server 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:

server context

featuresDiscoverServices

public boolean featuresDiscoverServices()

Service discovery flag for features(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.

Returns:

whether to enable automatic service discovery

serviceRegistry

public Optional<ServiceRegistry> serviceRegistry()

Service registry used to discover providers and services. Provide an explicit registry instance to use.

If not configured, the GlobalServiceRegistry would be used to discover services.

Returns:

service registry to use

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>