Description

WebServer configuration bean

Configuration options

KeyTypeDefault ValueDescription
restore-response-headersBooleantrueCopy and restore response headers before and after passing a request to Jersey for processing
concurrency-limitLimit Concurrency limit to use to limit concurrent execution of incoming requests
content-encodingContentEncodingContext Configure the listener specific io.helidon.http.encoding.ContentEncodingContext
media-contextMediaContext Configure the listener specific io.helidon.http.media.MediaContext
max-payload-sizeLong-1Maximal number of bytes an entity may have
featuresList<ServerFeature> Server features allow customization of the server, listeners, or routings
use-nioBooleantrueIf set to true, use NIO socket channel, instead of a socket
protocols-discover-servicesBooleantrueWhether to enable automatic service discovery for protocols
enable-proxy-protocolBooleanfalseEnable proxy protocol support for this socket
hostString0.0.0.0Host of the default socket
write-queue-lengthInteger0Number of buffers queued for write operations
socketsMap<String, ListenerConfig> Socket configurations
protocolsList<ProtocolConfig> Configuration of protocols
max-tcp-connectionsInteger-1Limits the number of connection permits that this listener may reserve before accepting sockets
bind-addressListenerCustomMethods The address to bind to
idle-connection-timeoutDurationPT5MHow long should we wait before closing a connection that has no traffic on it
shutdown-grace-periodDurationPT0.5SGrace period in ISO 8601 duration format to allow running tasks to complete before listener's shutdown
max-concurrent-requestsInteger-1Limits the number of requests that can be executed at the same time (the number of active virtual threads of requests)
features-discover-servicesBooleantrueWhether to enable automatic service discovery for features
shutdown-hookBooleantrueWhen true the webserver registers a shutdown hook with the JVM Runtime
error-handlingErrorHandling Configuration for this listener's error handling
concurrency-limit-discover-servicesBooleanfalseWhether to enable automatic service discovery for concurrency-limit
backlogInteger1024Accept backlog
max-in-memory-entityInteger131072If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance when writing it
ignore-invalid-named-routingBoolean 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-async-writesBooleanfalseIf enabled and #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
connection-optionsSocketOptions Options for connections accepted by this listener
portInteger0Port of the default socket
requested-uri-discoveryRequestedUriDiscoveryContext Requested URI discovery context
idle-connection-periodDurationPT2MHow often should we check for #idleConnectionTimeout()
nameString@defaultName of this socket
tlsTls Listener TLS configuration
write-buffer-sizeInteger4096Initial buffer size in bytes of java.io.BufferedOutputStream created internally to write data to a socket connection

Deprecated Options

KeyTypeDescription
connection-configConnectionConfigConfiguration of a connection (established from client against our server)
receive-buffer-sizeIntegerListener receive buffer size

Usages


See the manifest for all available types.