Package io.camunda.zeebe.client.impl.oauth

Class OAuthCredentialsProviderBuilder

java.lang.Object

io.camunda.zeebe.client.impl.oauth.OAuthCredentialsProviderBuilder

public final class OAuthCredentialsProviderBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_ARGUMENT_MSG
static final String	OAUTH_ENV_AUTHORIZATION_SERVER
static final String	OAUTH_ENV_CACHE_PATH
static final String	OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_KEY_ALIAS
static final String	OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_KEY_PASSWORD
static final String	OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_PASSWORD
static final String	OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_PATH
static final String	OAUTH_ENV_CLIENT_ID
static final String	OAUTH_ENV_CLIENT_SECRET
static final String	OAUTH_ENV_CONNECT_TIMEOUT
static final String	OAUTH_ENV_READ_TIMEOUT
static final String	OAUTH_ENV_TOKEN_AUDIENCE
static final String	OAUTH_ENV_TOKEN_RESOURCE
static final String	OAUTH_ENV_TOKEN_SCOPE

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 request.
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	readTimeout(Duration readTimeout)	The data read timeout of request.
OAuthCredentialsProviderBuilder	resource(String resource)	The resource for which the access token should be valid.
OAuthCredentialsProviderBuilder	scope(String scope)	The scopes of the access token.

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

OAUTH_ENV_CLIENT_ID

public static final String OAUTH_ENV_CLIENT_ID

See Also:

• Constant Field Values

OAUTH_ENV_CLIENT_SECRET

public static final String OAUTH_ENV_CLIENT_SECRET

See Also:

• Constant Field Values

OAUTH_ENV_TOKEN_AUDIENCE

public static final String OAUTH_ENV_TOKEN_AUDIENCE

See Also:

• Constant Field Values

OAUTH_ENV_TOKEN_SCOPE

public static final String OAUTH_ENV_TOKEN_SCOPE

See Also:

• Constant Field Values

OAUTH_ENV_TOKEN_RESOURCE

public static final String OAUTH_ENV_TOKEN_RESOURCE

See Also:

• Constant Field Values

OAUTH_ENV_AUTHORIZATION_SERVER

public static final String OAUTH_ENV_AUTHORIZATION_SERVER

See Also:

• Constant Field Values

OAUTH_ENV_CACHE_PATH

public static final String OAUTH_ENV_CACHE_PATH

See Also:

• Constant Field Values

OAUTH_ENV_CONNECT_TIMEOUT

public static final String OAUTH_ENV_CONNECT_TIMEOUT

See Also:

• Constant Field Values

OAUTH_ENV_READ_TIMEOUT

public static final String OAUTH_ENV_READ_TIMEOUT

See Also:

• Constant Field Values

OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_PATH

public static final String OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_PATH

See Also:

• Constant Field Values

OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_PASSWORD

public static final String OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_PASSWORD

See Also:

• Constant Field Values

OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_KEY_ALIAS

public static final String OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_KEY_ALIAS

See Also:

• Constant Field Values

OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_KEY_PASSWORD

public static final String OAUTH_ENV_CLIENT_ASSERTION_KEYSTORE_KEY_PASSWORD

See Also:

• Constant Field Values

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.

authorizationServerUrl

public OAuthCredentialsProviderBuilder authorizationServerUrl(String authorizationServerUrl)

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

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 request. 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 request. The default value is 5 seconds. Max value is Integer.MAX_VALUE milliseconds.

getReadTimeout

public Duration getReadTimeout()

See Also:

• readTimeout(Duration)

resource

public OAuthCredentialsProviderBuilder resource(String resource)

The resource for which the access token should be valid.

getResource

public String getResource()

See Also:

• resource(String)

build

public OAuthCredentialsProvider build()

Returns:

a new OAuthCredentialsProvider with the provided configuration options.

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)