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
String	nonApplicationRootPath	A common root path for non-application endpoints.
boolean	redirectToNonApplicationRootPath	Provide redirect endpoints for extension-provided endpoints existing prior to Quarkus 1.11.
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="/")
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}`.

redirectToNonApplicationRootPath

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

Provide redirect endpoints for extension-provided endpoints existing prior to Quarkus 1.11. This will trigger HTTP 301 Redirects for the following: * `/graphql-ui` * `/health` * `/health-ui` * `/metrics` * `/openapi` * `/swagger-ui` Default is `true` for Quarkus 1.11.x to facilitate transition to name-spaced URIs using `${quarkus.http.non-application-root-path}`. Quarkus 1.13 will change the default to `false`, and the config item will be removed in Quarkus 2.0.

testTimeout

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

The REST Assured client timeout for testing.

Constructor Detail

HttpBuildTimeConfig

public HttpBuildTimeConfig()