Package io.quarkus.restclient.config

Interface RestClientsConfig.RestClientConfig

Enclosing interface:
RestClientsConfig
public static interface RestClientsConfig.RestClientConfig

  • Method Details

    • multipart

      RestClientsConfig.RestClientMultipartConfig multipart()
      Multipart configuration.

    • url

      Optional<String> url()
      The base URL to use for this service. This property or the `uri` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.

    • urlValue

      @ConfigDocIgnore @WithName("url") io.smallrye.config.ConfigValue urlValue()
      Duplicate mapping of url() to keep a reference of the name used to retrieve the url. We need this to reload the url configuration in case it contains an expression to ${quarkus.http.port}, which is only set after we load the config.

    • urlReload

      default Optional<String> urlReload()

    • uri

      Optional<String> uri()
      The base URI to use for this service. This property or the `url` property is considered required, unless the `baseUri` attribute is configured in the `@RegisterRestClient` annotation.

    • uriValue

      @ConfigDocIgnore @WithName("uri") io.smallrye.config.ConfigValue uriValue()
      Duplicate mapping of uri() to keep a reference of the name used to retrieve the uri. We need this to reload the uri configuration in case it contains an expression to ${quarkus.http.port}, which is only set after we load the config.

    • uriReload

      default Optional<String> uriReload()

    • overrideUri

      Optional<String> overrideUri()
      This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url. The override is done using the REST Client class name configuration syntax.

      This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).

    • providers

      Optional<String> providers()
      Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the `@RegisterProvider` annotation.

    • connectTimeout

      Optional<Long> connectTimeout()
      Timeout specified in milliseconds to wait to connect to the remote endpoint.

    • readTimeout

      Optional<Long> readTimeout()
      Timeout specified in milliseconds to wait for a response from the remote endpoint.

    • followRedirects

      Optional<Boolean> followRedirects()
      A boolean value used to determine whether the client should follow HTTP redirect responses.

    • multipartPostEncoderMode

      Optional<String> multipartPostEncoderMode()
      Mode in which the form data are encoded. Possible values are `HTML5`, `RFC1738` and `RFC3986`. The modes are described in the Netty documentation

      By default, Rest Client Reactive uses RFC1738.

      This property is not applicable to the RESTEasy Client.

    • proxyConfigurationName

      Optional<String> proxyConfigurationName()
      The name of the proxy configuration to use; ignored if quarkus.rest-client."client".proxy-address is set.

      If not set and quarkus.rest-client.proxy-configuration-name or the default proxy configuration (quarkus.proxy.*) is set, then the first valid of them will get effective. If the proxy configuration name is set, the configuration from quarkus.proxy.<name>.* will be used. If the proxy configuration name is set, but no proxy configuration is found with that name, then an error will be thrown at runtime.

      Use the value none to disable using the default configuration defined via quarkus.rest-client.proxy-configuration-name or quarkus.proxy.*.

      Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency) does not support this property.

    • proxyAddress

      @Deprecated Optional<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) String> proxyAddress()
      Deprecated.
      use quarkus.rest-client."client".proxy-configuration-name instead
      A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of this client to use.

      Use `none` to disable proxy

    • proxyUser

      @Deprecated Optional<String> proxyUser()
      Deprecated.
      use quarkus.rest-client."client".proxy-configuration-name instead
      Proxy username. Honored only if quarkus.rest-client."client".proxy-address is set.

      This property is not applicable to the RESTEasy Client.

    • proxyPassword

      @Deprecated Optional<String> proxyPassword()
      Deprecated.
      use quarkus.rest-client."client".proxy-configuration-name instead
      Proxy password. Honored only if quarkus.rest-client."client".proxy-address is set.

      This property is not applicable to the RESTEasy Client.

    • nonProxyHosts

      @Deprecated Optional<String> nonProxyHosts()
      Deprecated.
      use quarkus.rest-client."client".proxy-configuration-name instead
      Hosts to access without proxy. Honored only if quarkus.rest-client."client".proxy-address is set.

      This property is not applicable to the RESTEasy Client.

    • proxyConnectTimeout

      @Deprecated @ConfigDocDefault("10s") Optional<Duration> proxyConnectTimeout()
      Deprecated.
      use quarkus.rest-client."client".proxy-configuration-name instead
      Proxy connection timeout. Honored only if quarkus.rest-client."client".proxy-address is set.

      This property is not applicable to the RESTEasy Client.

    • queryParamStyle

      Optional<org.eclipse.microprofile.rest.client.ext.QueryParamStyle> queryParamStyle()
      An enumerated type string value with possible values of "MULTI_PAIRS" (default), "COMMA_SEPARATED", or "ARRAY_PAIRS" that specifies the format in which multiple values for the same query parameter is used.

    • verifyHost

      Optional<Boolean> verifyHost()
      Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.

    • trustStore

      Optional<String> trustStore()
      The trust store location. Can point to either a classpath resource or a file.

    • trustStorePassword

      Optional<String> trustStorePassword()
      The trust store password.

    • trustStoreType

      Optional<String> trustStoreType()
      The type of the trust store. Defaults to "JKS".

    • keyStore

      Optional<String> keyStore()
      The key store location. Can point to either a classpath resource or a file.

    • keyStorePassword

      Optional<String> keyStorePassword()
      The key store password.

    • keyStoreType

      Optional<String> keyStoreType()
      The type of the key store. Defaults to "JKS".

    • hostnameVerifier

      Optional<String> hostnameVerifier()
      The class name of the host name verifier. The class must have a public no-argument constructor.

    • tlsConfigurationName

      Optional<String> tlsConfigurationName()
      The name of the TLS configuration to use.

      If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown. The default TLS configuration will be ignored.

      If no named TLS configuration is set, then the key-store, trust-store, etc. properties will be used.

      This property is not applicable to the RESTEasy Client.

    • connectionTTL

      OptionalInt connectionTTL()
      The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of 0 means there is no timeout.

    • connectionPoolSize

      @ConfigDocDefault("50") OptionalInt connectionPoolSize()
      The size of the connection pool for this client.

    • keepAliveEnabled

      Optional<Boolean> keepAliveEnabled()
      If set to false disables the keep alive completely.

    • maxRedirects

      OptionalInt maxRedirects()
      The maximum number of redirection a request can follow.

      This property is not applicable to the RESTEasy Client.

    • headers

      @ConfigDocMapKey("header-name") Map<String,String> headers()
      The HTTP headers that should be applied to all requests of the rest client.

      This property is not applicable to the RESTEasy Client.

    • shared

      Optional<Boolean> shared()
      Set to true to share the HTTP client between REST clients. There can be multiple shared clients distinguished by name, when no specific name is set, the name __vertx.DEFAULT is used.

      This property is not applicable to the RESTEasy Client.

    • name

      Optional<String> name()
      Set the HTTP client name, used when the client is shared, otherwise ignored.

      This property is not applicable to the RESTEasy Client.

    • userAgent

      Optional<String> userAgent()
      Configure the HTTP user-agent header to use.

      This property is not applicable to the RESTEasy Client.

    • http2

      Optional<Boolean> http2()
      If this is true then HTTP/2 will be enabled.

    • http2UpgradeMaxContentLength

      @ConfigDocDefault("64K") Optional<io.quarkus.runtime.configuration.MemorySize> http2UpgradeMaxContentLength()
      Configures the HTTP/2 upgrade maximum length of the aggregated content in bytes.

      This property is not applicable to the RESTEasy Client.

    • maxChunkSize

      @ConfigDocDefault("8K") Optional<io.quarkus.runtime.configuration.MemorySize> maxChunkSize()
      Configures two different things:
      • The max HTTP chunk size, up to Integer.MAX_VALUE bytes.
      • The size of the chunk to be read when an InputStream is being read and sent to the server

      This property is not applicable to the RESTEasy Client.

    • enableResponseDecompression

      Optional<Boolean> enableResponseDecompression()
      Supports receiving compressed messages using GZIP. When this feature is enabled and a server returns a response that includes the header Content-Encoding: gzip, REST Client will automatically decode the content and proceed with the message handling.

      This property is not applicable to the RESTEasy Client.

    • alpn

      Optional<Boolean> alpn()
      If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it's not enabled, it will use HTTP/1.1. When the property `http2` is enabled, this flag will be automatically enabled.

    • captureStacktrace

      Optional<Boolean> captureStacktrace()
      If true, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception

    • disableDefaultMapper

      @WithDefault("false") Boolean disableDefaultMapper()
      If set to true, then this REST Client will not the default exception mapper which always throws an exception if HTTP response code >= 400.

      This property is only taken into account if the REST Client returns jakarta.ws.rs.core.Response or org.jboss.resteasy.reactive.RestResponse

      This property is not applicable to the RESTEasy Client.

    • logging

      Optional<RestClientsConfig.RestClientLoggingConfig> logging()
      Logging configuration.