Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.cloud

Interface CloudCredentialManager

All Known Implementing Classes:

CloudCredentialManager.Noop

public interface CloudCredentialManager

Cloud credential management for runtime handling (read and write of the active ThreadContext) and persistence (decoding a PersistedCloudCredential envelope into a usable CloudCredential).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CloudCredentialManager.Noop	No-op default used when no real implementation is loaded.

Method Summary

Modifier and Type	Method	Description
CloudCredential	extractCloudManagedCredential(ThreadContext threadContext)	Extracts the caller's cloud credential from threadContext.
boolean	hasCloudManagedCredential(ThreadContext threadContext)	Checks if there is a cloud credential in the thread context.
void	injectCloudManagedCredential(ThreadContext threadContext, CloudCredential credential)	Injects a CloudCredential into threadContext so downstream actions can authenticate with it.
default CloudCredentialResolver	resolverOf(CloudCredential credential)	Returns a resolver backed by an in-memory credential.
CloudCredentialResolver	resolverOf(PersistedCloudCredential persisted)	Returns a resolver backed by a persisted credential.
default Client	wrapClient(Client delegate, CloudCredential credential)	Wraps client and injects the cloud credential via resolverOf(CloudCredential).
Client	wrapClient(Client delegate, CloudCredentialResolver resolver)	Returns a cloud-credentials-aware Client.
default Client	wrapClient(Client delegate, PersistedCloudCredential persisted)	Wraps client and injects the cloud credential via resolverOf(PersistedCloudCredential).

Method Details

hasCloudManagedCredential

boolean hasCloudManagedCredential(ThreadContext threadContext)

Checks if there is a cloud credential in the thread context.

extractCloudManagedCredential

CloudCredential extractCloudManagedCredential(ThreadContext threadContext)

Extracts the caller's cloud credential from threadContext.

Precondition: hasCloudManagedCredential(ThreadContext) must return true; otherwise the call fails with an unchecked exception.

Returns:

the caller's cloud credential

injectCloudManagedCredential

void injectCloudManagedCredential(ThreadContext threadContext,
 CloudCredential credential)

Injects a CloudCredential into threadContext so downstream actions can authenticate with it.

resolverOf

default CloudCredentialResolver resolverOf(CloudCredential credential)

Returns a resolver backed by an in-memory credential.

resolverOf

CloudCredentialResolver resolverOf(PersistedCloudCredential persisted)

Returns a resolver backed by a persisted credential.

wrapClient

Client wrapClient(Client delegate,
 CloudCredentialResolver resolver)

Returns a cloud-credentials-aware Client. On every execute(...) the implementation obtains a CloudCredential from resolver, injects it into the active ThreadContext via injectCloudManagedCredential(org.elasticsearch.common.util.concurrent.ThreadContext, org.elasticsearch.xpack.core.security.cloud.CloudCredential), and dispatches to delegate under that isolated context.

The credential or persisted envelope captured by resolver must remain open for the lifetime of the returned client.

wrapClient

default Client wrapClient(Client delegate,
 @Nullable
 CloudCredential credential)

Wraps client and injects the cloud credential via resolverOf(CloudCredential). Returns delegate when credential is null.

wrapClient

default Client wrapClient(Client delegate,
 @Nullable
 PersistedCloudCredential persisted)

Wraps client and injects the cloud credential via resolverOf(PersistedCloudCredential). Returns delegate when persisted is null.