Class WebServerConfig.Builder

java.lang.Object

io.helidon.webserver.ListenerConfig.BuilderBase<WebServerConfig.Builder, WebServerConfig>

io.helidon.webserver.WebServerConfig.BuilderBase<WebServerConfig.Builder, WebServerConfig>

io.helidon.webserver.WebServerConfig.Builder

All Implemented Interfaces:

Prototype.Builder<WebServerConfig.Builder, WebServerConfig>, Builder<WebServerConfig.Builder, WebServer>, ConfigBuilderSupport.ConfiguredBuilder<WebServerConfig.Builder, WebServerConfig>, Supplier<WebServer>

Enclosing interface:

WebServerConfig

public static class WebServerConfig.Builder
extends WebServerConfig.BuilderBase<WebServerConfig.Builder, WebServerConfig>
implements Builder<WebServerConfig.Builder, WebServer>

Fluent API builder for WebServer.

Nested Class Summary

Nested classes/interfaces inherited from class WebServerConfig.BuilderBase

WebServerConfig.BuilderBase.WebServerConfigImpl

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.

Method Summary

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

Methods inherited from class WebServerConfig.BuilderBase

addFeature, addFeatures, addSockets, clearFeatures, clearServerContext, config, features, features, featuresDiscoverServices, featuresDiscoverServices, from, from, preBuildPrototype, putSocket, putSocket, routing, routing, serverContext, serverContext, serverContext, serverContext, serviceRegistry, serviceRegistry, shutdownHook, shutdownHook, sockets, sockets, toString, validatePrototype

Modifier and Type	Method	Description
WebServerConfig.Builder	addFeature(ServerFeature feature)	Server features allow customization of the server, listeners, or routings.
WebServerConfig.Builder	addFeatures(List<? extends ServerFeature> features)	Server features allow customization of the server, listeners, or routings.
WebServerConfig.Builder	addSockets(Map<String, ? extends ListenerConfig> sockets)	Socket configurations.
WebServerConfig.Builder	clearFeatures()	Clear all features.
WebServerConfig.Builder	clearServerContext()	Clear existing value of serverContext.
WebServerConfig.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.
WebServerConfig.Builder	features(List<? extends ServerFeature> features)	Server features allow customization of the server, listeners, or routings.
boolean	featuresDiscoverServices()	Service discovery flag for WebServerConfig.BuilderBase.features().
WebServerConfig.Builder	featuresDiscoverServices(boolean featuresDiscoverServices)	Service discovery flag for WebServerConfig.BuilderBase.features().
WebServerConfig.Builder	from(WebServerConfig prototype)	Update this builder from an existing prototype instance.
WebServerConfig.Builder	from(WebServerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
WebServerConfig.Builder	putSocket(String key, ListenerConfig socket)	Socket configurations.
WebServerConfig.Builder	putSocket(String key, Consumer<ListenerConfig.Builder> consumer)	Socket configurations.
WebServerConfig.Builder	routing(String socket, HttpRouting.Builder routing)	Add Http routing for an additional socket.
WebServerConfig.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.
WebServerConfig.Builder	serverContext(Context serverContext)	Context for the WebServer, if none defined, a new one will be created with global context as the root.
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.Builder	shutdownHook(boolean shutdownHook)	When true the webserver registers a shutdown hook with the JVM Runtime.
Map<String, ListenerConfig>	sockets()	Socket configurations.
WebServerConfig.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
WebServerConfig.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.
WebServerConfig.Builder	addBinding(TcpTransportConfig config)	Add a TCP transport binding from configuration.
WebServerConfig.Builder	addBinding(UdsTransportConfig config)	Add a Unix domain socket transport binding from configuration.
WebServerConfig.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.
WebServerConfig.Builder	addConnectionSelector(ServerConnectionSelector connectionSelector)	Explicitly defined connection selectors to be used with this socket.
WebServerConfig.Builder	addConnectionSelectorProvider(ServerConnectionSelectorProvider connectionSelectorProvider)	Providers of connection selectors discovered for this listener.
WebServerConfig.Builder	addConnectionSelectorProviders(List<? extends ServerConnectionSelectorProvider> connectionSelectorProviders)	Providers of connection selectors discovered for this listener.
WebServerConfig.Builder	addConnectionSelectors(List<? extends ServerConnectionSelector> connectionSelectors)	Explicitly defined connection selectors to be used with this socket.
WebServerConfig.Builder	addListenerSocketOptions(Map<SocketOption<?>, ?> listenerSocketOptions)	Server listener socket options.
WebServerConfig.Builder	addProtocol(ProtocolConfig protocol)	Configuration of protocols.
WebServerConfig.Builder	addProtocols(List<? extends ProtocolConfig> protocols)	Configuration of protocols.
Optional<InetAddress>	address()	Address to use.
WebServerConfig.Builder	address(InetAddress address)	Address to use.
WebServerConfig.Builder	addRouting(Builder<?, ? extends Routing> routing)	List of all routings (possibly for multiple protocols).
WebServerConfig.Builder	addRoutings(List<Builder<?, ? extends Routing>> routings)	List of all routings (possibly for multiple protocols).
WebServerConfig.Builder	addVirtualHost(VirtualHostConfig virtualHost)	Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-nio=true).
WebServerConfig.Builder	addVirtualHost(Consumer<VirtualHostConfig.Builder> consumer)	Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-nio=true).
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.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().
WebServerConfig.Builder	bindingsDiscoverServices(boolean bindingsDiscoverServices)	Service discovery flag for ListenerConfig.BuilderBase.bindings().
WebServerConfig.Builder	clearBindAddress()	Clear existing value of bindAddress.
WebServerConfig.Builder	clearBindings()	Clear all bindings.
WebServerConfig.Builder	clearConcurrencyLimit()	Clear existing value of concurrencyLimit.
WebServerConfig.Builder	clearConnectionSelectorProviders()	Clear all connectionSelectorProviders.
WebServerConfig.Builder	clearConnectionSelectors()	Clear all connectionSelectors.
WebServerConfig.Builder	clearContentEncoding()	Clear existing value of contentEncoding.
WebServerConfig.Builder	clearDirectHandlers()	Clear existing value of directHandlers.
WebServerConfig.Builder	clearListenerContext()	Clear existing value of listenerContext.
WebServerConfig.Builder	clearMediaContext()	Clear existing value of mediaContext.
WebServerConfig.Builder	clearProtocols()	Clear all protocols.
WebServerConfig.Builder	clearProxyProtocol()	Clear existing value of proxyProtocol.
WebServerConfig.Builder	clearRequestedUriDiscoveryContext()	Clear existing value of requestedUriDiscoveryContext.
WebServerConfig.Builder	clearRouting()	Clear existing value of routing.
WebServerConfig.Builder	clearRoutings()	Clear all routings.
WebServerConfig.Builder	clearTls()	Clear existing value of tls.
WebServerConfig.Builder	clearVirtualHosts()	Clear all virtualHosts.
Optional<Limit>	concurrencyLimit()	Concurrency limit to use to limit concurrent execution of incoming requests.
WebServerConfig.Builder	concurrencyLimit(Limit concurrencyLimit)	Concurrency limit to use to limit concurrent execution of incoming requests.
boolean	concurrencyLimitDiscoverServices()	Service discovery flag for ListenerConfig.BuilderBase.concurrencyLimit().
WebServerConfig.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.
WebServerConfig.Builder	connectionOptions(SocketOptions connectionOptions)	Options for connections accepted by this listener.
WebServerConfig.Builder	connectionOptions(Consumer<SocketOptions.Builder> consumer)	Options for connections accepted by this listener.
WebServerConfig.Builder	connectionOptions(Supplier<? extends SocketOptions> supplier)	Options for connections accepted by this listener.
List<ServerConnectionSelectorProvider>	connectionSelectorProviders()	Providers of connection selectors discovered for this listener.
WebServerConfig.Builder	connectionSelectorProviders(List<? extends ServerConnectionSelectorProvider> connectionSelectorProviders)	Providers of connection selectors discovered for this listener.
boolean	connectionSelectorProvidersDiscoverServices()	Service discovery flag for ListenerConfig.BuilderBase.connectionSelectorProviders().
WebServerConfig.Builder	connectionSelectorProvidersDiscoverServices(boolean connectionSelectorProvidersDiscoverServices)	Service discovery flag for ListenerConfig.BuilderBase.connectionSelectorProviders().
List<ServerConnectionSelector>	connectionSelectors()	Explicitly defined connection selectors to be used with this socket.
WebServerConfig.Builder	connectionSelectors(List<? extends ServerConnectionSelector> connectionSelectors)	Explicitly defined connection selectors to be used with this socket.
Optional<ContentEncodingContext>	contentEncoding()	Configure the listener specific ContentEncodingContext.
WebServerConfig.Builder	contentEncoding(ContentEncodingContext contentEncoding)	Configure the listener specific ContentEncodingContext.
WebServerConfig.Builder	contentEncoding(ContentEncodingContextConfig contentEncoding)	Configure the listener specific ContentEncodingContext.
WebServerConfig.Builder	contentEncoding(Consumer<ContentEncodingContextConfig.Builder> consumer)	Configure the listener specific ContentEncodingContext.
WebServerConfig.Builder	contentEncoding(Supplier<? extends ContentEncodingContext> supplier)	Configure the listener specific ContentEncodingContext.
Optional<DirectHandlers>	directHandlers()	Direct handlers specific for this listener.
WebServerConfig.Builder	directHandlers(DirectHandlers directHandlers)	Direct handlers specific for this listener.
WebServerConfig.Builder	directHandlers(Consumer<DirectHandlers.Builder> consumer)	Direct handlers specific for this listener.
WebServerConfig.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
WebServerConfig.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.
WebServerConfig.Builder	errorHandling(ErrorHandling errorHandling)	Configuration for this listener's error handling.
WebServerConfig.Builder	errorHandling(Consumer<ErrorHandling.Builder> consumer)	Configuration for this listener's error handling.
WebServerConfig.Builder	errorHandling(Supplier<? extends ErrorHandling> supplier)	Configuration for this listener's error handling.
WebServerConfig.Builder	from(ListenerConfig prototype)	Update this builder from an existing prototype instance.
WebServerConfig.Builder	from(ListenerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	host()	Host of the default socket.
WebServerConfig.Builder	host(String host)	Host of the default socket.
Duration	idleConnectionPeriod()	How often should we check for ListenerConfig.BuilderBase.idleConnectionTimeout().
WebServerConfig.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.
WebServerConfig.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).
WebServerConfig.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).
WebServerConfig.Builder	listenerContext(Context listenerContext)	Listener scoped context to be used as a parent for webserver request contexts (if used).
WebServerConfig.Builder	listenerContext(Consumer<Context.Builder> consumer)	Listener scoped context to be used as a parent for webserver request contexts (if used).
WebServerConfig.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.
WebServerConfig.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).
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.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
WebServerConfig.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.
WebServerConfig.Builder	mediaContext(MediaContext mediaContext)	Configure the listener specific MediaContext.
WebServerConfig.Builder	mediaContext(MediaContextConfig mediaContext)	Configure the listener specific MediaContext.
WebServerConfig.Builder	mediaContext(Consumer<MediaContextConfig.Builder> consumer)	Configure the listener specific MediaContext.
WebServerConfig.Builder	mediaContext(Supplier<? extends MediaContext> supplier)	Configure the listener specific MediaContext.
String	name()	Name of this socket.
WebServerConfig.Builder	name(String name)	Name of this socket.
int	port()	Port of the default socket.
WebServerConfig.Builder	port(int port)	Port of the default socket.
List<ProtocolConfig>	protocols()	Configuration of protocols.
WebServerConfig.Builder	protocols(List<? extends ProtocolConfig> protocols)	Configuration of protocols.
boolean	protocolsDiscoverServices()	Service discovery flag for ListenerConfig.BuilderBase.protocols().
WebServerConfig.Builder	protocolsDiscoverServices(boolean protocolsDiscoverServices)	Service discovery flag for ListenerConfig.BuilderBase.protocols().
Optional<ProxyProtocolConfig>	proxyProtocol()	PROXY protocol configuration.
WebServerConfig.Builder	proxyProtocol(ProxyProtocolConfig proxyProtocol)	PROXY protocol configuration.
WebServerConfig.Builder	proxyProtocol(Consumer<ProxyProtocolConfig.Builder> consumer)	PROXY protocol configuration.
WebServerConfig.Builder	proxyProtocol(Supplier<? extends ProxyProtocolConfig> supplier)	PROXY protocol configuration.
<TYPE> WebServerConfig.Builder	putListenerSocketOption(SocketOption<TYPE> key, TYPE listenerSocketOption)	Server listener socket options.
Optional<RequestedUriDiscoveryContext>	requestedUriDiscoveryContext()	Requested URI discovery context.
WebServerConfig.Builder	requestedUriDiscoveryContext(RequestedUriDiscoveryContext requestedUriDiscoveryContext)	Requested URI discovery context.
WebServerConfig.Builder	requestedUriDiscoveryContext(Consumer<RequestedUriDiscoveryContext.Builder> consumer)	Requested URI discovery context.
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.Builder	routing(HttpRouting.Builder routing)	Http routing.
WebServerConfig.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).
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.Builder	sni(SniConfig sni)	Listener-scoped server TLS SNI policy.
WebServerConfig.Builder	sni(Consumer<SniConfig.Builder> consumer)	Listener-scoped server TLS SNI policy.
WebServerConfig.Builder	sni(Supplier<? extends SniConfig> supplier)	Listener-scoped server TLS SNI policy.
Optional<Tls>	tls()	Listener TLS configuration.
WebServerConfig.Builder	tls(Tls tls)	Listener TLS configuration.
WebServerConfig.Builder	tls(TlsConfig tls)	Listener TLS configuration.
WebServerConfig.Builder	tls(Consumer<TlsConfig.Builder> consumer)	Listener TLS configuration.
WebServerConfig.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.
WebServerConfig.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).
WebServerConfig.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.
WebServerConfig.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.
WebServerConfig.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 Builder

get, identity, update

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

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public WebServerConfig 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<WebServerConfig.Builder, WebServerConfig>

Returns:

an instance of the setup object created from this builder

build

public WebServer 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<WebServerConfig.Builder, WebServer>

Returns:

instance of the built type