Uses of Class org.forgerock.secrets.SecretsProvider (OpenDJ Public API Javadoc 7.4.3-20241015115352-209ff3c0000cb208c40a9a5f707924f0af03b332 Documentation)

Packages that use SecretsProvider
Package	Description
org.forgerock.config.resolvers	This package contains the common config property resolvers.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
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 SecretsProvider in org.forgerock.config.resolvers

Methods in org.forgerock.config.resolvers with parameters of type SecretsProvider
Modifier and Type	Method	Description
`static PropertyResolver`	PropertyResolvers.`secretsPropertyResolver(SecretsProvider secretsProvider)`	Constructs a resolver that looks up `GenericSecret`s from the given `SecretsProvider` and converts them to UTF-8 strings.

Uses of SecretsProvider in org.forgerock.secrets

Methods in org.forgerock.secrets that return SecretsProvider
Modifier and Type	Method	Description
`<T extends Secret> SecretsProvider`	SecretsProvider.`setActiveStore(SecretStore<? super T> store, Purpose<? extends T>... purposes)`	Sets the active store to use for the given purpose.
`SecretsProvider`	SecretsProvider.`setDefaultStores(SecretStore<?> activeStore, SecretStore<?>... defaultStores)`	Sets the default store(s) to use if there is no specific store configured for a particular purpose.
`<S extends Secret> SecretsProvider`	SecretsProvider.`useSpecificSecretForPurpose(Purpose<S> purpose, S secret)`	Configures this SecretsProvider to always return the specific given secret for the given purpose.
`<S extends Secret> SecretsProvider`	SecretsProvider.`useSpecificSecretsForPurpose(Purpose<S> purpose, List<S> secrets)`	Configures this SecretsProvider to always return the specific given secrets for the given purpose.

Methods in org.forgerock.secrets with parameters of type SecretsProvider
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.`named(SecretsProvider secretsProvider, Purpose<T> purpose, String name, Clock clock)`	Creates a reference to a named secret using the given secrets provider.
`static <T extends Secret> ValidSecretsReference<T,NeverThrowsException>`	ValidSecretsReference.`valid(SecretsProvider secretsProvider, Purpose<T> purpose, Clock clock)`	Creates a reference to the valid secrets for the given purpose using the given secrets provider.
`static <T extends Secret> ValidSecretsReference<T,NeverThrowsException>`	ValidSecretsReference.`validOrNamed(SecretsProvider secretsProvider, Purpose<T> purpose, String name, Clock clock)`	This creates a reference to either the named secret or all valid secrets for the purpose.

Constructors in org.forgerock.secrets with parameters of type SecretsProvider
Constructor	Description
`SecretReference(SecretsProvider provider, Purpose<T> purpose)`	Deprecated. Use `createActiveReference(Purpose)` or `SecretReference.active(SecretsProvider, Purpose, Clock)` instead.
`SecretReference(SecretsProvider provider, Purpose<T> purpose, Clock clock)`	Deprecated. Use `createActiveReference(Purpose)` or `SecretReference.active(SecretsProvider, Purpose, Clock)` instead.
`SecretsLoadStoreParameter(SecretsProvider secretsProvider, Set<Purpose<? extends CryptoKey>> purposes, Clock clock)`	Initialises the keystore with the given secrets API objects.
`SecretsLoadStoreParameter(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose, Clock clock)`	Initialises the keystore with the given secrets API objects.

Uses of SecretsProvider in org.forgerock.secrets.propertyresolver

Constructors in org.forgerock.secrets.propertyresolver with parameters of type SecretsProvider
Constructor	Description
`PemPropertyFormat(SecretsProvider secretsProvider, Purpose<GenericSecret> decryptionPasswordPurpose)`	Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.
`PemPropertyFormat(SecretsProvider secretsProvider, Purpose<GenericSecret> decryptionPasswordPurpose, Supplier<SecretBuilder> secretBuilderSupplier)`	Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.