Package io.quarkus.restclient.config

Class RestClientsConfig

java.lang.Object

io.quarkus.restclient.config.RestClientsConfig

@ConfigRoot(name="rest-client",
            phase=RUN_TIME)
public class RestClientsConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Map<String,RestClientConfig>	configKey	Configurations of REST client instances.
Long	connectTimeout	Global default connect timeout for automatically generated REST Clients.
boolean	disableContextualErrorMessages	If true, the reactive REST clients will not provide additional contextual information (like REST client class and method names) when exception occurs during a client invocation.
Optional<Boolean>	disableSmartProduces	By default, REST Client Reactive uses text/plain content type for String values and application/json for everything else.
RestClientLoggingConfig	logging
Optional<String>	multipartPostEncoderMode	Mode in which the form data are encoded.
Optional<String>	nonProxyHosts	Hosts to access without proxy, similar to the http.nonProxyHosts or https.nonProxyHosts JVM settings.
Optional<String>	proxyAddress	A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of clients to use.
Optional<String>	proxyPassword	Proxy password, equivalent to the http.proxyPassword or https.proxyPassword JVM settings.
Optional<String>	proxyUser	Proxy username, equivalent to the http.proxy or https.proxy JVM settings.
Long	readTimeout	Global default read timeout for automatically generated REST clients.
Optional<String>	userAgent	Configure the HTTP user-agent header to use.

Constructor Summary

Constructors

Constructor	Description
RestClientsConfig()

Method Summary

Modifier and Type	Method	Description
RestClientConfig	getClientConfig(Class<?> clientInterface)
RestClientConfig	getClientConfig(String configKey)
static RestClientsConfig	getInstance()
void	putClientConfig(Class<?> clientInterface, RestClientConfig clientConfig)
void	putClientConfig(String configKey, RestClientConfig clientConfig)

Methods inherited from class java.lang.Object

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

Field Detail

configKey

@ConfigItem(name="<<parent>>")
Map<String,RestClientConfig> configKey

Configurations of REST client instances. The key can be either the value of the configKey parameter of a `@RegisterRestClient` annotation, or the name of a class bearing that annotation, in which case it is possible to use the short name, as well as fully qualified name.

disableSmartProduces

@ConfigItem(defaultValue="false")
public Optional<Boolean> disableSmartProduces

By default, REST Client Reactive uses text/plain content type for String values and application/json for everything else. MicroProfile Rest Client spec requires the implementations to always default to application/json. This build item disables the "smart" behavior of RESTEasy Reactive to comply to the spec. This property is applicable to reactive REST clients only.

multipartPostEncoderMode

@ConfigItem
public 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 applicable to reactive REST clients only.

proxyAddress

@ConfigItem
public Optional<String> proxyAddress

A string value in the form of `:` that specifies the HTTP proxy server hostname (or IP address) and port for requests of clients to use. Can be overwritten by client-specific settings This property is applicable to reactive REST clients only.

proxyUser

@ConfigItem
public Optional<String> proxyUser

Proxy username, equivalent to the http.proxy or https.proxy JVM settings. This property is applicable to reactive REST clients only.

proxyPassword

@ConfigItem
public Optional<String> proxyPassword

Proxy password, equivalent to the http.proxyPassword or https.proxyPassword JVM settings. This property is applicable to reactive REST clients only.

nonProxyHosts

@ConfigItem
public Optional<String> nonProxyHosts

Hosts to access without proxy, similar to the http.nonProxyHosts or https.nonProxyHosts JVM settings. Please note that unlike the JVM settings, this property is empty by default This property is applicable to reactive REST clients only.

logging

public RestClientLoggingConfig logging

connectTimeout

@ConfigItem(defaultValue="15000",
            defaultValueDocumentation="15000 ms")
public Long connectTimeout

Global default connect timeout for automatically generated REST Clients. The attribute specifies a timeout in milliseconds that a client should wait to connect to the remote endpoint.

readTimeout

@ConfigItem(defaultValue="30000",
            defaultValueDocumentation="30000 ms")
public Long readTimeout

Global default read timeout for automatically generated REST clients. The attribute specifies a timeout in milliseconds that a client should wait for a response from the remote endpoint.

disableContextualErrorMessages

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

If true, the reactive REST clients will not provide additional contextual information (like REST client class and method names) when exception occurs during a client invocation.

userAgent

@ConfigItem
public Optional<String> userAgent

Configure the HTTP user-agent header to use. This property is applicable to reactive REST clients only.

Constructor Detail

RestClientsConfig

public RestClientsConfig()

Method Detail

getClientConfig

public RestClientConfig getClientConfig(String configKey)

getClientConfig

public RestClientConfig getClientConfig(Class<?> clientInterface)

putClientConfig

public void putClientConfig(String configKey,
                            RestClientConfig clientConfig)

putClientConfig

public void putClientConfig(Class<?> clientInterface,
                            RestClientConfig clientConfig)

getInstance

public static RestClientsConfig getInstance()