Package io.camunda.zeebe.client

Interface CredentialsProvider

All Known Implementing Classes:

NoopCredentialsProvider, OAuthCredentialsProvider

public interface CredentialsProvider

Implementations of this interface must be thread-safe.

Method Summary

Modifier and Type	Method	Description
void	applyCredentials(io.grpc.Metadata headers)	Adds credentials to the headers.
static OAuthCredentialsProviderBuilder	newCredentialsProviderBuilder()
boolean	shouldRetryRequest(Throwable throwable)	Returns true if the request should be retried; otherwise returns false.

Method Details

applyCredentials

void applyCredentials(io.grpc.Metadata headers)
               throws IOException

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

Parameters:

headers - gRPC headers to be modified

Throws:

IOException

shouldRetryRequest

boolean shouldRetryRequest(Throwable throwable)

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

Parameters:

throwable - error that caused the request to fail

newCredentialsProviderBuilder

static OAuthCredentialsProviderBuilder newCredentialsProviderBuilder()

Returns:

a builder to configure and create a new OAuthCredentialsProvider.