Package io.quarkus.restclient.config

Interface RestClientsBuildTimeConfig.RestClientBuildConfig

Enclosing interface:
RestClientsBuildTimeConfig
public static interface RestClientsBuildTimeConfig.RestClientBuildConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    enableLocalProxy()
    If set to true, then Quarkus will ensure that all calls from the REST client go through a local proxy server (that is managed by Quarkus).
    Optional<String>
    localProxyProvider()
    This setting is used to select which proxy provider to use if there are multiple ones.
    boolean
    removesTrailingSlash()
    If true, the extension will automatically remove the trailing slash in the paths if any.
    Optional<String>
    scope()
    The CDI scope to use for injection.

  • Method Details

    • scope

      Optional<String> scope()
      The CDI scope to use for injection. This property can contain either a fully qualified class name of a CDI scope annotation (such as "jakarta.enterprise.context.ApplicationScoped") or its simple name (such as "ApplicationScoped"). By default, this is not set which means the interface is not registered as a bean unless it is annotated with RegisterRestClient. If an interface is not annotated with RegisterRestClient and this property is set, then Quarkus will make the interface a bean of the configured scope.

    • enableLocalProxy

      @WithDefault("false") boolean enableLocalProxy()
      If set to true, then Quarkus will ensure that all calls from the REST client go through a local proxy server (that is managed by Quarkus). This can be very useful for capturing network traffic to a service that uses HTTPS.

      This property is not applicable to the RESTEasy Client, only the Quarkus REST client (formerly RESTEasy Reactive client).

      This property only applicable to dev and test mode.

    • localProxyProvider

      Optional<String> localProxyProvider()
      This setting is used to select which proxy provider to use if there are multiple ones. It only applies if enable-local-proxy is true.

      The algorithm for picking between multiple provider is the following:

      • If only the default is around, use it (its name is default)
      • If there is only one besides the default, use it
      • If there are multiple ones, fail

    • removesTrailingSlash

      @WithName("removes-trailing-slash") @WithDefault("true") boolean removesTrailingSlash()
      If true, the extension will automatically remove the trailing slash in the paths if any. This property is not applicable to the RESTEasy Client.