Uses of Class
org.forgerock.secrets.SecretReference

Packages that use SecretReference

Package	Description
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.credentials	Contains secret credential related API objects.
org.forgerock.secrets.keystore	Implementations of SecretStore for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.

Uses of SecretReference in org.forgerock.secrets

Methods in org.forgerock.secrets that return SecretReference

Modifier and Type	Method	Description
static <T extends Secret> SecretReference<T>	SecretReference.active(SecretsProvider secretsProvider, Purpose<T> purpose, Clock clock)	Creates a reference to the active secret for the given purpose using the given secrets provider.
static <T extends Secret> SecretReference<T>	SecretReference.constant(T secret)	Create a constant SecretReference for the given secret, that will never expire.
<S extends Secret> SecretReference<S>	SecretsProvider.createActiveReference(Purpose<S> purpose)	Creates the secret reference from the given purpose.
<S extends Secret> SecretReference<S>	SecretsProvider.createNamedReference(Purpose<S> purpose, String name)	Creates a reference to a secret with the given name (stable id) for the given purpose.
static <T extends Secret> SecretReference<T>	SecretReference.named(SecretsProvider secretsProvider, Purpose<T> purpose, String name, Clock clock)	Creates a reference to a named secret using the given secrets provider.

Uses of SecretReference in org.forgerock.secrets.credentials

Methods in org.forgerock.secrets.credentials with parameters of type SecretReference

Modifier and Type	Method	Description
static <T extends Secret> CredentialPair<T>	CredentialPair.credentialPair(SecretReference<T> secretReference, Function<T,PrincipalAndSecret<T>,NoSuchSecretException> mapper)	Factory method to create a new instance of CredentialPair from a reference to a secret containing both the principal and secret.
static <T extends Secret> CredentialPair<T>	CredentialPair.fixedPrincipalCredentialPair(String principal, SecretReference<T> secretReference)	Factory method to create a new instance of CredentialPair with a static principal and a dynamic principal secret.

Uses of SecretReference in org.forgerock.secrets.keystore

Constructors in org.forgerock.secrets.keystore with parameters of type SecretReference

Modifier	Constructor	Description
	KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword)	Initialises the keystore using the same password for the keystore and all keys and default configuration options.
	KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, SecretReference<GenericSecret> keyEntryPassword, Options options, KeyStoreSecretStore.StableIdProvider stableIdProvider)	Initialises the key store.
	KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, Options options)	Initialises the keystore using the same password for the keystore and all keys.