Interface WebServerConfig

All Superinterfaces:

ListenerConfig, Prototype.Api, Prototype.Factory<WebServer>

All Known Implementing Classes:

WebServerConfig.BuilderBase.WebServerConfigImpl

public interface WebServerConfig
extends Prototype.Api, ListenerConfig

WebServer configuration bean. See WebServer.create(java.util.function.Consumer).

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebServerConfig.Builder	Fluent API builder for WebServer.
static class	WebServerConfig.BuilderBase<BUILDER extends WebServerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WebServerConfig>	Fluent API builder base for WebServerConfig.

Method Summary

Modifier and Type	Method	Description
static WebServerConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static WebServerConfig.Builder	builder(WebServerConfig instance)	Create a new fluent API builder from an existing instance.
static WebServerConfig	create()	Create a new instance with default values.
static WebServerConfig	create(Config config)	Create a new instance from configuration.
List<ServerFeature>	features()	Server features allow customization of the server, listeners, or routings.
Map<String, List<Builder<?, ? extends Routing>>>	namedRoutings()	Routing for additional sockets.
Optional<Context>	serverContext()	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.
Map<String, ListenerConfig>	sockets()	Socket configurations.

Methods inherited from interface ListenerConfig

address, backlog, bindAddress, bindings, concurrencyLimit, configureSocket, configureSocket, connectionOptions, connectionSelectorProviders, connectionSelectors, contentEncoding, directHandlers, enableProxyProtocol, errorHandling, host, idleConnectionPeriod, idleConnectionTimeout, ignoreInvalidNamedRouting, listenerContext, listenerSocketOptions, maxConcurrentRequests, maxConnections, maxInMemoryEntity, maxPayloadSize, maxTcpConnections, mediaContext, name, port, protocols, proxyProtocol, requestedUriDiscoveryContext, restoreResponseHeaders, routing, routings, shutdownGracePeriod, smartAsyncWrites, sni, tls, useNio, virtualHosts, writeBufferSize, writeQueueLength

Modifier and Type	Method	Description
InetAddress	address()	Address to use.
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.
default 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.
Optional<Limit>	concurrencyLimit()	Concurrency limit to use to limit concurrent execution of incoming requests.
default void	configureSocket(ServerSocket socket)	Update the server socket with configured socket options.
default void	configureSocket(ServerSocketChannel socket)	Update the server socket with configured socket options.
SocketOptions	connectionOptions()	Options for connections accepted by this listener.
List<ServerConnectionSelectorProvider>	connectionSelectorProviders()	Providers of connection selectors discovered for this listener.
List<ServerConnectionSelector>	connectionSelectors()	Explicitly defined connection selectors to be used with this socket.
Optional<ContentEncodingContext>	contentEncoding()	Configure the listener specific ContentEncodingContext.
Optional<DirectHandlers>	directHandlers()	Direct handlers specific for this listener.
boolean	enableProxyProtocol()	Deprecated, for removal: This API element is subject to removal in a future version. use ListenerConfig.proxyProtocol() instead
ErrorHandling	errorHandling()	Configuration for this listener's error handling.
String	host()	Host of the default socket.
Duration	idleConnectionPeriod()	How often should we check for ListenerConfig.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).
Optional<Context>	listenerContext()	Listener scoped context to be used as a parent for webserver request contexts (if used).
Map<SocketOption<?>, Object>	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).
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.
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.maxConnections() instead
Optional<MediaContext>	mediaContext()	Configure the listener specific MediaContext.
String	name()	Name of this socket.
int	port()	Port of the default socket.
List<ProtocolConfig>	protocols()	Configuration of protocols.
default Optional<ProxyProtocolConfig>	proxyProtocol()	PROXY protocol configuration.
Optional<RequestedUriDiscoveryContext>	requestedUriDiscoveryContext()	Requested URI discovery context.
boolean	restoreResponseHeaders()	Copy and restore response headers before and after passing a request to Jersey for processing.
Optional<HttpRouting.Builder>	routing()	Http routing.
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.
boolean	smartAsyncWrites()	If enabled and ListenerConfig.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.
Optional<Tls>	tls()	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.
List<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.
int	writeQueueLength()	Number of buffers queued for write operations.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
WebServer	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static WebServerConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static WebServerConfig.Builder builder(WebServerConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static WebServerConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static WebServerConfig create()

Create a new instance with default values.

Returns:

a new instance

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.

Returns:

whether to register a shutdown hook

sockets

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

namedRoutings

Map<String, List<Builder<?, ? extends Routing>>> namedRoutings()

Routing for additional sockets. Note that socket named "@default" cannot be used, configure the routing on the server directly.

Returns:

map of routing

features

List<ServerFeature> features()

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

Returns:

server features

serverContext

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