Package io.quarkus.resteasy.server.common.deployment

Interface ResteasyServerCommonProcessor.ResteasyConfig

Enclosing class:
ResteasyServerCommonProcessor
@ConfigRoot(phase=BUILD_TIME) @ConfigMapping(prefix="quarkus.resteasy") static interface ResteasyServerCommonProcessor.ResteasyConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    buildTimeConditionAware()
    Whether annotations such `@IfBuildTimeProfile`, `@IfBuildTimeProperty` and friends will be taken into account when used on JAX-RS classes.
    boolean
    ignoreApplicationClasses()
    Ignore all explicit JAX-RS Application classes.
    @WithConverter(io.quarkus.runtime.configuration.NormalizeRootHttpPathConverter.class) String
    path()
    Set this to override the default path for JAX-RS resources if there are no annotated application classes.
    boolean
    singletonResources()
    If this is true then JAX-RS will use only a single instance of a resource class to service all requests.

  • Method Details

    • singletonResources

      @WithDefault("true") boolean singletonResources()
      If this is true then JAX-RS will use only a single instance of a resource class to service all requests.

      If this is false then it will create a new instance of the resource per request.

      If the resource class has an explicit CDI scope annotation then the value of this annotation will always be used to control the lifecycle of the resource class.

      IMPLEMENTATION NOTE: jakarta.ws.rs.Path turns into a CDI stereotype with singleton scope. As a result, if a user annotates a JAX-RS resource with a stereotype which has a different default scope the deployment fails with IllegalStateException.

    • path

      @WithDefault("/") @WithConverter(io.quarkus.runtime.configuration.NormalizeRootHttpPathConverter.class) @WithConverter(io.quarkus.runtime.configuration.NormalizeRootHttpPathConverter.class) String path()
      Set this to override the default path for JAX-RS resources if there are no annotated application classes. This path is specified with a leading /, but is resolved relative to quarkus.http.root-path.
      • If quarkus.http.root-path=/ and quarkus.resteasy.path=/bar, the JAX-RS resource path will be /bar
      • If quarkus.http.root-path=/foo and quarkus.resteasy.path=/bar, the JAX-RS resource path will be /foo/bar

    • ignoreApplicationClasses

      @WithDefault("false") boolean ignoreApplicationClasses()
      Ignore all explicit JAX-RS Application classes. As multiple JAX-RS applications are not supported, this can be used to effectively merge all JAX-RS applications.

    • buildTimeConditionAware

      @WithDefault("true") boolean buildTimeConditionAware()
      Whether annotations such `@IfBuildTimeProfile`, `@IfBuildTimeProperty` and friends will be taken into account when used on JAX-RS classes.