Uses of Class
org.forgerock.secrets.Purpose

Packages that use Purpose

Package	Description
org.forgerock.oauth.resolvers	This package contains classes to generate Open ID Resolvers, which can validate a supplied JWS against an Open ID Connect provider.
org.forgerock.openam.secrets	The AM supporting classes for centrally configuring secrets.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.
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.
org.forgerock.secrets.propertyresolver	Provides a SecretStore implementation that loads secrets from a Common Configuration PropertyResolver and then decodes it with a SecretPropertyFormat.

Uses of Purpose in org.forgerock.oauth.resolvers

Methods in org.forgerock.oauth.resolvers with parameters of type Purpose

Modifier and Type	Method and Description
OpenIdResolver	OpenIdResolverFactory.createSecretsProviderResolver(String issuer, SecretsProvider provider, Purpose<VerificationKey> purpose) Creates a public key based resolver for the supplied issuer using keys available through the given provider.

Uses of Purpose in org.forgerock.openam.secrets

Methods in org.forgerock.openam.secrets that return Purpose

Modifier and Type	Method and Description
Purpose<S>	DefaultingPurpose.getCustomPurpose(String instanceId) Returns the instance specific purpose.
Purpose<S>	DefaultingPurpose.getDefaultPurpose() Returns the default purpose.
static Purpose<KeyEncryptionKey>	SecretsUtils.realmQualifiedEncryptionPurpose(String realm, String rootPurpose) Returns the purpose to use at the global scope for looking up a realm-specific encryption key.

Constructors in org.forgerock.openam.secrets with parameters of type Purpose

Constructor and Description
DefaultingPurpose(Purpose<S> defaultPurpose, String customSecretId) Creates a new defaulting purpose.

Uses of Purpose in org.forgerock.secrets

Fields in org.forgerock.secrets declared as Purpose

Modifier and Type	Field and Description
static Purpose<DataDecryptionKey>	Purpose.DATA_DECRYPTION Indicates a key intended for decrypting data.
static Purpose<DataEncryptionKey>	Purpose.DATA_ENCRYPTION Indicates a key intended for encrypting data.
static Purpose<KeyAgreementKey>	Purpose.KEY_AGREEMENT Indicates a key intended for an interactive key agreement protocol, such as Diffie-Hellman (DH) or the elliptic curve equivalent (ECDH).
static Purpose<KeyDecryptionKey>	Purpose.KEY_DECRYPTION Indicates a key intended for decrypting ("unwrapping") other keys.
static Purpose<KeyEncryptionKey>	Purpose.KEY_ENCRYPTION Indicates a key intended for encrypting ("wrapping") other keys.
static Purpose<GenericSecret>	Purpose.PASSWORD Indicates a secret intended to be used as a password for authentication to some service.
static Purpose<SigningKey>	Purpose.SIGN Indicates a key intended for creating digital signatures or message authentication codes (MACs).
static Purpose<VerificationKey>	Purpose.VERIFY Indicates a key intended for verifying digital signatures or message authentication codes.

Methods in org.forgerock.secrets that return Purpose

Modifier and Type	Method and Description
Purpose<?>	NoSuchSecretException.getPurpose() Returns the purpose for which no secret was found.
static <T extends Secret> Purpose<T>	Purpose.purpose(String label, Class<T> type) Constructs a purpose object.

Methods in org.forgerock.secrets with parameters of type Purpose

Modifier and Type	Method and Description
<S extends T> Promise<S,NoSuchSecretException>	ThreadPoolSecretStore.getActive(Purpose<S> purpose)
<S extends T> Promise<S,NoSuchSecretException>	SecretStore.getActive(Purpose<S> purpose) Returns the active secret for the given purpose.
<S extends Secret> Promise<S,NoSuchSecretException>	SecretsProvider.getActiveSecret(Purpose<S> purpose) Gets the currently active secret for the given purpose.
<S extends T> Promise<S,NoSuchSecretException>	ThreadPoolSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends T> Promise<S,NoSuchSecretException>	SecretStore.getNamed(Purpose<S> purpose, String name) Returns the named secret from this store.
<S extends Secret> Promise<Stream<S>,NeverThrowsException>	SecretsProvider.getNamedOrValidSecrets(Purpose<S> purpose, String id) If the given id is not null, then this returns the single named secret that corresponds to that stable id (or a stream of valid secrets for the given purpose if no such secret exists), otherwise it returns all valid secrets for the given purpose.
<S extends Secret> Promise<S,NoSuchSecretException>	SecretsProvider.getNamedSecret(Purpose<S> purpose, String id) Gets the secret for the given purpose with the given stable secret id.
<S extends T> Promise<Stream<S>,NeverThrowsException>	ThreadPoolSecretStore.getValid(Purpose<S> purpose)
<S extends T> Promise<Stream<S>,NeverThrowsException>	SecretStore.getValid(Purpose<S> purpose) Returns all valid secrets for the given purpose from this store.
<S extends Secret> Promise<Stream<S>,NeverThrowsException>	SecretsProvider.getValidSecrets(Purpose<S> purpose) Returns all secrets for the given purpose which have not yet expired.
void	ThreadPoolSecretStore.retire(Purpose<? extends T> purpose, String secretIdToRetire)
default void	SecretStore.retire(Purpose<? extends T> purpose, String secretIdToRetire) Retires the given secret for the given purpose.
void	ThreadPoolSecretStore.rotate(Purpose<? extends T> purpose, String newActiveSecretId)
default void	SecretStore.rotate(Purpose<? extends T> purpose, String newActiveSecretId) Rotates the active secret for the given purpose.
<T extends Secret> SecretsProvider	SecretsProvider.setActiveStore(SecretStore<? super T> store, Purpose<? extends T>... purposes) Sets the active store to use for the given purpose.
protected <T extends Secret> void	SecretsProvider.setActiveStore(SecretStore<? super T> store, Purpose<? extends T> purpose) Sets the active store to use for the given purpose.

Constructors in org.forgerock.secrets with parameters of type Purpose

Constructor and Description
NoSuchSecretException(Purpose<?> purpose) Constructs the exception for the given purpose.
NoSuchSecretException(Purpose<?> purpose, String id) Constructs the exception for the given purpose and secret stable id.
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.

Uses of Purpose in org.forgerock.secrets.jwkset

Methods in org.forgerock.secrets.jwkset with parameters of type Purpose

Modifier and Type	Method and Description
<S extends CryptoKey> Promise<S,NoSuchSecretException>	JwkSetSecretStore.getActive(Purpose<S> purpose)
<S extends CryptoKey> Promise<S,NoSuchSecretException>	JwkSetSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends CryptoKey> Promise<Stream<S>,NeverThrowsException>	JwkSetSecretStore.getValid(Purpose<S> purpose)

Uses of Purpose in org.forgerock.secrets.keystore

Methods in org.forgerock.secrets.keystore with parameters of type Purpose

Modifier and Type	Method and Description
<S extends CryptoKey> Promise<S,NoSuchSecretException>	KeyStoreSecretStore.getActive(Purpose<S> purpose)
<S extends CryptoKey> Promise<S,NoSuchSecretException>	KeyStoreSecretStore.getNamed(Purpose<S> purpose, String id)
<S extends CryptoKey> Promise<Stream<S>,NeverThrowsException>	KeyStoreSecretStore.getValid(Purpose<S> purpose)
void	KeyStoreSecretStore.retire(Purpose<? extends CryptoKey> purpose, String oldAlias) Retires a key previously used for a given purpose.
void	KeyStoreSecretStore.rotate(Purpose<? extends CryptoKey> purpose, String newAlias) Rotates the key associated with a given purpose.

Uses of Purpose in org.forgerock.secrets.propertyresolver

Methods in org.forgerock.secrets.propertyresolver with parameters of type Purpose

Modifier and Type	Method and Description
<S extends Secret> Promise<S,NoSuchSecretException>	PropertyResolverSecretStore.getActive(Purpose<S> purpose)
<S extends Secret> Promise<S,NoSuchSecretException>	PropertyResolverSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends Secret> Promise<Stream<S>,NeverThrowsException>	PropertyResolverSecretStore.getValid(Purpose<S> purpose)