Package io.quarkus.vertx.http.runtime

Class HttpBuildTimeConfig

java.lang.Object

io.quarkus.vertx.http.runtime.HttpBuildTimeConfig

@ConfigRoot(name="http",
            phase=BUILD_AND_RUN_TIME_FIXED)
public class HttpBuildTimeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
AuthConfig	auth
OptionalInt	compressionLevel	The compression level used when compression support is enabled.
Optional<List<String>>	compressMediaTypes	List of media types for which the compression should be enabled automatically, unless declared explicitly via Compressed or Uncompressed.
boolean	enableCompression	If responses should be compressed.
boolean	enableDecompression	When enabled, vert.x will decompress the request's body if it's compressed.
String	nonApplicationRootPath	A common root path for non-application endpoints.
String	rootPath	The HTTP root path.
Duration	testTimeout	The REST Assured client timeout for testing.
io.vertx.core.http.ClientAuth	tlsClientAuth	Configures the engine to require/request client authentication.
boolean	virtual	If this is true then only a virtual channel will be set up for vertx web.

Constructor Summary

Constructors

Constructor	Description
HttpBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

rootPath

@ConfigItem(defaultValue="/")
@ConvertWith(io.quarkus.runtime.configuration.NormalizeRootHttpPathConverter.class)
public String rootPath

The HTTP root path. All web content will be served relative to this root path.

auth

public AuthConfig auth

tlsClientAuth

@ConfigItem(name="ssl.client-auth",
            defaultValue="NONE")
public io.vertx.core.http.ClientAuth tlsClientAuth

Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED

virtual

@ConfigItem
public boolean virtual

If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes.

nonApplicationRootPath

@ConfigItem(defaultValue="q")
public String nonApplicationRootPath

A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health, and openapi are deployed under this path by default. * Relative path (Default, `q`) -> Non-application endpoints will be served from `${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`. * Absolute path (`/q`) -> Non-application endpoints will be served from the specified path. * `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`.

testTimeout

@ConfigItem(defaultValue="30s")
public Duration testTimeout

The REST Assured client timeout for testing.

enableCompression

@ConfigItem
public boolean enableCompression

If responses should be compressed. Note that this will attempt to compress all responses, to avoid compressing already compressed content (such as images) you need to set the following header: Content-Encoding: identity Which will tell vert.x not to compress the response.

enableDecompression

@ConfigItem
public boolean enableDecompression

When enabled, vert.x will decompress the request's body if it's compressed. Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.

compressMediaTypes

@ConfigItem(defaultValue="text/html,text/plain,text/xml,text/css,text/javascript,application/javascript")
public Optional<List<String>> compressMediaTypes

List of media types for which the compression should be enabled automatically, unless declared explicitly via Compressed or Uncompressed.

compressionLevel

@ConfigItem
public OptionalInt compressionLevel

The compression level used when compression support is enabled.

Constructor Detail

HttpBuildTimeConfig

public HttpBuildTimeConfig()