io.helidon.webserver.WebServer
Description
WebServer configuration bean
Configuration options
| Key | Type | Default | Description |
|---|---|---|---|
restore- | Boolean | true | Copy and restore response headers before and after passing a request to Jersey for processing |
bindings | Map< | 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. | |
concurrency- | Map< | Concurrency limit to use to limit concurrent execution of incoming requests | |
content- | Content | Configure the listener specific io. | |
media- | Media | Configure the listener specific io. | |
max- | Integer | -1 | Limits listener-wide connection admission shared by all connection-oriented bindings |
bindings- | Boolean | true | Whether to enable automatic service discovery for bindings |
max- | Long | -1 | Maximal number of bytes an entity may have |
features | Map< | Server features allow customization of the server, listeners, or routings | |
use- | Boolean | true | 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 |
protocols- | Boolean | true | Whether to enable automatic service discovery for protocols |
host | String | 0. | Host of the default socket |
virtual- | List< | Listener TLS virtual hosts selected by SNI; requires listener TLS and NIO socket-channel transport (use-) | |
write- | Integer | 0 | Number of buffers queued for write operations |
sockets | Map< | Socket configurations | |
protocols | Map< | Configuration of protocols | |
bind- | Listener | The TCP address to bind to (<host>); Unix domain addresses are rejected and must instead use bindings. | |
idle- | Duration | PT5M | How long should we wait before closing a connection that has no traffic on it |
shutdown- | Duration | PT0. | Grace period in ISO 8601 duration format to allow running tasks to complete before listener's shutdown |
max- | Integer | -1 | Limits the number of requests that can be executed at the same time (the number of active virtual threads of requests) |
features- | Boolean | true | Whether to enable automatic service discovery for features |
shutdown- | Boolean | true | When true the webserver registers a shutdown hook with the JVM Runtime |
sni | Sni | Listener-scoped server TLS SNI policy | |
error- | Error | Configuration for this listener's error handling | |
concurrency- | Boolean | false | Whether to enable automatic service discovery for concurrency- |
backlog | Integer | 1024 | Accept backlog |
max- | Integer | 131072 | 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 |
proxy- | Proxy | PROXY protocol configuration | |
ignore- | Boolean | 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) | |
smart- | Boolean | false | If enabled and #write 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 |
connection- | Socket | Options for connections accepted by this listener | |
port | Integer | 0 | Port of the default socket |
requested- | Requested | Requested URI discovery context | |
idle- | Duration | PT2M | How often should we check for #idle |
name | String | @default | Name of this socket |
tls | Tls | Listener TLS configuration | |
write- | Integer | 4096 | Initial buffer size in bytes of java. created internally to write data to a socket connection |
Deprecated Options
| Key | Type | Default | Description |
|---|---|---|---|
enable- | Boolean | false | Deprecated PROXY protocol enablement flag for this socket |
max- | Integer | -1 | Limits listener-wide connection admission shared by all connection-oriented bindings |
Usages
See the manifest for all available types.