Package org.forgerock.openam.secrets

Interface LockedSecretStoreProvider

All Superinterfaces:

BaseSecretStoreProvider

All Known Subinterfaces:

GoogleSecretManagerSecretStoreProvider, KeyStoreBasedSecretStoreProvider

@EvolvingAll
public interface LockedSecretStoreProvider
extends BaseSecretStoreProvider

A provider of commons SecretStore instances. These might be obtained from configuration, or from some other static means.

Subtypes of this interface are secret stores which use other secrets to initialise themselves.

Since:

AM 6.5.0

Method Summary

Modifier and Type	Method	Description
SecretStore<? extends Secret>	getStore(SecretStoreContext context, SecretsReferenceProvider secrets)	Get the commons SecretStore instance for this instance.

Methods inherited from interface org.forgerock.openam.secrets.BaseSecretStoreProvider

id

Method Detail

getStore

SecretStore<? extends Secret> getStore(SecretStoreContext context,
                                       SecretsReferenceProvider secrets)
                                throws SecretException

Get the commons SecretStore instance for this instance.

Parameters:

context - The context in which the store is being created.

secrets - A provider of secret references that can be used to obtain secrets that are needed to unlock the SecretStore.

Returns:

The instance.

Throws:

SecretException - If the store cannot be constructed for some reason.