Module org.elasticsearch.xcore

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

Class CloudCredentialManager.Noop

java.lang.Object

org.elasticsearch.xpack.core.security.cloud.CloudCredentialManager.Noop

All Implemented Interfaces:

CloudCredentialManager

Enclosing interface:

CloudCredentialManager

public static class CloudCredentialManager.Noop
extends Object
implements CloudCredentialManager

No-op default used when no real implementation is loaded.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.core.security.cloud.CloudCredentialManager

CloudCredentialManager.Noop

Constructor Summary

Constructors

Constructor	Description
Noop()

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.
CloudCredentialResolver	resolverOf(PersistedCloudCredential persisted)	Returns a resolver backed by a persisted credential.
Client	wrapClient(Client delegate, CloudCredential credential)	Wraps client and injects the cloud credential via CloudCredentialManager.resolverOf(CloudCredential).
Client	wrapClient(Client delegate, CloudCredentialResolver resolver)	Returns a cloud-credentials-aware Client.
Client	wrapClient(Client delegate, PersistedCloudCredential persisted)	Wraps client and injects the cloud credential via CloudCredentialManager.resolverOf(PersistedCloudCredential).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xpack.core.security.cloud.CloudCredentialManager

resolverOf

Constructor Details

Noop

public Noop()

Method Details

hasCloudManagedCredential

public boolean hasCloudManagedCredential(ThreadContext threadContext)

Description copied from interface: CloudCredentialManager

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

Specified by:

hasCloudManagedCredential in interface CloudCredentialManager

extractCloudManagedCredential

public CloudCredential extractCloudManagedCredential(ThreadContext threadContext)

Description copied from interface: CloudCredentialManager

Extracts the caller's cloud credential from threadContext.

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

Specified by:

extractCloudManagedCredential in interface CloudCredentialManager

Returns:

the caller's cloud credential

injectCloudManagedCredential

public void injectCloudManagedCredential(ThreadContext threadContext,
 CloudCredential credential)

Description copied from interface: CloudCredentialManager

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

Specified by:

injectCloudManagedCredential in interface CloudCredentialManager

resolverOf

public CloudCredentialResolver resolverOf(PersistedCloudCredential persisted)

Description copied from interface: CloudCredentialManager

Returns a resolver backed by a persisted credential.

Specified by:

resolverOf in interface CloudCredentialManager

wrapClient

public Client wrapClient(Client delegate,
 CloudCredentialResolver resolver)

Description copied from interface: CloudCredentialManager

Returns a cloud-credentials-aware Client. On every execute(...) the implementation obtains a CloudCredential from resolver, injects it into the active ThreadContext via CloudCredentialManager.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.

Specified by:

wrapClient in interface CloudCredentialManager

wrapClient

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

Description copied from interface: CloudCredentialManager

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

Specified by:

wrapClient in interface CloudCredentialManager

wrapClient

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

Description copied from interface: CloudCredentialManager

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

Specified by:

wrapClient in interface CloudCredentialManager