← Back to plugin index

REST Client Config
Description
Configures an HTTPS REST client. Can be used to issue REST calls from Airlock IAM to REST servers.

Note that this REST client does not support cookies.

Type name
RestClient
Class
com.airlock.iam.common.application.configuration.restclient.RestClientConfig
Properties
Server URLs (serverUrls)
Description
The REST server addresses. These have to be specified without a trailing slash.
Attributes
String-List
Mandatory
Retry Policy (retryPolicy)
Description
The retry policy used to decide if a REST request should be repeated (using the next server URL in the list) depending on its outcome (response or exception).
Attributes
Plugin-Link
Mandatory
Assignable plugins
No Retry Policy Retry If Server Not Reachable Policy
Connect/Read Timeout [ms] (timeout)
Description
The timeout (in milliseconds) for connection establishment and response receiving when issuing a request to a server. A value of zero is interpreted as 30 seconds.
Attributes
Integer
Optional
Default value
10000
Connection Pool Max Size (connectionPoolMaxSize)
Description
The maximum size of the connection pool.
Attributes
Integer
Optional
Default value
50
Trust Store Path (trustStorePath)
Description
The keystore containing the web server certificate. These certificates are trusted when establishing mutual SSL connections for HTTPS REST calls.
Attributes
File/Path
Optional
Trust Store Password (trustStorePassword)
Description
The password used to check the integrity of the truststore, or to unlock the truststore.
Attributes
String
Optional
Sensitive
Key Store Path (keyStorePath)
Description
The keystore containing a client certificate (including a private key) for Airlock IAM. The client certificate is used to establish mutual SSL connections for HTTPS REST calls.
Attributes
File/Path
Optional
Key Store Password (keyStorePassword)
Description
The password used to check the integrity of the keystore, or to unlock the keystore. Must be provided in case the keystore is configured.
Attributes
String
Optional
Sensitive
Basic Auth Credentials (basicAuthCredentials)
Description
The credentials for HTTP Basic Authentication. If configured, the Basic Authentication header is sent along with each REST call. If not configured, no Basic Authentication header is sent.
Attributes
Plugin-Link
Optional
Assignable plugins
Basic Auth Credentials
Request Entity Processing (requestEntityProcessing)
Description
This property specifies how the entity is serialized to the output stream; if buffering is used or the entity is streamed in chunked encoding.

The options are:

  • BUFFERED: the entity will be buffered and the content length will be sent in the Content-Length header.
  • CHUNKED: chunked encoding will be used and the entity will be streamed.

Attributes
Enum
Optional
Default value
CHUNKED
Connection Manager Timeout [ms] (connectionManagerTimeout)
Description
The timeout (in milliseconds) to wait for connection from the connection manager/pool (http.connection-manager.timeout). Setting this value to 0 disables the timeout and the thread would be blocked by waiting indefinitely for a new connection until one gets released back to the pool.
Attributes
Integer
Optional
Default value
10000
Proxy URI (proxyUri)
Description
URI of a HTTP proxy the connector should use. If the port component of the URI is absent then a default port of 8080 is assumed. If this property is left empty then no proxy will be utilized.
Attributes
String
Optional
Example
proxy.company.com
Proxy Login User (proxyLoginUser)
Description
Username for the proxy if proxy authentication is used.
Attributes
String
Optional
Proxy Login Password (proxyLoginPassword)
Description
Password for the proxy if proxy authentication is used.
Attributes
String
Optional
Sensitive
Static REST Request Headers (staticRestRequestHeaders)
Description
A list of static request headers added to each request made with this REST Client.
Attributes
Plugin-List
Optional
Assignable plugins
Plain Static REST Request Header Sensitive Static REST Request Header
Static REST Request Header Strategy (staticRestRequestHeaderStrategy)
Description
This property specifies the behaviour when the request already contains a header for a configured header name. If no static request headers are configured, this property has no impact.

The options are:

  • OVERWRITE_EXISTING: if there is already a value for the configured header name it is overwritten with the configured value.
  • KEEP_ORIGINAL: the already existing header value is kept and the configured value is ignored.

Attributes
Enum
Optional
Default value
OVERWRITE_EXISTING
YAML Template (with default values) 

type: RestClient
id: RestClient-xxxxxx
displayName: 
comment: 
properties:
  basicAuthCredentials:
  connectionManagerTimeout: 10000
  connectionPoolMaxSize: 50
  keyStorePassword:
  keyStorePath:
  proxyLoginPassword:
  proxyLoginUser:
  proxyUri:
  requestEntityProcessing: CHUNKED
  retryPolicy:
  serverUrls:
  staticRestRequestHeaderStrategy: OVERWRITE_EXISTING
  staticRestRequestHeaders:
  timeout: 10000
  trustStorePassword:
  trustStorePath: