io.quarkus.vertx.http.runtime

Class HttpConfiguration

java.lang.Object

io.quarkus.vertx.http.runtime.HttpConfiguration

@ConfigRoot(phase=RUN_TIME)
public class HttpConfiguration
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpConfiguration.InsecureRequests

Field Summary

Fields

Modifier and Type	Field and Description
(package private) AccessLogConfig	accessLog
boolean	allowForwarded If this is true and proxy address forwarding is enabled then the standard Forwarded header will be used, rather than the more common but not standard X-Forwarded-For.
BodyConfig	body Request body related settings
CORSConfig	cors The CORS config
boolean	corsEnabled Enable the CORS filter.
String	domainSocket Path to a unix domain socket
boolean	domainSocketEnabled Enable listening to host:port
Optional<String>	encryptionKey The encryption key that is used to store persistent logins (e.g.
String	host The HTTP host
boolean	hostEnabled Enable listening to host:port
boolean	http2 If this is true (the default) then HTTP/2 will be enabled.
Duration	idleTimeout Http connection idle timeout
HttpConfiguration.InsecureRequests	insecureRequests If insecure (i.e.
OptionalInt	ioThreads The number if IO threads used to perform IO.
ServerLimitsConfig	limits Server limits configuration
int	port The HTTP port
boolean	proxyAddressForwarding If this is true then the address, scheme etc will be set from headers forwarded by the proxy server, such as X-Forwarded-For.
Duration	readTimeout Http connection read timeout for blocking IO.
boolean	recordRequestStartTime If this is true then the request start time will be recorded to enable logging of total request time.
boolean	soReusePort Enable socket reuse port (linux/macOs native transport only)
ServerSslConfig	ssl The SSL config
int	sslPort The HTTPS port
boolean	tcpCork Enable tcp cork (linux native transport only)
boolean	tcpFastOpen Enable tcp fast open (linux native transport only)
boolean	tcpQuickAck Enable tcp quick ack (linux native transport only)
int	testPort The HTTP port used to run tests
int	testSslPort The HTTPS port used to run tests

Constructor Summary

Constructors

Constructor and Description
HttpConfiguration()

Method Summary

Modifier and Type	Method and Description
int	determinePort(LaunchMode launchMode)
int	determineSslPort(LaunchMode launchMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

corsEnabled

@ConfigItem(name="cors",
            defaultValue="false")
public boolean corsEnabled

Enable the CORS filter.

port

@ConfigItem(defaultValue="8080")
public int port

The HTTP port

testPort

@ConfigItem(defaultValue="8081")
public int testPort

The HTTP port used to run tests

host

@ConfigItem(defaultValue="0.0.0.0")
public String host

The HTTP host

hostEnabled

@ConfigItem(defaultValue="true")
public boolean hostEnabled

Enable listening to host:port

sslPort

@ConfigItem(defaultValue="8443")
public int sslPort

The HTTPS port

testSslPort

@ConfigItem(defaultValue="8444")
public int testSslPort

The HTTPS port used to run tests

proxyAddressForwarding

@ConfigItem(defaultValue="false")
public boolean proxyAddressForwarding

If this is true then the address, scheme etc will be set from headers forwarded by the proxy server, such as X-Forwarded-For. This should only be set if you are behind a proxy that sets these headers.

allowForwarded

@ConfigItem(defaultValue="false")
public boolean allowForwarded

If this is true and proxy address forwarding is enabled then the standard Forwarded header will be used, rather than the more common but not standard X-Forwarded-For.

insecureRequests

@ConfigItem(defaultValue="enabled")
public HttpConfiguration.InsecureRequests insecureRequests

If insecure (i.e. http rather than https) requests are allowed. If this is enabled then http works as normal. redirect will still open the http port, but all requests will be redirected to the HTTPS port. disabled will prevent the HTTP port from opening at all.

http2

@ConfigItem(defaultValue="true")
public boolean http2

If this is true (the default) then HTTP/2 will be enabled. Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.

cors

public CORSConfig cors

The CORS config

ssl

public ServerSslConfig ssl

The SSL config

ioThreads

@ConfigItem
public OptionalInt ioThreads

The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops. In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads.

limits

public ServerLimitsConfig limits

Server limits configuration

idleTimeout

@ConfigItem(defaultValue="30M",
            name="idle-timeout")
public Duration idleTimeout

Http connection idle timeout

readTimeout

@ConfigItem(defaultValue="60s",
            name="read-timeout")
public Duration readTimeout

Http connection read timeout for blocking IO. This is the maximum amount of time a thread will wait for data, before an IOException will be thrown and the connection closed.

body

public BodyConfig body

Request body related settings

encryptionKey

@ConfigItem(name="auth.session.encryption-key")
public Optional<String> encryptionKey

The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here. If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons

soReusePort

@ConfigItem(defaultValue="false")
public boolean soReusePort

Enable socket reuse port (linux/macOs native transport only)

tcpQuickAck

@ConfigItem(defaultValue="false")
public boolean tcpQuickAck

Enable tcp quick ack (linux native transport only)

tcpCork

@ConfigItem(defaultValue="false")
public boolean tcpCork

Enable tcp cork (linux native transport only)

tcpFastOpen

@ConfigItem(defaultValue="false")
public boolean tcpFastOpen

Enable tcp fast open (linux native transport only)

domainSocket

@ConfigItem(defaultValue="/var/run/io.quarkus.app.socket")
public String domainSocket

Path to a unix domain socket

domainSocketEnabled

@ConfigItem(defaultValue="false")
public boolean domainSocketEnabled

Enable listening to host:port

recordRequestStartTime

@ConfigItem
public boolean recordRequestStartTime

If this is true then the request start time will be recorded to enable logging of total request time. This has a small performance penalty, so is disabled by default.

accessLog

AccessLogConfig accessLog

Constructor Detail

HttpConfiguration

public HttpConfiguration()

Method Detail

determinePort

public int determinePort(LaunchMode launchMode)

determineSslPort

public int determineSslPort(LaunchMode launchMode)