Configuration Reference
Version:4.4.8
Buffer Netty Config Properties
🔗Property | Type | Description |
---|---|---|
|
java.lang.Integer |
The number of heap arenas |
|
java.lang.Integer |
The number of direct arenas |
|
java.lang.Integer |
The page size |
|
java.lang.Integer |
The max order |
|
java.lang.Integer |
The chunk size |
|
java.lang.Integer |
The small cache size |
|
java.lang.Integer |
The normal cache size |
|
java.lang.Boolean |
Whether to use the cache for all threads |
|
java.lang.Integer |
The max cached buffer capacity |
|
java.lang.Integer |
The cache trim interval |
|
java.lang.Integer |
The max cached byte buffers per chunk |
Context Config Properties
🔗Property | Type | Description |
---|---|---|
|
boolean |
Whether watch is enabled. |
|
boolean |
Should the server be shutdown when a watch event fires. Note that if set to true an external process like {@code gradle run --continuous} or Kubernetes replication controller is required to restart the container. |
|
java.util.List |
The paths to watch. |
|
java.time.Duration |
The interval to wait between checks. |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.util.Map |
|
|
java.lang.String |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
java.lang.Integer |
number of threads |
|
the type |
|
|
java.lang.Integer |
the parallelism |
|
java.lang.Integer |
the core pool size |
|
java.lang.Boolean |
whether to use virtual threads |
|
java.lang.Class |
the thread factory class |
|
java.lang.String |
Sets the executor name. |
|
java.lang.Integer |
Sets the number of threads for FIXED. Default value (2 * Number of processors available to the Java virtual machine). |
Property | Type | Description |
---|---|---|
|
java.nio.charset.Charset |
|
|
java.lang.String |
The application name. Used to identify the application for purposes of reporting, tracing, service discovery etc. Should be unique. |
Discovery Core Config Properties
🔗Property | Type | Description |
---|---|---|
|
java.time.Duration |
|
|
boolean |
Property | Type | Description |
---|---|---|
|
boolean |
|
|
java.lang.String |
Function Config Properties
🔗Property | Type | Description |
---|---|---|
|
boolean |
If this is false then calls to {@link #isMediaTypeBinary(String)} will only check the additional types, and ignore the defaults. The defaults are: {@value MediaType#APPLICATION_OCTET_STREAM}, {@value MediaType#IMAGE_JPEG}, {@value MediaType#IMAGE_PNG}, {@value MediaType#IMAGE_GIF}, "application/zip" |
|
java.util.List |
The additional media types to consider binary. |
Http Client Core Config Properties
🔗Property | Type | Description |
---|---|---|
|
java.util.List |
|
|
java.util.List |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
boolean |
Whether connection pooling is enabled. [available in the Netty HTTP client] |
|
int |
Maximum number of futures awaiting connection acquisition. Defaults to no maximum. [available in the Netty HTTP client] |
|
java.time.Duration |
The time to wait to acquire a connection. [available in the Netty HTTP client] |
|
int |
The maximum number of <i>pending</i> (new) connections before they are assigned to a pool. [available in the Netty HTTP client] |
|
int |
The maximum number of requests (streams) that can run concurrently on one HTTP2 connection. [available in the Netty HTTP client] |
|
int |
The maximum number of concurrent HTTP1 connections in the pool. [available in the Netty HTTP client] |
|
int |
The maximum number of concurrent HTTP2 connections in the pool. [available in the Netty HTTP client] |
Property | Type | Description |
---|---|---|
|
java.util.List |
|
|
java.util.List |
Property | Type | Description |
---|---|---|
|
boolean |
Whether connection pooling is enabled. [available in the Netty HTTP client] |
|
int |
Maximum number of futures awaiting connection acquisition. Defaults to no maximum. [available in the Netty HTTP client] |
|
java.time.Duration |
The time to wait to acquire a connection. [available in the Netty HTTP client] |
|
int |
The maximum number of <i>pending</i> (new) connections before they are assigned to a pool. [available in the Netty HTTP client] |
|
int |
The maximum number of requests (streams) that can run concurrently on one HTTP2 connection. [available in the Netty HTTP client] |
|
int |
The maximum number of concurrent HTTP1 connections in the pool. [available in the Netty HTTP client] |
|
int |
The maximum number of concurrent HTTP2 connections in the pool. [available in the Netty HTTP client] |
Property | Type | Description |
---|---|---|
|
The HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}. |
|
|
[available in the Netty HTTP client]. |
|
|
java.lang.String |
[available in the Netty HTTP client]. |
|
||
|
boolean |
|
|
boolean |
|
|
java.lang.String |
|
|
java.nio.charset.Charset |
[available in the Netty HTTP client]. |
|
java.util.Map |
[available in the Netty HTTP client]. |
|
java.time.Duration |
|
|
java.time.Duration |
For streaming requests and WebSockets, the {@link #getReadTimeout()} method does not apply instead a configurable idle timeout is applied. [available in the Netty HTTP client] |
|
java.time.Duration |
[available in the Netty HTTP client]. |
|
java.time.Duration |
|
|
java.time.Duration |
[available in the Netty HTTP client]. |
|
java.time.Duration |
The amount of quiet period for shutdown. [available in the Netty HTTP client] |
|
java.time.Duration |
The amount of time to wait for shutdown. [available in the Netty HTTP client] |
|
java.lang.Integer |
[available in the Netty HTTP client]. |
|
java.lang.Class |
[available in the Netty HTTP client]. |
|
int |
[available in the Netty HTTP client]. |
|
java.net.Proxy$Type |
<p>The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties.</p> <p>Alternatively configure a {@code java.net.ProxySelector}</p> |
|
java.net.SocketAddress |
The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties. <p> Alternatively configure a {@code java.net.ProxySelector} |
|
java.lang.String |
|
|
java.lang.String |
|
|
java.net.ProxySelector |
|
|
The connection mode to use for <i>plaintext</i> (http as opposed to https) connections. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b> [available in the Netty HTTP client]. |
|
|
java.util.List |
The protocols to support for TLS ALPN. If HTTP 2 is included, this will also restrict the TLS cipher suites to those supported by the HTTP 2 standard. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b> [available in the Netty HTTP client]. |
|
boolean |
Whether to allow blocking a netty event loop with a call to {@link BlockingHttpClient}. When this is off (the default), any calls that block an event loop will throw an error. Such calls are almost always a mistake that can lead to hard-to-debug transient issues such as read timeouts. Only enable this setting if you are sure you won’t hit such a bug. |
Property | Type | Description |
---|---|---|
|
||
|
boolean |
|
|
int |
|
|
||
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.time.Duration |
|
|
boolean |
|
|
boolean |
|
|
boolean |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
The HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}. |
|
|
[available in the Netty HTTP client]. |
|
|
java.lang.String |
[available in the Netty HTTP client]. |
|
boolean |
|
|
boolean |
|
|
java.lang.String |
|
|
java.nio.charset.Charset |
[available in the Netty HTTP client]. |
|
java.util.Map |
[available in the Netty HTTP client]. |
|
java.time.Duration |
|
|
java.time.Duration |
For streaming requests and WebSockets, the {@link #getReadTimeout()} method does not apply instead a configurable idle timeout is applied. [available in the Netty HTTP client] |
|
java.time.Duration |
[available in the Netty HTTP client]. |
|
java.time.Duration |
|
|
java.time.Duration |
[available in the Netty HTTP client]. |
|
java.time.Duration |
The amount of quiet period for shutdown. [available in the Netty HTTP client] |
|
java.time.Duration |
The amount of time to wait for shutdown. [available in the Netty HTTP client] |
|
java.lang.Integer |
[available in the Netty HTTP client]. |
|
java.lang.Class |
[available in the Netty HTTP client]. |
|
int |
[available in the Netty HTTP client]. |
|
java.net.Proxy$Type |
<p>The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties.</p> <p>Alternatively configure a {@code java.net.ProxySelector}</p> |
|
java.net.SocketAddress |
The proxy to use. For authentication specify http.proxyUser and http.proxyPassword system properties. <p> Alternatively configure a {@code java.net.ProxySelector} |
|
java.lang.String |
|
|
java.lang.String |
|
|
java.net.ProxySelector |
|
|
The connection mode to use for <i>plaintext</i> (http as opposed to https) connections. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b> [available in the Netty HTTP client]. |
|
|
java.util.List |
The protocols to support for TLS ALPN. If HTTP 2 is included, this will also restrict the TLS cipher suites to those supported by the HTTP 2 standard. <br> <b>Note: If {@link #httpVersion} is set, this setting is ignored!</b> [available in the Netty HTTP client]. |
|
boolean |
Whether to allow blocking a netty event loop with a call to {@link BlockingHttpClient}. When this is off (the default), any calls that block an event loop will throw an error. Such calls are almost always a mistake that can lead to hard-to-debug transient issues such as read timeouts. Only enable this setting if you are sure you won’t hit such a bug. |
|
java.util.List |
The URLs. |
|
java.net.URI |
Sets the URL of the service. |
|
java.lang.String |
The URI to check the service for health status. |
|
boolean |
Whether the service health should be checked. |
|
java.lang.String |
The context path to use for requests. |
|
java.time.Duration |
The default duration to check health status. |
Property | Type | Description |
---|---|---|
|
boolean |
Whether deflate compression is enabled for client WebSocket connections. |
Property | Type | Description |
---|---|---|
|
boolean |
Whether deflate compression is enabled for client WebSocket connections. |
Http Config Properties
🔗Property | Type | Description |
---|---|---|
|
boolean |
|
|
int |
|
|
||
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.time.Duration |
|
|
boolean |
Sets whether to build a self-signed certificate. Default value (false). |
|
boolean |
Whether an OpenSSL-backed TLS implementation should be preferred if it’s on the classpath. {@code true} by default. |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
Property | Type | Description |
---|---|---|
|
java.util.List |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
boolean |
|
|
int |
|
|
||
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.time.Duration |
|
|
boolean |
Whether an OpenSSL-backed TLS implementation should be preferred if it’s on the classpath. {@code true} by default. |
|
boolean |
Sets whether to build a self-signed certificate. Default value (false). |
Property | Type | Description |
---|---|---|
|
boolean |
|
|
int |
|
|
||
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.time.Duration |
|
|
boolean |
Sets whether to build a self-signed certificate. Default value (false). |
|
boolean |
Whether an OpenSSL-backed TLS implementation should be preferred if it’s on the classpath. {@code true} by default. |
|
boolean |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
Http Netty Config Properties
🔗Property | Type | Description |
---|---|---|
|
io.netty.util.ResourceLeakDetector$Level |
Provides the value set for the resource leak detection. |
|
boolean |
Default value: true If {@code true}, netty event loop threads will implement project reactor {@link reactor.core.scheduler.NonBlocking} by default. Because of that, any Project Reactor’s blocking operations throw an exception on those threads. |
Property | Type | Description |
---|---|---|
|
int |
The number of threads |
|
java.lang.Integer |
The IO ratio (optional) |
|
boolean |
Whether native transport is to be preferred |
|
java.lang.String |
A named executor service to use (optional) |
|
java.time.Duration |
The shutdown quiet period |
|
java.time.Duration |
The shutdown timeout (must be >= shutdownQuietPeriod) |
Http Server Config Properties
🔗Property | Type | Description |
---|---|---|
|
java.io.File |
|
|
long |
|
|
boolean |
The default multipart enabled setting is false for servlets, but effectively true for Netty. This method returns the value only if set by the user. |
|
boolean |
|
|
boolean |
|
|
long |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
boolean |
|
|
java.util.List |
Property | Type | Description |
---|---|---|
|
boolean |
|
|
boolean |
|
|
java.util.Map |
|
|
boolean |
Property | Type | Description |
---|---|---|
|
The HTTP version to use. Defaults to {@link HttpVersion#HTTP_1_1}. |
|
|
||
|
java.nio.charset.Charset |
|
|
int |
|
|
java.lang.String |
|
|
java.lang.Integer |
|
|
long |
|
|
java.time.Duration |
|
|
java.time.Duration |
|
|
java.time.Duration |
|
|
java.lang.String |
|
|
boolean |
|
|
boolean |
|
|
java.lang.String |
|
|
java.lang.String |
|
|
boolean |
|
|
boolean |
|
|
boolean |
Set to true to dispatch OPTIONS requests. Default value (false. |
|
boolean |
Property | Type | Description |
---|---|---|
|
java.util.Locale |
|
|
java.lang.String |
|
|
java.util.Locale |
|
|
java.lang.String |
|
|
boolean |
Http Server Netty Config Properties
🔗Property | Type | Description |
---|---|---|
|
int |
QUIC initial_max_data setting, see RFC 9000. |
|
int |
QUIC initial_max_stream_data_bidi_local setting, see RFC 9000. |
|
int |
QUIC initial_max_stream_data_bidi_remote setting, see RFC 9000. |
|
int |
QUIC initial_max_streams_bidi setting, see RFC 9000. |
Property | Type | Description |
---|---|---|
|
NettyHttpServerConfiguration$NettyListenerConfiguration$Family |
The address family of this listener. |
|
boolean |
Whether to enable SSL on this listener. Also requires ssl.SslConfiguration#isEnabled() to be set. |
|
java.lang.String |
For TCP listeners, the host to bind to, or {@code null} to bind to all hosts. |
|
int |
The TCP port to bind to. May be {@code -1} to bind to a random port. |
|
java.lang.String |
For UNIX domain sockets, the path of the socket. For abstract domain sockets, this should start with a NUL byte. |
|
boolean |
Whether to expose default routes on this listener. |
|
java.lang.Integer |
The fixed file descriptor for this listener, or {@code null} if a new file descriptor should be opened (the default). |
|
boolean |
Whether the server should bind to the socket. {@code true} by default. If set to {@code false}, the socket must already be bound and listening. |
|
boolean |
Whether to create a server socket. This is on by default. Turning it off only makes sense in combination with {@link #acceptedFd}. |
|
java.lang.Integer |
An already accepted socket fd that should be registered to this listener. |
Property | Type | Description |
---|---|---|
|
java.lang.Long |
Gets the {@code SETTINGS_HEADER_TABLE_SIZE} value. If unavailable, returns {@code null}. |
|
java.lang.Boolean |
Gets the {@code SETTINGS_ENABLE_PUSH} value. If unavailable, returns {@code null}. |
|
java.lang.Long |
Gets the {@code SETTINGS_MAX_CONCURRENT_STREAMS} value. If unavailable, returns {@code null}. |
|
java.lang.Integer |
Gets the {@code SETTINGS_INITIAL_WINDOW_SIZE} value. If unavailable, returns {@code null}. |
|
java.lang.Integer |
Gets the {@code SETTINGS_MAX_FRAME_SIZE} value. If unavailable, returns {@code null}. |
|
java.lang.Long |
Gets the {@code SETTINGS_MAX_HEADER_LIST_SIZE} value. If unavailable, returns {@code null}. |
Property | Type | Description |
---|---|---|
|
boolean |
Property | Type | Description |
---|---|---|
|
java.lang.String |
Sets the name to use. |
|
int |
Sets the number of threads for the event loop group. |
|
java.lang.Integer |
|
|
java.lang.String |
Sets the name of the executor. |
|
boolean |
Set whether to prefer the native transport if available |
|
java.time.Duration |
Set the shutdown quiet period |
|
java.time.Duration |
Set the shutdown timeout (must be >= shutdownQuietPeriod) |
Property | Type | Description |
---|---|---|
|
java.lang.String |
Sets the name to use. |
|
int |
Sets the number of threads for the event loop group. |
|
java.lang.Integer |
|
|
java.lang.String |
Sets the name of the executor. |
|
boolean |
Set whether to prefer the native transport if available |
|
java.time.Duration |
Set the shutdown quiet period |
|
java.time.Duration |
Set the shutdown timeout (must be >= shutdownQuietPeriod) |
Property | Type | Description |
---|---|---|
|
int |
Property | Type | Description |
---|---|---|
|
||
|
boolean |
If a 100-continue response is detected but the content length is too large then true means close the connection. otherwise the connection will remain open and data will be consumed and discarded until the next request is received. <p>only relevant when {@link HttpServerType#FULL_CONTENT} is set</p> |
|
java.lang.String |
|
|
io.netty.handler.logging.LogLevel |
The server {@link LogLevel} to enable. |
|
int |
The maximum length of the initial HTTP request line. Defaults to 4096. |
|
int |
The maximum size of an individual HTTP setter. Defaults to 8192. |
|
int |
The maximum chunk size. Defaults to 8192. |
|
int |
The maximum size of the body of the HTTP1.1 request used to upgrade a connection to HTTP2 clear-text (h2c). This initial request cannot be streamed and is instead buffered in full, so the default value (8192) is relatively small. <i>If this value is too small for your use case, instead consider using an empty initial "upgrade request" (e.g. {@code OPTIONS /}), or switch to normal HTTP2.</i> <p> <i>Does not affect normal HTTP2 (TLS).</i> |
|
boolean |
Whether chunked requests are supported. |
|
boolean |
Whether to use netty’s native transport (epoll or kqueue) if available. |
|
boolean |
Whether to validate headers. |
|
int |
The initial buffer size. Defaults to 128. |
|
int |
The default compression threshold. Defaults to 1024. <p> A value {@code < 0} indicates compression should never be enabled. |
|
int |
The default compression level. Default value (6). |
|
java.util.Map |
|
|
java.util.Map |
|
|
boolean |
|
|
java.lang.String |
The path pattern to use for logging incoming connections to pcap. This is an unsupported option: Behavior may change, or it may disappear entirely, without notice! |
|
java.util.List |
Get the explicit netty listener configurations, or {@code null} if they should be implicit. |
|
boolean |
Parse incoming JSON data eagerly, before route binding. Default value {@value DEFAULT_EAGER_PARSING}. |
|
int |
Maximum number of buffers to keep around in JSON parsing before they should be consolidated. Defaults to 4096. |
|
boolean |
Prior to 4.4.0, the Micronaut HTTP server used a multi-pipeline approach for handling HTTP/2 connections where every request got its own netty pipeline with HTTP/2 to HTTP/1.1 converters on the pipeline. This allowed for using mostly unchanged HTTP/1.1 in the request handling and any NettyServerCustomizers. <p> As of 4.4.0, this approach was replaced with a more performant HTTP/2-specific implementation. This means worse compatibility with HTTP/1.1-based code paths and customizers, however. Setting this option to {@code true} returns to the old behavior. |
Property | Type | Description |
---|---|---|
|
boolean |
Returns whether the access logger is enabled. |
|
java.lang.String |
The logger name to use. Access logs will be logged at info level. |
|
java.lang.String |
Returns the log format to use. |
|
java.util.List |
Jackson Databind Config Properties
🔗Property | Type | Description |
---|---|---|
|
boolean |
Whether the BeanIntrospection should be used for reflection free object serialialization/deserialialization. |
|
boolean |
Whether Jackson modules should be scanned for. |
|
com.fasterxml.jackson.annotation.JsonInclude$Include |
|
|
com.fasterxml.jackson.databind.ObjectMapper$DefaultTyping |
|
|
java.util.Locale |
|
|
java.util.TimeZone |
|
|
java.lang.String |
|
|
int |
|
|
com.fasterxml.jackson.databind.PropertyNamingStrategy |
|
|
boolean |
Whether _embedded.errors should always be serialized as list. If set to false, _embedded.errors with 1 element will be serialized as an object. |
|
boolean |
Whether strings should be trimmed when deserializing. If the resulting string is an empty string, then null will be applied instead. |
|
java.util.Map |
Sets the serialization features to use. |
|
java.util.Map |
Sets the deserialization features to use. |
|
java.util.Map |
Sets the object mapper features to use. |
|
java.util.Map |
Sets the parser features to use. |
|
java.util.Map |
Sets the generator features to use. |
|
java.util.Map |
Sets the factory features to use. |
Management Config Properties
🔗Property | Type | Description |
---|---|---|
|
java.lang.Boolean |
|
|
java.lang.Boolean |
Property | Type | Description |
---|---|---|
|
boolean |
|
|
java.io.File |
|
|
long |
Property | Type | Description |
---|---|---|
|
boolean |
Whether the ServiceReadyHealthIndicator is enabled. Defaults to {@code true}. |
|
Property | Type | Description |
---|---|---|
|
java.util.Map |
Property | Type | Description |
---|---|---|
|
boolean |
Property | Type | Description |
---|---|---|
|
boolean |
Health indicator is enabled. Default is true. |
Property | Type | Description |
---|---|---|
|
java.lang.String |
|
|
java.lang.Boolean |
|
|
java.lang.Boolean |
|
|
java.lang.Integer |
Router Config Properties
🔗Property | Type | Description |
---|---|---|
|
java.util.List |
|
|
boolean |
Property | Type | Description |
---|---|---|
|
boolean |
|
|
java.lang.String |
Property | Type | Description |
---|---|---|
|
java.util.List |
|
|
boolean |
Property | Type | Description |
---|---|---|
|
boolean |
|
|
java.lang.String |
The static resource mapping. |
|
java.util.List |
A list of paths either starting with |