Package io.camunda.client.impl.oauth

Class OAuthCredentialsProvider

java.lang.Object

io.camunda.client.impl.oauth.OAuthCredentialsProvider

All Implemented Interfaces:

CredentialsProvider

@ThreadSafe
public final class OAuthCredentialsProvider
extends Object
implements CredentialsProvider

This class is thread-safe in terms of the next: 1. If you are trying to modify headers of your request from the several threads there would be sequential calls to the cache 2. If the cache hasn't a valid token and you are calling from several threads there would be just one call to the Auth server

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.CredentialsProvider

CredentialsProvider.CredentialsApplier, CredentialsProvider.StatusCode

Method Summary

Modifier and Type	Method	Description
void	applyCredentials(CredentialsProvider.CredentialsApplier applier)	Adds an access token to the Authorization header of a gRPC call.
boolean	isClientAssertionEnabled()
boolean	shouldRetryRequest(CredentialsProvider.StatusCode statusCode)	Returns true if the request should be retried — meaning the token was refreshed (either by this thread or a concurrent one) and a retry with the new token is worthwhile.

Methods inherited from class java.lang.Object

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

Method Details

isClientAssertionEnabled

public boolean isClientAssertionEnabled()

applyCredentials

public void applyCredentials(CredentialsProvider.CredentialsApplier applier)
                      throws IOException

Adds an access token to the Authorization header of a gRPC call.

Specified by:

applyCredentials in interface CredentialsProvider

Parameters:

applier - where to add the credentials headers

Throws:

IOException

shouldRetryRequest

public boolean shouldRetryRequest(CredentialsProvider.StatusCode statusCode)

Returns true if the request should be retried — meaning the token was refreshed (either by this thread or a concurrent one) and a retry with the new token is worthwhile. Returns false if the failure was not an auth error, or if the freshly fetched credentials are identical to the cached ones (indicating the 401 was not caused by a stale token). Delegates to OAuthCredentialsCache.forceRefreshIfChanged(java.lang.String, io.camunda.client.impl.util.SupplierWithIO<io.camunda.client.impl.CamundaClientCredentials>) which is synchronized on the same monitor as OAuthCredentialsCache.computeIfMissingOrInvalid(java.lang.String, io.camunda.client.impl.util.SupplierWithIO<io.camunda.client.impl.CamundaClientCredentials>), ensuring that concurrent 401 retries coalesce into a single token refresh call.

Specified by:

shouldRetryRequest in interface CredentialsProvider

Parameters:

statusCode - the response code for the failure