Package org.forgerock.openam.secrets
@Evolving
package org.forgerock.openam.secrets
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.
-
ClassDescriptionA marker interface for types that provider secret store implementations.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.This interface allows customization of the key ID values associated with public keys stored in
KeyStoreSecretStores.A provider of commonsSecretStoreinstances.An exception that occured when reading the configuration of the secret API.A class of exception arising from use of the secrets API.AChoiceValuesimplementation that fetches the names of all known purposes.This interface allows AM's modules/components to easily expose which secret IDs they are using.An exception that occurred when initialising the secret API.An exception that represents an inability to instantiate a secret object.The top-level API to obtain secrets in AM.A facade aroundSecretsProviderinstances 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 aDefaultingPurpose.A class that can provide secret references for a given purpose.Encapsulates the context in which a secret store is being instantiated.Utility methods for dealing with secrets.Provides instances of the commons secretsSecretStorewithout needing references to other secrets.An exception that occured when a secret reference is not available.