org.forgerock.secrets

Class SecretReference<T extends Secret>

java.lang.Object

org.forgerock.secrets.SecretReference<T>

Type Parameters:

T - the type of secret that this reference stores.

public final class SecretReference<T extends Secret>
extends Object

A long-lived reference to an active secret. The secret will be transparently refreshed as required by the lease expiry on the secret object.

A secret reference is thread-safe.

Constructor Summary

Constructors

Constructor and Description
SecretReference(SecretsProvider provider, Purpose<T> purpose) Constructs the secret reference from the given provider and purpose using the system clock to check for expiry.
SecretReference(SecretsProvider provider, Purpose<T> purpose, Clock clock) Constructs the secret reference from the given provider and purpose.

Method Summary

Modifier and Type	Method and Description
static <T extends Secret> SecretReference<T>	constant(T secret) Create a constant SecretReference for the given secret, that will never expire.
T	get() Gets the current active secret object, refreshing it if necessary.
Promise<T,NoSuchSecretException>	getAsync() Gets the current active secret object asynchronously, refreshing it if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretReference

public SecretReference(SecretsProvider provider,
                       Purpose<T> purpose,
                       Clock clock)

Constructs the secret reference from the given provider and purpose.

Parameters:

provider - the secrets provider to obtain the secret value from.

purpose - the purpose for which a secret is required.

clock - the clock to use when checking if the secret has expired.

SecretReference

public SecretReference(SecretsProvider provider,
                       Purpose<T> purpose)

Constructs the secret reference from the given provider and purpose using the system clock to check for expiry.

Parameters:

provider - the secrets provider to obtain the secret value from.

purpose - the purpose for which a secret is required.

Method Detail

get

public T get()
      throws NoSuchSecretException

Gets the current active secret object, refreshing it if necessary. This will block until the secret is available.

Returns:

the active secret for the configured purpose.

Throws:

NoSuchSecretException - if no active secret is available for the configured purpose.

getAsync

public Promise<T,NoSuchSecretException> getAsync()

Gets the current active secret object asynchronously, refreshing it if necessary.

Returns:

a promise for the current active secret.

constant

public static <T extends Secret> SecretReference<T> constant(T secret)

Create a constant SecretReference for the given secret, that will never expire.

Type Parameters:

T - The type of the secret.

Parameters:

secret - The secret.

Returns:

The constant reference.