Package io.camunda.client.impl.oauth

Class OAuthCredentialsProviderBuilder

java.lang.Object

io.camunda.client.impl.oauth.OAuthCredentialsProviderBuilder

public final class OAuthCredentialsProviderBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_CONNECT_TIMEOUT
static final String	DEFAULT_CREDENTIALS_CACHE_PATH
static final Duration	DEFAULT_READ_TIMEOUT
static final String	INVALID_ARGUMENT_MSG

Constructor Summary

Constructors

Constructor	Description
OAuthCredentialsProviderBuilder()

Method Summary

Modifier and Type	Method	Description
OAuthCredentialsProviderBuilder	applyEnvironmentOverrides(boolean applyEnvironmentOverrides)
OAuthCredentialsProviderBuilder	audience(String audience)	The resource for which the access token should be valid.
OAuthCredentialsProviderBuilder	authorizationServerUrl(String authorizationServerUrl)	The authorization server's URL, from which the access token will be requested.
OAuthCredentialsProvider	build()
boolean	clientAssertionEnabled()
OAuthCredentialsProviderBuilder	clientAssertionKeystoreKeyAlias(String clientAssertionKeystoreKeyAlias)
OAuthCredentialsProviderBuilder	clientAssertionKeystoreKeyPassword(String clientAssertionKeystoreKeyPassword)
OAuthCredentialsProviderBuilder	clientAssertionKeystorePassword(String clientAssertionKeystorePassword)
OAuthCredentialsProviderBuilder	clientAssertionKeystorePath(String clientAssertionKeystorePath)
OAuthCredentialsProviderBuilder	clientAssertionKeystorePath(Path clientAssertionKeystorePath)
OAuthCredentialsProviderBuilder	clientId(String clientId)	Client id to be used when requesting access token from OAuth authorization server.
OAuthCredentialsProviderBuilder	clientSecret(String clientSecret)	Client secret to be used when requesting access token from OAuth authorization server.
OAuthCredentialsProviderBuilder	connectTimeout(Duration connectTimeout)	The connection timeout of requests to the OAuth credentials provider.
OAuthCredentialsProviderBuilder	credentialsCachePath(String cachePath)	The location for the credentials cache file.
String	getClientAssertionKeystoreKeyAlias()
String	getClientAssertionKeystoreKeyPassword()
String	getClientAssertionKeystorePassword()
Path	getClientAssertionKeystorePath()
Duration	getConnectTimeout()
Duration	getReadTimeout()
String	getResource()
OAuthCredentialsProviderBuilder	keystoreKeyPassword(String keystoreKeyPassword)	Keystore key password used for OAuth identity provider
OAuthCredentialsProviderBuilder	keystorePassword(String keystorePassword)	Password to keystore used for OAuth identity provider
OAuthCredentialsProviderBuilder	keystorePath(Path keystorePath)	Path to keystore used for OAuth identity provider
OAuthCredentialsProviderBuilder	readTimeout(Duration readTimeout)	The data read timeout of requests to the OAuth credentials provider.
OAuthCredentialsProviderBuilder	resource(String resource)	The resource for which the access token should be valid.
OAuthCredentialsProviderBuilder	scope(String scope)	The scopes of the access token.
OAuthCredentialsProviderBuilder	truststorePassword(String truststorePassword)	Password to truststore used for OAuth identity provider
OAuthCredentialsProviderBuilder	truststorePath(Path truststorePath)	Path to truststore used for OAuth identity provider

Methods inherited from class java.lang.Object

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

Field Details

INVALID_ARGUMENT_MSG

public static final String INVALID_ARGUMENT_MSG

See Also:

• Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final Duration DEFAULT_CONNECT_TIMEOUT

DEFAULT_READ_TIMEOUT

public static final Duration DEFAULT_READ_TIMEOUT

DEFAULT_CREDENTIALS_CACHE_PATH

public static final String DEFAULT_CREDENTIALS_CACHE_PATH

Constructor Details

OAuthCredentialsProviderBuilder

public OAuthCredentialsProviderBuilder()

Method Details

clientId

public OAuthCredentialsProviderBuilder clientId(String clientId)

Client id to be used when requesting access token from OAuth authorization server.

clientSecret

public OAuthCredentialsProviderBuilder clientSecret(String clientSecret)

Client secret to be used when requesting access token from OAuth authorization server.

audience

public OAuthCredentialsProviderBuilder audience(String audience)

The resource for which the access token should be valid.

scope

public OAuthCredentialsProviderBuilder scope(String scope)

The scopes of the access token.

resource

public OAuthCredentialsProviderBuilder resource(String resource)

The resource for which the access token should be valid.

getResource

public String getResource()

See Also:

• resource(String)

authorizationServerUrl

public OAuthCredentialsProviderBuilder authorizationServerUrl(String authorizationServerUrl)

The authorization server's URL, from which the access token will be requested.

keystorePath

public OAuthCredentialsProviderBuilder keystorePath(Path keystorePath)

Path to keystore used for OAuth identity provider

keystorePassword

public OAuthCredentialsProviderBuilder keystorePassword(String keystorePassword)

Password to keystore used for OAuth identity provider

keystoreKeyPassword

public OAuthCredentialsProviderBuilder keystoreKeyPassword(String keystoreKeyPassword)

Keystore key password used for OAuth identity provider

truststorePath

public OAuthCredentialsProviderBuilder truststorePath(Path truststorePath)

Path to truststore used for OAuth identity provider

truststorePassword

public OAuthCredentialsProviderBuilder truststorePassword(String truststorePassword)

Password to truststore used for OAuth identity provider

credentialsCachePath

public OAuthCredentialsProviderBuilder credentialsCachePath(String cachePath)

The location for the credentials cache file. If none (or null) is specified the default will be $HOME/.camunda/credentials

connectTimeout

public OAuthCredentialsProviderBuilder connectTimeout(Duration connectTimeout)

The connection timeout of requests to the OAuth credentials provider. The default value is 5 seconds. Max value is Integer.MAX_VALUE milliseconds.

getConnectTimeout

public Duration getConnectTimeout()

See Also:

• connectTimeout(Duration)

readTimeout

public OAuthCredentialsProviderBuilder readTimeout(Duration readTimeout)

The data read timeout of requests to the OAuth credentials provider. The default value is 5 seconds. Max value is Integer.MAX_VALUE milliseconds.

getReadTimeout

public Duration getReadTimeout()

See Also:

• readTimeout(Duration)

clientAssertionKeystorePath

public OAuthCredentialsProviderBuilder clientAssertionKeystorePath(String clientAssertionKeystorePath)

clientAssertionKeystorePath

public OAuthCredentialsProviderBuilder clientAssertionKeystorePath(Path clientAssertionKeystorePath)

clientAssertionKeystorePassword

public OAuthCredentialsProviderBuilder clientAssertionKeystorePassword(String clientAssertionKeystorePassword)

clientAssertionKeystoreKeyPassword

public OAuthCredentialsProviderBuilder clientAssertionKeystoreKeyPassword(String clientAssertionKeystoreKeyPassword)

clientAssertionKeystoreKeyAlias

public OAuthCredentialsProviderBuilder clientAssertionKeystoreKeyAlias(String clientAssertionKeystoreKeyAlias)

getClientAssertionKeystorePath

public Path getClientAssertionKeystorePath()

getClientAssertionKeystorePassword

public String getClientAssertionKeystorePassword()

getClientAssertionKeystoreKeyAlias

public String getClientAssertionKeystoreKeyAlias()

getClientAssertionKeystoreKeyPassword

public String getClientAssertionKeystoreKeyPassword()

clientAssertionEnabled

public boolean clientAssertionEnabled()

applyEnvironmentOverrides

public OAuthCredentialsProviderBuilder applyEnvironmentOverrides(boolean applyEnvironmentOverrides)

build

public OAuthCredentialsProvider build()

Returns:

a new OAuthCredentialsProvider with the provided configuration options.