Package org.forgerock.openam.secrets

The AM supporting classes for centrally configuring secrets.

See: Description

Interface Summary

Interface	Description
BaseSecretStoreProvider	A marker interface for types that provider secret store implementations.
KeyStoreKeyIdProvider	This interface allows customization of the key ID values associated with public keys stored in KeyStoreSecretStores.
LockedSecretStoreProvider	A provider of commons SecretStore instances.
SecretIdProvider	This interface allows AM's modules/components to easily expose which secret IDs they are using.
SimpleSecretStoreProvider	Provides instances of the commons secrets SecretStore without needing references to other secrets.

Class Summary

Class	Description
DefaultingPurpose<S extends Secret>	A purpose that can fallback to a default secret ID if the first - more specific - secret ID could not be found in the secrets provider.
SecretIdChoiceValues	A ChoiceValues implementation that fetches the names of all known purposes.
Secrets	The top-level API to obtain secrets in AM.
SecretsProviderFacade	A facade around SecretsProvider instances from the realm and global levels that will delegate correctly to the global provider when a secret is not found in the realm, and knows how to resolve secrets for a DefaultingPurpose.
SecretsReferenceProvider	A class that can provide secret references for a given purpose.
SecretsUtils	Utility methods for dealing with secrets.

Exception Summary

Exception	Description
SecretConfigurationException	An exception that occured when reading the configuration of the secret API.
SecretException	A class of exception arising from use of the secrets API.
SecretInitialisationException	An exception that occurred when initialising the secret API.
SecretInstantiationException	An exception that represents an inability to instantiate a secret object.
UnavailableSecretReferenceException	An exception that occured when a secret reference is not available.

Package org.forgerock.openam.secrets Description

The AM supporting classes for centrally configuring secrets. The entry points to this API are:

• Secrets - for obtaining either a secrets provider for the realm or the global secrets provider.
• SecretIdProvider - for registering secret IDs that are used by extension points.

Warning: Evolving API

This package contains elements that are continuing to evolve and so should be expected to change, potentially in backwards-incompatible ways even in a minor release. Changes are documented at the time of product release.