Package org.forgerock.openam.secrets.config

Interface KeyStoreBasedSecretStoreProvider

All Superinterfaces:

BaseSecretStoreProvider, LockedSecretStoreProvider, org.forgerock.openam.secrets.SecretStoreWithMappings

@EvolvingAll
public interface KeyStoreBasedSecretStoreProvider
extends LockedSecretStoreProvider, org.forgerock.openam.secrets.SecretStoreWithMappings

An abstraction of initialising a keystore-based BaseSecretStoreProvider.

Since:

AM 6.5.0

Method Summary

Modifier and Type	Method	Description
KeyStoreSecretStore	createStore(SecretStoreContext context, SecretsReferenceProvider secrets)	Create the KeyStoreSecretStore from the configuration.
default KeyStoreSecretStore	getStore(SecretStoreContext context, SecretsReferenceProvider secrets)	Get the commons SecretStore instance for this instance.
org.forgerock.openam.sm.annotations.subconfigs.Multiple<PurposeMapping>	mappings()	The configured purposes for this key store.

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

id

Method Details

mappings

org.forgerock.openam.sm.annotations.subconfigs.Multiple<PurposeMapping> mappings()

The configured purposes for this key store.

Returns:

The sub-configurations.

getStore

default KeyStoreSecretStore getStore(SecretStoreContext context,
 SecretsReferenceProvider secrets)
                              throws SecretException

Description copied from interface: LockedSecretStoreProvider

Get the commons SecretStore instance for this instance.

Specified by:

getStore in interface LockedSecretStoreProvider

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.

createStore

KeyStoreSecretStore createStore(SecretStoreContext context,
 SecretsReferenceProvider secrets)
                         throws SecretException

Create the KeyStoreSecretStore from the configuration.

Parameters:

context - The secret store context.

secrets - The provider of secret references for resolving secrets that unlock the keystore.

Returns:

The store.

Throws:

SecretException - If the store could not be created for some reason.