Description

WebServer configuration bean.

Usages

Configuration options

KeyKindTypeDefault ValueDescription
backlogVALUEInteger1024Accept backlog
bind-addressVALUEi.h.w.W.ListenerCustomMethods The address to bind to
concurrency-limitVALUEi.h.c.c.l.Limit Concurrency limit to use to limit concurrent execution of incoming requests
concurrency-limit-discover-servicesVALUEBooleanfalseWhether to enable automatic service discovery for concurrency-limit
connection-optionsVALUEi.h.c.s.SocketOptions Options for connections accepted by this listener
content-encodingVALUEi.h.h.e.ContentEncodingContext Configure the listener specific io.helidon.http.encoding.ContentEncodingContext
enable-proxy-protocolVALUEBooleanfalseEnable proxy protocol support for this socket
error-handlingVALUEi.h.w.ErrorHandling Configuration for this listener's error handling
featuresLISTi.h.w.s.ServerFeature Server features allow customization of the server, listeners, or routings
features-discover-servicesVALUEBooleantrueWhether to enable automatic service discovery for features
hostVALUEString0.0.0.0Host of the default socket
idle-connection-periodVALUEDurationPT2MHow often should we check for #idleConnectionTimeout()
idle-connection-timeoutVALUEDurationPT5MHow long should we wait before closing a connection that has no traffic on it
ignore-invalid-named-routingVALUEBoolean 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)
max-concurrent-requestsVALUEInteger-1Limits the number of requests that can be executed at the same time (the number of active virtual threads of requests)
max-in-memory-entityVALUEInteger131072If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance when writing it
max-payload-sizeVALUELong-1Maximal number of bytes an entity may have
max-tcp-connectionsVALUEInteger-1Limits the number of connections that can be opened at a single point in time
media-contextVALUEi.h.h.m.MediaContext Configure the listener specific io.helidon.http.media.MediaContext
nameVALUEString@defaultName of this socket
portVALUEInteger0Port of the default socket
protocolsLISTi.h.w.s.ProtocolConfig Configuration of protocols
protocols-discover-servicesVALUEBooleantrueWhether to enable automatic service discovery for protocols
requested-uri-discoveryVALUEi.h.h.RequestedUriDiscoveryContext Requested URI discovery context
restore-response-headersVALUEBooleantrueCopy and restore response headers before and after passing a request to Jersey for processing
shutdown-grace-periodVALUEDurationPT0.5SGrace period in ISO 8601 duration format to allow running tasks to complete before listener's shutdown
shutdown-hookVALUEBooleantrueWhen true the webserver registers a shutdown hook with the JVM Runtime
smart-async-writesVALUEBooleanfalseIf 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
socketsMAPi.h.w.ListenerConfig Socket configurations
tlsVALUEi.h.c.t.Tls Listener TLS configuration
use-nioVALUEBooleantrueIf set to true, use NIO socket channel, instead of a socket
write-buffer-sizeVALUEInteger4096Initial buffer size in bytes of java.io.BufferedOutputStream created internally to write data to a socket connection
write-queue-lengthVALUEInteger0Number of buffers queued for write operations

Deprecated Options

KeyKindTypeDescription
connection-configVALUEi.h.w.ConnectionConfigConfiguration of a connection (established from client against our server)
receive-buffer-sizeVALUEIntegerListener receive buffer size

See the manifest for all available types.