org.forgerock.openam.secrets

Interface BaseSecretStoreProvider

All Known Subinterfaces:

KeyStoreBasedSecretStoreProvider, LockedSecretStoreProvider, SimpleSecretStoreProvider

public interface BaseSecretStoreProvider

A marker interface for types that provider secret store implementations. Do not implement this interface directly - implement either LockedSecretStoreProvider or SimpleSecretStoreProvider.

Since:

AM 6.5.0

See Also:

LockedSecretStoreProvider, SimpleSecretStoreProvider

Warning: Evolving API

This type (including all methods, constructors and fields) is 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.

Method Summary

Modifier and Type	Method and Description
String	id() Get an identifier for this secret store provider.

Method Detail

id

String id()

Get an identifier for this secret store provider. This could be implemented by overriding in an annotated configuration interface using the Id annotation, but could equally be given a unique identifier if the implementation is not config-based.

Returns:

The identifier.