int

Accept backlog.

@return backlog

ConnectionConfig

Configuration of a connection (established from client against our server).

@return connection configuration

SocketOptions

Options for connections accepted by this listener. This is not used to setup server connection.

@return socket options

ContentEncodingContext

Configure the listener specific io.helidon.http.encoding.ContentEncodingContext. This method discards all previously registered ContentEncodingContext. If no content encoding context is registered, content encoding context of the webserver would be used.

@return content encoding context

io.helidon.webserver.spi.ServerFeature[] (service provider interface)

Such as:

• observe (ObserveFeature)

• context (ContextFeature)

• cors (CorsFeature)

• security (SecurityFeature)

• access-log (AccessLogFeature)

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

@return server features

string

Host of the default socket. Defaults to all host addresses (0.0.0.0).

@return host address to listen on (for the default socket)

Duration

How often should we check for #idleConnectionTimeout(). Defaults to PT2M (2 minutes).

@return period of checking for idle connections

Duration

How long should we wait before closing a connection that has no traffic on it. Defaults to PT5M (5 minutes). Note that the timestamp is refreshed max. once per second, so this setting would be useless if configured for shorter periods of time (also not a very good support for connection keep alive, if the connections are killed so soon anyway).

@return timeout of idle connections

int

Limits the number of requests that can be executed at the same time (the number of active virtual threads of requests). Defaults to -1, meaning "unlimited" - what the system allows. Also make sure that this number is higher than the expected time it takes to handle a single request in your application, as otherwise you may stop in-progress requests.

@return number of requests that can be processed on this listener, regardless of protocol

int

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. If bigger, streaming will be used.

Note that for some entity types we cannot use streaming, as they are already fully in memory (String, byte[]), for such
cases, this option is ignored.

Default is 128Kb.

@return maximal number of bytes to buffer in memory for supported writers

long

Maximal number of bytes an entity may have. If io.helidon.http.HeaderNames#CONTENT_LENGTH is used, this is checked immediately, if io.helidon.http.HeaderValues#TRANSFER_ENCODING_CHUNKED is used, we will fail when the number of bytes read would exceed the max payload size. Defaults to unlimited (-1).

@return maximal number of bytes of entity

int

Limits the number of connections that can be opened at a single point in time. Defaults to -1, meaning "unlimited" - what the system allows.

@return number of TCP connections that can be opened to this listener, regardless of protocol

MediaContext

Configure the listener specific io.helidon.http.media.MediaContext. This method discards all previously registered MediaContext. If no media context is registered, media context of the webserver would be used.

@return media context

string

Name of this socket. Defaults to @default. Must be defined if more than one socket is needed.

@return name of the socket

int

Port of the default socket. If configured to 0 (the default), server starts on a random port.

@return port to listen on (for the default socket)

io.helidon.webserver.spi.ProtocolConfig[] (service provider interface)

Configuration of protocols. This may be either protocol selectors, or protocol upgraders from HTTP/1.1. As the order is not important (providers are ordered by weight by default), we can use a configuration as an object, such as: <pre> protocols: providers: http_1_1: max-prologue-length: 8192 http_2: max-frame-size: 4096 websocket: …​. </pre>

@return all defined protocol configurations, loaded from service loader by default

int

Listener receive buffer size.

@return buffer size in bytes

Duration

Grace period in ISO 8601 duration format to allow running tasks to complete before listener’s shutdown. Default is 500 milliseconds. Configuration file values example: PT0.5S, PT2S.

@return grace period

boolean

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.

@return whether to register a shutdown hook

Map<string, ListenerConfig>

Socket configurations. Note that socket named WebServer#DEFAULT_SOCKET_NAME cannot be used, configure the values on the server directly.

@return map of listener configurations, except for the default one

Tls

Listener TLS configuration.

@return tls of this configuration

int

Initial buffer size in bytes of java.io.BufferedOutputStream created internally to write data to a socket connection. Default is 512.

@return initial buffer size used for writing

int

Number of buffers queued for write operations.

@return maximal number of queued writes, defaults to 0

boolean

Whether this feature will be enabled.

@return whether enabled

string

The format for log entries (similar to the Apache LogFormat). <table class="config"> <caption>Log format elements</caption> <tr> <td>%h</td> <td>IP address of the remote host</td> <td>HostLogEntry</td> </tr> <tr> <td>%l</td> <td>The client identity. This is always undefined in Helidon.</td> <td>UserIdLogEntry</td> </tr> <tr> <td>%u</td> <td>User ID as asserted by Helidon Security.</td> <td>UserLogEntry</td> </tr> <tr> <td>%t</td> <td>The timestamp</td> <td>TimestampLogEntry</td> </tr> <tr> <td>%r</td> <td>The request line ("GET /favicon.ico HTTP/1.0")</td> <td>RequestLineLogEntry</td> </tr> <tr> <td>%s</td> <td>The status code returned to the client</td> <td>StatusLogEntry</td> </tr> <tr> <td>%b</td> <td>The entity size in bytes</td> <td>SizeLogEntry</td> </tr> <tr> <td>%D</td> <td>The time taken in microseconds (start of request until last byte written)</td> <td>TimeTakenLogEntry</td> </tr> <tr> <td>%T</td> <td>The time taken in seconds (start of request until last byte written), integer</td> <td>TimeTakenLogEntry</td> </tr> <tr> <td>%{header-name}i</td> <td>Value of header header-name</td> <td>HeaderLogEntry</td> </tr> </table>

@return format string, such as `%h %l %u %t %r %b %{Referer`i}

string

Name of the logger used to obtain access log logger from System#getLogger(String). Defaults to AccessLogFeature#DEFAULT_LOGGER_NAME.

@return name of the logger to use

string[]

List of sockets to register this feature on. If empty, it would get registered on all sockets. The logger used will have the expected logger with a suffix of the socket name.

@return socket names to register on, defaults to empty (all available sockets)

double

Weight of the access log feature. We need to log access for anything happening on the server, so weight is high: io.helidon.webserver.accesslog.AccessLogFeature#WEIGHT.

@return weight of the feature