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 Details

    • 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.

      When set to REQUIRED, it's recommended to also set `quarkus.http.insecure-requests=disabled` to disable the plain HTTP port. If `quarkus.http.insecure-requests` is not set, but this parameter is set to REQUIRED, then, `quarkus.http.insecure-requests` is automatically set to `disabled`.

    • 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}`.

      If the management interface is enabled, the root path for the endpoints exposed on the management interface is configured using the `quarkus.management.root-path` property instead of this property.

    • testTimeout

      @ConfigItem(defaultValue="30s") public Duration testTimeout
      The REST Assured client timeout for testing.

    • enableCompression

      @ConfigItem public boolean enableCompression
      If enabled then the response body is compressed if the Content-Type header is set and the value is a compressed media type as configured via compressMediaTypes.

      Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations Compressed and Uncompressed.

    • 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.

    • compressors

      @ConfigItem(defaultValue="gzip,deflate") public Optional<List<String>> compressors
      If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project.

      Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client's capabilities and marks it in a response header, e.g.: content-encoding: gzip

    • compressMediaTypes

      @ConfigItem(defaultValue="text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/graphql+json") 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 Details

    • HttpBuildTimeConfig

      public HttpBuildTimeConfig()