Package io.camunda.zeebe.client

Interface CredentialsProvider

All Known Implementing Classes:

NoopCredentialsProvider, OAuthCredentialsProvider

public interface CredentialsProvider

Implementations of this interface must be thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CredentialsProvider.CredentialsApplier	Used to apply call credentials on a per-request basis, abstracting over gRPC and REST.
static interface	CredentialsProvider.StatusCode	Represents the result of a failed call, abstracting over gRPC and standard HTTP status codes.

Method Summary

Modifier and Type	Method	Description
void	applyCredentials(CredentialsProvider.CredentialsApplier applier)	Adds credentials to the headers.
static OAuthCredentialsProviderBuilder	newCredentialsProviderBuilder()
boolean	shouldRetryRequest(CredentialsProvider.StatusCode statusCode)	Returns true if the request should be retried; otherwise returns false.

Method Details

applyCredentials

void applyCredentials(CredentialsProvider.CredentialsApplier applier)
               throws IOException

Adds credentials to the headers. For an example of this, see OAuthCredentialsProvider.applyCredentials(CredentialsApplier)

Parameters:

applier - where to add the credentials headers

Throws:

IOException

shouldRetryRequest

boolean shouldRetryRequest(CredentialsProvider.StatusCode statusCode)

Returns true if the request should be retried; otherwise returns false. For an example of this, see OAuthCredentialsProvider.shouldRetryRequest(StatusCode).

Only called for REST calls

Parameters:

statusCode - the response code for the failure

newCredentialsProviderBuilder

static OAuthCredentialsProviderBuilder newCredentialsProviderBuilder()

Returns:

a builder to configure and create a new OAuthCredentialsProvider.