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

Field Summary

Fields

Modifier and Type	Field and Description
BodyConfig	body Request body related settings
CORSConfig	cors The CORS config
boolean	corsEnabled Enable the CORS filter.
Optional<String>	encryptionKey The encryption key that is used to store persistent logins (e.g.
String	host The HTTP host
Duration	idleTimeout Http connection idle timeout
OptionalInt	ioThreads The number if IO threads used to perform IO.
ServerLimitsConfig	limits Server limits configuration
int	port The HTTP port
ServerSslConfig	ssl The SSL config
int	sslPort The HTTPS port
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

sslPort

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

The HTTPS port

testSslPort

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

The HTTPS port used to run tests

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

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

Constructor Detail

HttpConfiguration

public HttpConfiguration()

Method Detail

determinePort

public int determinePort(LaunchMode launchMode)

determineSslPort

public int determineSslPort(LaunchMode launchMode)