Configuration Reference
Version:6.2.0-SNAPSHOT
Micronaut Http Poja Apache Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
Sets whether the Apache POJA runtime is enabled. |
| Property | Type | Description | Default value |
|---|---|---|---|
|
int |
The size of the buffer that is used to read and parse the HTTP request (in bytes). Default value is 8192 (8Kb). |
8192 |
|
int |
The size of the buffer that is used to write the HTTP response (in bytes). Default value is 8192 (8Kb). |
8192 |
|
boolean |
When true, the inherited channel will be used by if present. Otherwise, STDIN and STDOUT will be used. |
true |
Micronaut Http Server Jdk Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
|||
|
|||
|
boolean |
||
|
java.nio.charset.Charset |
||
|
int |
||
|
java.lang.String |
||
|
java.lang.Integer |
||
|
long |
||
|
long |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
|||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
boolean |
Sets whether the JDK HTTP server runtime is enabled. |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
Enables the access log. Default value ({@code false}). |
|
|
java.lang.String |
Sets the logger name. Default value ("HTTP_ACCESS_LOGGER"). |
|
|
java.util.List |
Sets the paths to exclude from the log, as regular expressions matched against the request path. |
Micronaut Http Server Jetty Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
|||
|
|||
|
boolean |
||
|
java.nio.charset.Charset |
||
|
int |
||
|
java.lang.String |
||
|
java.lang.Integer |
||
|
long |
||
|
long |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
|||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
boolean |
Sets whether the Jetty runtime is enabled. |
|
|
boolean |
Serve static resources with Jetty’s own {@code ResourceHandler} instead of the Micronaut static resource resolver. Jetty’s handler supports range requests and conditional caching natively, but sits outside the Micronaut filter chain, so Micronaut filters (including CORS) do not see those requests and the {@code cache-control} setting of each static resource configuration applies instead of {@code micronaut.server.responses.file}. Default value (false). |
|
|
java.util.Map |
Sets the servlet init parameters. |
| Property | Type | Description | Default value |
|---|---|---|---|
|
java.util.List |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
boolean |
||
|
int |
||
|
java.lang.String |
||
|
boolean |
||
|
long |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.lang.String |
||
|
int |
||
|
int |
||
|
long |
||
|
long |
||
|
org.eclipse.jetty.http.HttpCompliance |
||
|
org.eclipse.jetty.http.UriCompliance |
||
|
org.eclipse.jetty.http.UriCompliance |
||
|
org.eclipse.jetty.http.CookieCompliance |
||
|
org.eclipse.jetty.http.CookieCompliance |
||
|
org.eclipse.jetty.http.MultiPartCompliance |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.net.SocketAddress |
||
|
org.eclipse.jetty.util.HostPort |
||
|
int |
| Property | Type | Description | Default value |
|---|---|---|---|
|
java.util.List |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
boolean |
||
|
int |
||
|
java.lang.String |
||
|
boolean |
||
|
long |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.lang.String |
||
|
int |
||
|
int |
||
|
long |
||
|
long |
||
|
org.eclipse.jetty.http.HttpCompliance |
||
|
org.eclipse.jetty.http.UriCompliance |
||
|
org.eclipse.jetty.http.UriCompliance |
||
|
org.eclipse.jetty.http.CookieCompliance |
||
|
org.eclipse.jetty.http.CookieCompliance |
||
|
org.eclipse.jetty.http.MultiPartCompliance |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.net.SocketAddress |
||
|
org.eclipse.jetty.util.HostPort |
||
|
int |
| Property | Type | Description | Default value |
|---|---|---|---|
|
java.lang.String |
sets the fileName attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}. |
|
|
boolean |
Whether access log is enabled. |
|
|
java.lang.String |
sets the resourcePath attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}. |
|
|
boolean |
sets the quiet attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}. |
|
|
java.lang.String |
Sets the pattern to use for the access log. Defaults to CustomRequestLog.EXTENDED_NCSA_FORMAT. |
| Property | Type | Description | Default value |
|---|---|---|---|
|
java.lang.String |
||
|
int |
||
|
boolean |
||
|
java.lang.String |
||
|
java.lang.String |
| Property | Type | Description | Default value |
|---|---|---|---|
|
java.lang.Throwable |
||
|
long |
||
|
long |
||
|
boolean |
||
|
int |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
int |
||
|
boolean |
||
|
int |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
int |
||
|
boolean |
Set whether SSL should be used if configured. |
|
|
org.eclipse.jetty.util.component.AbstractLifeCycle$State |
||
|
boolean |
||
|
boolean |
||
|
org.eclipse.jetty.util.component.Graceful$Shutdown |
||
|
long |
||
|
long |
||
|
java.lang.String |
||
|
org.eclipse.jetty.server.ConnectionFactory |
||
|
java.lang.String |
||
|
int |
||
|
boolean |
||
|
org.eclipse.jetty.util.thread.ThreadPoolBudget$Lease |
||
|
java.lang.String |
||
|
int |
||
|
java.nio.channels.ServerSocketChannel |
||
|
boolean |
||
|
int |
||
|
int |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
int |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
||
|
boolean |
||
|
long |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
long |
||
|
boolean |
||
|
org.eclipse.jetty.http.HttpField |
Micronaut Http Server Tomcat Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
|||
|
|||
|
boolean |
||
|
java.nio.charset.Charset |
||
|
int |
||
|
java.lang.String |
||
|
java.lang.Integer |
||
|
long |
||
|
long |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
|||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
java.lang.String |
The protocol to use. Defaults to org.apache.coyote.http11.Http11NioProtocol. |
|
|
boolean |
Sets whether the Tomcat runtime is enabled. |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
||
|
java.lang.String |
||
|
org.apache.catalina.Service |
||
|
boolean |
||
|
boolean |
||
|
long |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
java.lang.String |
||
|
int |
||
|
int |
||
|
java.lang.String |
||
|
int |
||
|
int |
||
|
java.lang.String |
||
|
boolean |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
||
|
java.lang.String |
||
|
org.apache.catalina.Service |
||
|
boolean |
||
|
boolean |
||
|
long |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
int |
||
|
java.lang.String |
||
|
int |
||
|
int |
||
|
java.lang.String |
||
|
int |
||
|
int |
||
|
java.lang.String |
||
|
boolean |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
||
|
org.apache.catalina.LifecycleState |
||
|
java.lang.String |
||
|
boolean |
||
|
int |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
int |
||
|
java.lang.String |
||
|
boolean |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
javax.management.ObjectName |
||
|
org.apache.juli.logging.Log |
||
|
java.lang.String |
||
|
org.apache.catalina.valves.AbstractAccessLogValve$AccessLogElement |
||
|
org.apache.catalina.valves.AbstractAccessLogValve$CachedElement |
||
|
boolean |
||
|
java.lang.String |
||
|
java.io.PrintWriter |
||
|
java.text.SimpleDateFormat |
||
|
java.io.File |
||
|
long |
||
|
boolean |
Micronaut Http Server Undertow Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
|||
|
|||
|
boolean |
||
|
java.nio.charset.Charset |
||
|
int |
||
|
java.lang.String |
||
|
java.lang.Integer |
||
|
long |
||
|
long |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.time.Duration |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
|||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
boolean |
||
|
int |
||
|
boolean |
Sets whether the Undertow runtime is enabled. |
|
|
java.util.Map |
Sets the worker options. |
|
|
java.util.Map |
Sets the socket options. |
|
|
java.util.Map |
The server options. |
| Property | Type | Description | Default value |
|---|---|---|---|
|
int |
||
|
int |
||
|
int |
||
|
boolean |
||
|
io.undertow.server.HttpHandler |
||
|
org.xnio.XnioWorker |
||
|
java.util.concurrent.Executor |
||
|
io.undertow.connector.ByteBufferPool |
| Property | Type | Description | Default value |
|---|---|---|---|
|
int |
||
|
int |
||
|
int |
||
|
boolean |
||
|
io.undertow.server.HttpHandler |
||
|
org.xnio.XnioWorker |
||
|
java.util.concurrent.Executor |
||
|
io.undertow.connector.ByteBufferPool |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
Sets whether enabled. |
|
|
java.lang.String |
Sets the underlow log pattern. <p>See https://undertow.io/javadoc/1.4.x/io/undertow/server/handlers/accesslog/AccessLogHandler.html for more.</p> |
| Property | Type | Description | Default value |
|---|---|---|---|
|
java.nio.file.Path |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
| Property | Type | Description | Default value |
|---|---|---|---|
|
java.nio.file.Path |
||
|
java.lang.String |
||
|
java.lang.String |
||
|
boolean |
Micronaut Servlet Core Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
java.lang.String |
The mapping |
/** |
|
java.util.List |
The paths |
|
|
boolean |
true |
|
|
java.lang.String |
For Jetty based servers, allow configuring the cache control header for static resource mappings (defaults to "private,max-age=60"). <p>Only applied when {@code micronaut.server.jetty.native-static-resources} is {@code true}. Otherwise static resources are served by the Micronaut static resource resolver, on Jetty as on every other runtime, and the header is governed by {@code micronaut.server.responses.file}.</p> |
private,max-age=60 |
Micronaut Servlet Engine Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
java.lang.String |
The name of the servlet |
micronaut |
|
java.lang.String |
The servlet mapping |
/* |
|
boolean |
Set whether async is supported or not. |
|
|
java.lang.Boolean |
Legacy property to disable async for testing. |
|
|
boolean |
Whether virtual threads are enabled. |
|
|
boolean |
Is async file serving enabled. |
|
|
java.lang.Integer |
Specify the minimum number of threads in the created thread pool. |
|
|
java.lang.Integer |
Specify the maximum number of threads in the created thread pool. |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
Whether responses are compressed when the client accepts it |
|
|
int |
The size a response must reach before it is compressed, in bytes |
|
|
java.util.Set |
The content types that are compressed |
Micronaut Servlet Websocket Config Properties
🔗| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
Whether WebSocket support is enabled. Defaults to {@code true}. |
|
|
int |
The maximum size in bytes of an inbound text message. Default value (65536). |
|
|
int |
The maximum size in bytes of an inbound binary message. Default value (65536). |
|
|
java.time.Duration |
How long a session may stay idle before it is closed, or {@code null} to inherit {@code micronaut.server.idle-timeout} |
|
|
java.time.Duration |
How long an asynchronous send may take before it fails, or {@code null} to use the container default |
|
|
java.time.Duration |
How long {@code WebSocketContainer#connectToServer} waits for a client endpoint’s {@code @OnOpen} to complete before failing the connection. Default value 30 seconds. |
|
|
int |
The number of queued sends beyond which a session reports that it is not writable. Default value (64). |
| Property | Type | Description | Default value |
|---|---|---|---|
|
boolean |
Whether {@code permessage-deflate} may be negotiated. Defaults to {@code true}. |