Configuration Reference

Version:5.6.0

Micronaut Http Poja Apache Config Properties

🔗
Table 1. Configuration Properties for ApacheServletConfiguration
Property Type Description Default value

poja.apache.input-buffer-size

int

The size of the buffer that is used to read and parse the HTTP request (in bytes). Default value is 8192 (8Kb).

8192

poja.apache.output-buffer-size

int

The size of the buffer that is used to write the HTTP response (in bytes). Default value is 8192 (8Kb).

8192

poja.apache.use-inherited-channel

boolean

When true, the inherited channel will be used by if present. Otherwise, STDIN and STDOUT will be used.

true

Micronaut Http Server Jetty Config Properties

🔗
Table 2. Configuration Properties for JettyConfiguration
Property Type Description Default value

micronaut.server.http-version

HttpVersion

micronaut.server.thread-selection

ThreadSelection

micronaut.server.default-charset

java.nio.charset.Charset

micronaut.server.port

int

micronaut.server.host

java.lang.String

micronaut.server.read-timeout

java.lang.Integer

micronaut.server.max-request-size

long

micronaut.server.max-request-buffer-size

long

micronaut.server.read-idle-timeout

java.time.Duration

micronaut.server.write-idle-timeout

java.time.Duration

micronaut.server.idle-timeout

java.time.Duration

micronaut.server.server-header

java.lang.String

micronaut.server.date-header

boolean

micronaut.server.log-handled-exceptions

boolean

micronaut.server.client-address-header

java.lang.String

micronaut.server.context-path

java.lang.String

micronaut.server.dual-protocol

boolean

micronaut.server.http-to-https-redirect

boolean

micronaut.server.dispatch-options-requests

boolean

micronaut.server.validate-url

boolean

micronaut.server.escape-html-url

boolean

micronaut.server.not-found-on-missing-body

boolean

micronaut.server.semicolon-is-normal-char

boolean

micronaut.server.max-params

int

micronaut.server.jetty.init-parameters

java.util.Map

Sets the servlet init parameters.
🔗
Table 3. Configuration Properties for HttpConfiguration
Property Type Description Default value

micronaut.server.jetty.customizers

java.util.List

micronaut.server.jetty.input-buffer-size

int

micronaut.server.jetty.output-buffer-size

int

micronaut.server.jetty.output-aggregation-size

int

micronaut.server.jetty.request-header-size

int

micronaut.server.jetty.response-header-size

int

micronaut.server.jetty.max-response-header-size

int

micronaut.server.jetty.header-cache-size

int

micronaut.server.jetty.header-cache-case-sensitive

boolean

micronaut.server.jetty.secure-port

int

micronaut.server.jetty.secure-scheme

java.lang.String

micronaut.server.jetty.persistent-connections-enabled

boolean

micronaut.server.jetty.idle-timeout

long

micronaut.server.jetty.send-server-version

boolean

micronaut.server.jetty.send-xpowered-by

boolean

micronaut.server.jetty.send-date-header

boolean

micronaut.server.jetty.use-input-direct-byte-buffers

boolean

micronaut.server.jetty.use-output-direct-byte-buffers

boolean

micronaut.server.jetty.form-encoded-methods

java.lang.String

micronaut.server.jetty.max-error-dispatches

int

micronaut.server.jetty.min-input-buffer-space

int

micronaut.server.jetty.min-request-data-rate

long

micronaut.server.jetty.min-response-data-rate

long

micronaut.server.jetty.http-compliance

org.eclipse.jetty.http.HttpCompliance

micronaut.server.jetty.uri-compliance

org.eclipse.jetty.http.UriCompliance

micronaut.server.jetty.redirect-uri-compliance

org.eclipse.jetty.http.UriCompliance

micronaut.server.jetty.request-cookie-compliance

org.eclipse.jetty.http.CookieCompliance

micronaut.server.jetty.response-cookie-compliance

org.eclipse.jetty.http.CookieCompliance

micronaut.server.jetty.multi-part-compliance

org.eclipse.jetty.http.MultiPartCompliance

micronaut.server.jetty.notify-remote-async-errors

boolean

micronaut.server.jetty.relative-redirect-allowed

boolean

micronaut.server.jetty.generate-redirect-body

boolean

micronaut.server.jetty.local-address

java.net.SocketAddress

micronaut.server.jetty.server-authority

org.eclipse.jetty.util.HostPort

micronaut.server.jetty.max-unconsumed-request-content-reads

int
🔗
Table 4. Configuration Properties for HttpConfiguration
Property Type Description Default value

micronaut.server.jetty.customizers

java.util.List

micronaut.server.jetty.input-buffer-size

int

micronaut.server.jetty.output-buffer-size

int

micronaut.server.jetty.output-aggregation-size

int

micronaut.server.jetty.request-header-size

int

micronaut.server.jetty.response-header-size

int

micronaut.server.jetty.max-response-header-size

int

micronaut.server.jetty.header-cache-size

int

micronaut.server.jetty.header-cache-case-sensitive

boolean

micronaut.server.jetty.secure-port

int

micronaut.server.jetty.secure-scheme

java.lang.String

micronaut.server.jetty.persistent-connections-enabled

boolean

micronaut.server.jetty.idle-timeout

long

micronaut.server.jetty.send-server-version

boolean

micronaut.server.jetty.send-xpowered-by

boolean

micronaut.server.jetty.send-date-header

boolean

micronaut.server.jetty.use-input-direct-byte-buffers

boolean

micronaut.server.jetty.use-output-direct-byte-buffers

boolean

micronaut.server.jetty.form-encoded-methods

java.lang.String

micronaut.server.jetty.max-error-dispatches

int

micronaut.server.jetty.min-input-buffer-space

int

micronaut.server.jetty.min-request-data-rate

long

micronaut.server.jetty.min-response-data-rate

long

micronaut.server.jetty.http-compliance

org.eclipse.jetty.http.HttpCompliance

micronaut.server.jetty.uri-compliance

org.eclipse.jetty.http.UriCompliance

micronaut.server.jetty.redirect-uri-compliance

org.eclipse.jetty.http.UriCompliance

micronaut.server.jetty.request-cookie-compliance

org.eclipse.jetty.http.CookieCompliance

micronaut.server.jetty.response-cookie-compliance

org.eclipse.jetty.http.CookieCompliance

micronaut.server.jetty.multi-part-compliance

org.eclipse.jetty.http.MultiPartCompliance

micronaut.server.jetty.notify-remote-async-errors

boolean

micronaut.server.jetty.relative-redirect-allowed

boolean

micronaut.server.jetty.generate-redirect-body

boolean

micronaut.server.jetty.local-address

java.net.SocketAddress

micronaut.server.jetty.server-authority

org.eclipse.jetty.util.HostPort

micronaut.server.jetty.max-unconsumed-request-content-reads

int
🔗
Table 5. Configuration Properties for JettyConfiguration$JettyRequestLog
Property Type Description Default value

micronaut.server.jetty.access-log.file-name

java.lang.String

sets the fileName attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}.

micronaut.server.jetty.access-log.enabled

boolean

Whether access log is enabled.

micronaut.server.jetty.access-log.resource-path

java.lang.String

sets the resourcePath attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}.

micronaut.server.jetty.access-log.quiet

boolean

sets the quiet attribute for {@link ch.qos.logback.access.jetty.RequestLogImpl}.

micronaut.server.jetty.access-log.pattern

java.lang.String

Sets the pattern to use for the access log. Defaults to CustomRequestLog.EXTENDED_NCSA_FORMAT.
🔗
Table 6. Configuration Properties for RequestLogWriter
Property Type Description Default value

micronaut.server.jetty.access-log.filename

java.lang.String

micronaut.server.jetty.access-log.retain-days

int

micronaut.server.jetty.access-log.append

boolean

micronaut.server.jetty.access-log.filename-date-format

java.lang.String

micronaut.server.jetty.access-log.time-zone

java.lang.String
🔗
Table 7. Configuration Properties for JettyConfiguration$ConnectorConfiguration
Property Type Description Default value

micronaut.server.jetty.connectors.*.idle-timeout

long

micronaut.server.jetty.connectors.*.shutdown-idle-timeout

long

micronaut.server.jetty.connectors.*.accepting

boolean

micronaut.server.jetty.connectors.*.acceptor-priority-delta

int

micronaut.server.jetty.connectors.*.default-protocol

java.lang.String

micronaut.server.jetty.connectors.*.name

java.lang.String

micronaut.server.jetty.connectors.*.host

java.lang.String

micronaut.server.jetty.connectors.*.port

int

micronaut.server.jetty.connectors.*.inherit-channel

boolean

micronaut.server.jetty.connectors.*.accept-queue-size

int

micronaut.server.jetty.connectors.*.reuse-address

boolean

micronaut.server.jetty.connectors.*.reuse-port

boolean

micronaut.server.jetty.connectors.*.accepted-tcp-no-delay

boolean

micronaut.server.jetty.connectors.*.accepted-receive-buffer-size

int

micronaut.server.jetty.connectors.*.accepted-send-buffer-size

int

micronaut.server.jetty.connectors.*.ssl-enabled

boolean

Set whether SSL should be used if configured.
🔗
Table 8. Configuration Properties for JettyConfiguration$JettySslConfiguration
Property Type Description Default value

micronaut.server.jetty.ssl.sni-host-check

boolean

micronaut.server.jetty.ssl.sni-required

boolean

micronaut.server.jetty.ssl.sts-max-age

long

micronaut.server.jetty.ssl.sts-include-sub-domains

boolean

Micronaut Http Server Tomcat Config Properties

🔗
Table 9. Configuration Properties for TomcatConfiguration
Property Type Description Default value

micronaut.server.http-version

HttpVersion

micronaut.server.thread-selection

ThreadSelection

micronaut.server.default-charset

java.nio.charset.Charset

micronaut.server.port

int

micronaut.server.host

java.lang.String

micronaut.server.read-timeout

java.lang.Integer

micronaut.server.max-request-size

long

micronaut.server.max-request-buffer-size

long

micronaut.server.read-idle-timeout

java.time.Duration

micronaut.server.write-idle-timeout

java.time.Duration

micronaut.server.idle-timeout

java.time.Duration

micronaut.server.server-header

java.lang.String

micronaut.server.date-header

boolean

micronaut.server.log-handled-exceptions

boolean

micronaut.server.client-address-header

java.lang.String

micronaut.server.context-path

java.lang.String

micronaut.server.dual-protocol

boolean

micronaut.server.http-to-https-redirect

boolean

micronaut.server.dispatch-options-requests

boolean

micronaut.server.validate-url

boolean

micronaut.server.escape-html-url

boolean

micronaut.server.not-found-on-missing-body

boolean

micronaut.server.semicolon-is-normal-char

boolean

micronaut.server.max-params

int

micronaut.server.tomcat.protocol

java.lang.String

The protocol to use. Defaults to org.apache.coyote.http11.Http11NioProtocol.
🔗
Table 10. Configuration Properties for Connector
Property Type Description Default value

micronaut.server.tomcat.throw-on-failure

boolean

micronaut.server.tomcat.domain

java.lang.String

micronaut.server.tomcat.service

org.apache.catalina.Service

micronaut.server.tomcat.allow-backslash

boolean

micronaut.server.tomcat.allow-trace

boolean

micronaut.server.tomcat.async-timeout

long

micronaut.server.tomcat.discard-facades

boolean

micronaut.server.tomcat.enable-lookups

boolean

micronaut.server.tomcat.enforce-encoding-in-get-writer

boolean

micronaut.server.tomcat.max-cookie-count

int

micronaut.server.tomcat.max-parameter-count

int

micronaut.server.tomcat.max-part-count

int

micronaut.server.tomcat.max-part-header-size

int

micronaut.server.tomcat.max-post-size

int

micronaut.server.tomcat.max-save-post-size

int

micronaut.server.tomcat.parse-body-methods

java.lang.String

micronaut.server.tomcat.port

int

micronaut.server.tomcat.port-offset

int

micronaut.server.tomcat.proxy-name

java.lang.String

micronaut.server.tomcat.proxy-port

int

micronaut.server.tomcat.redirect-port

int

micronaut.server.tomcat.scheme

java.lang.String

micronaut.server.tomcat.secure

boolean

micronaut.server.tomcat.uriencoding

java.lang.String

micronaut.server.tomcat.use-body-encoding-for-uri

boolean

micronaut.server.tomcat.xpowered-by

boolean

micronaut.server.tomcat.use-ipvhosts

boolean

micronaut.server.tomcat.encoded-reverse-solidus-handling

java.lang.String

micronaut.server.tomcat.encoded-solidus-handling

java.lang.String

micronaut.server.tomcat.reject-suspicious-uris

boolean
🔗
Table 11. Configuration Properties for Connector
Property Type Description Default value

micronaut.server.tomcat.throw-on-failure

boolean

micronaut.server.tomcat.domain

java.lang.String

micronaut.server.tomcat.service

org.apache.catalina.Service

micronaut.server.tomcat.allow-backslash

boolean

micronaut.server.tomcat.allow-trace

boolean

micronaut.server.tomcat.async-timeout

long

micronaut.server.tomcat.discard-facades

boolean

micronaut.server.tomcat.enable-lookups

boolean

micronaut.server.tomcat.enforce-encoding-in-get-writer

boolean

micronaut.server.tomcat.max-cookie-count

int

micronaut.server.tomcat.max-parameter-count

int

micronaut.server.tomcat.max-part-count

int

micronaut.server.tomcat.max-part-header-size

int

micronaut.server.tomcat.max-post-size

int

micronaut.server.tomcat.max-save-post-size

int

micronaut.server.tomcat.parse-body-methods

java.lang.String

micronaut.server.tomcat.port

int

micronaut.server.tomcat.port-offset

int

micronaut.server.tomcat.proxy-name

java.lang.String

micronaut.server.tomcat.proxy-port

int

micronaut.server.tomcat.redirect-port

int

micronaut.server.tomcat.scheme

java.lang.String

micronaut.server.tomcat.secure

boolean

micronaut.server.tomcat.uriencoding

java.lang.String

micronaut.server.tomcat.use-body-encoding-for-uri

boolean

micronaut.server.tomcat.xpowered-by

boolean

micronaut.server.tomcat.use-ipvhosts

boolean

micronaut.server.tomcat.encoded-reverse-solidus-handling

java.lang.String

micronaut.server.tomcat.encoded-solidus-handling

java.lang.String

micronaut.server.tomcat.reject-suspicious-uris

boolean
🔗
Table 12. Configuration Properties for TomcatConfiguration$AccessLogConfiguration
Property Type Description Default value

micronaut.server.tomcat.access-log.throw-on-failure

boolean

micronaut.server.tomcat.access-log.domain

java.lang.String

micronaut.server.tomcat.access-log.async-supported

boolean

micronaut.server.tomcat.access-log.max-log-message-buffer-size

int

micronaut.server.tomcat.access-log.ipv6-canonical

boolean

micronaut.server.tomcat.access-log.request-attributes-enabled

boolean

micronaut.server.tomcat.access-log.enabled

boolean

micronaut.server.tomcat.access-log.pattern

java.lang.String

micronaut.server.tomcat.access-log.condition

java.lang.String

micronaut.server.tomcat.access-log.condition-unless

java.lang.String

micronaut.server.tomcat.access-log.condition-if

java.lang.String

micronaut.server.tomcat.access-log.locale

java.lang.String

micronaut.server.tomcat.access-log.max-days

int

micronaut.server.tomcat.access-log.directory

java.lang.String

micronaut.server.tomcat.access-log.check-exists

boolean

micronaut.server.tomcat.access-log.prefix

java.lang.String

micronaut.server.tomcat.access-log.rotatable

boolean

micronaut.server.tomcat.access-log.rename-on-rotate

boolean

micronaut.server.tomcat.access-log.buffered

boolean

micronaut.server.tomcat.access-log.suffix

java.lang.String

micronaut.server.tomcat.access-log.file-date-format

java.lang.String

micronaut.server.tomcat.access-log.encoding

java.lang.String

Micronaut Http Server Undertow Config Properties

🔗
Table 13. Configuration Properties for UndertowConfiguration
Property Type Description Default value

micronaut.server.http-version

HttpVersion

micronaut.server.thread-selection

ThreadSelection

micronaut.server.default-charset

java.nio.charset.Charset

micronaut.server.port

int

micronaut.server.host

java.lang.String

micronaut.server.read-timeout

java.lang.Integer

micronaut.server.max-request-size

long

micronaut.server.max-request-buffer-size

long

micronaut.server.read-idle-timeout

java.time.Duration

micronaut.server.write-idle-timeout

java.time.Duration

micronaut.server.idle-timeout

java.time.Duration

micronaut.server.server-header

java.lang.String

micronaut.server.date-header

boolean

micronaut.server.log-handled-exceptions

boolean

micronaut.server.client-address-header

java.lang.String

micronaut.server.context-path

java.lang.String

micronaut.server.dual-protocol

boolean

micronaut.server.http-to-https-redirect

boolean

micronaut.server.dispatch-options-requests

boolean

micronaut.server.validate-url

boolean

micronaut.server.escape-html-url

boolean

micronaut.server.not-found-on-missing-body

boolean

micronaut.server.semicolon-is-normal-char

boolean

micronaut.server.max-params

int

micronaut.server.undertow.worker-options

java.util.Map

Sets the worker options.

micronaut.server.undertow.socket-options

java.util.Map

Sets the socket options.

micronaut.server.undertow.server-options

java.util.Map

The server options.
🔗
Table 14. Configuration Properties for Undertow$Builder
Property Type Description Default value

micronaut.server.undertow.buffer-size

int

micronaut.server.undertow.io-threads

int

micronaut.server.undertow.worker-threads

int

micronaut.server.undertow.direct-buffers

boolean

micronaut.server.undertow.handler

io.undertow.server.HttpHandler

micronaut.server.undertow.worker

org.xnio.XnioWorker

micronaut.server.undertow.ssl-engine-delegated-task-executor

java.util.concurrent.Executor

micronaut.server.undertow.byte-buffer-pool

io.undertow.connector.ByteBufferPool
🔗
Table 15. Configuration Properties for Undertow$Builder
Property Type Description Default value

micronaut.server.undertow.buffer-size

int

micronaut.server.undertow.io-threads

int

micronaut.server.undertow.worker-threads

int

micronaut.server.undertow.direct-buffers

boolean

micronaut.server.undertow.handler

io.undertow.server.HttpHandler

micronaut.server.undertow.worker

org.xnio.XnioWorker

micronaut.server.undertow.ssl-engine-delegated-task-executor

java.util.concurrent.Executor

micronaut.server.undertow.byte-buffer-pool

io.undertow.connector.ByteBufferPool
🔗
Table 16. Configuration Properties for UndertowConfiguration$AccessLogConfiguration
Property Type Description Default value

micronaut.server.undertow.access-log.enabled

boolean

Sets whether enabled.

micronaut.server.undertow.access-log.pattern

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>
🔗
Table 17. Configuration Properties for DefaultAccessLogReceiver$Builder
Property Type Description Default value

micronaut.server.undertow.access-log.output-directory

java.nio.file.Path

micronaut.server.undertow.access-log.log-base-name

java.lang.String

micronaut.server.undertow.access-log.log-name-suffix

java.lang.String

micronaut.server.undertow.access-log.rotate

boolean
🔗
Table 18. Configuration Properties for DefaultAccessLogReceiver$Builder
Property Type Description Default value

micronaut.server.undertow.access-log.output-directory

java.nio.file.Path

micronaut.server.undertow.access-log.log-base-name

java.lang.String

micronaut.server.undertow.access-log.log-name-suffix

java.lang.String

micronaut.server.undertow.access-log.rotate

boolean

Micronaut Servlet Core Config Properties

🔗
Table 19. Configuration Properties for ServletStaticResourceConfiguration
Property Type Description Default value

micronaut.router.static-resources.*.mapping

java.lang.String

The mapping

/**

micronaut.router.static-resources.*.paths

java.util.List

The paths

micronaut.router.static-resources.*.enabled

boolean

true

micronaut.router.static-resources.*.cache-control

java.lang.String

For Jetty based servers, allow configuring the cache control header for static resource mappings (defaults to "private,max-age=60").

private,max-age=60

Micronaut Servlet Engine Config Properties

🔗
Table 20. Configuration Properties for MicronautServletConfiguration
Property Type Description Default value

micronaut.servlet.name

java.lang.String

The name of the servlet

micronaut

micronaut.servlet.mapping

java.lang.String

The servlet mapping

/*

micronaut.servlet.async-supported

boolean

Set whether async is supported or not.

micronaut.servlet.test-async-supported

java.lang.Boolean

Legacy property to disable async for testing.

micronaut.servlet.enable-virtual-threads

boolean

Whether virtual threads are enabled.

micronaut.servlet.async-file-serving-enabled

boolean

Is async file serving enabled.

micronaut.servlet.min-threads

java.lang.Integer

Specify the minimum number of threads in the created thread pool.

micronaut.servlet.max-threads

java.lang.Integer

Specify the maximum number of threads in the created thread pool.