Package io.quarkus.vertx.http.runtime.management

Class ManagementInterfaceBuildTimeConfig

java.lang.Object

io.quarkus.vertx.http.runtime.management.ManagementInterfaceBuildTimeConfig

@ConfigRoot(name="management",
            phase=BUILD_AND_RUN_TIME_FIXED)
public class ManagementInterfaceBuildTimeConfig
extends Object

Management interface configuration.

Field Summary

Fields

Modifier and Type	Field	Description
ManagementAuthConfig	auth	Authentication configuration
OptionalInt	compressionLevel	The compression level used when compression support is enabled.
boolean	enableCompression	If responses should be compressed.
boolean	enabled	Enables / Disables the usage of a separate interface/port to expose the management endpoints.
boolean	enableDecompression	When enabled, vert.x will decompress the request's body if it's compressed.
String	rootPath	A common root path for management endpoints.
io.vertx.core.http.ClientAuth	tlsClientAuth	Configures the engine to require/request client authentication.

Constructor Summary

Constructors

Constructor	Description
ManagementInterfaceBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

enabled

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

Enables / Disables the usage of a separate interface/port to expose the management endpoints. If sets to true, the management endpoints will be exposed to a different HTTP server. This avoids exposing the management endpoints on a publicly available server.

auth

public ManagementAuthConfig auth

Authentication configuration

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

rootPath

@ConfigItem(defaultValue="/q")
public String rootPath

A common root path for management endpoints. Various extension-provided management endpoints such as metrics and health are deployed under this path by default.

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.

compressionLevel

@ConfigItem
public OptionalInt compressionLevel

The compression level used when compression support is enabled.

Constructor Detail

ManagementInterfaceBuildTimeConfig

public ManagementInterfaceBuildTimeConfig()