Package org.forgerock.openam.secrets

Class SecretStoreContext

java.lang.Object

org.forgerock.openam.secrets.SecretStoreContext

@EvolvingAll
public class SecretStoreContext
extends Object

Encapsulates the context in which a secret store is being instantiated.

Method Summary

Modifier and Type	Method	Description
Optional<DirectoryWatcher>	getDirectoryWatcher()	Provides a DirectoryWatcher to use to monitor files and directories for changes.
Optional<Realm>	getRealm()	The realm that the store is being instantiated in, or Optional.empty() if it is being created as a global store.
AnnotatedServiceRegistry	getServiceRegistry()	Provides access to the service registry for looking up configuration that is associated with a secret store but configured elsewhere, such as service account settings.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getRealm

public Optional<Realm> getRealm()

The realm that the store is being instantiated in, or Optional.empty() if it is being created as a global store.

Returns:

the store realm.

getDirectoryWatcher

public Optional<DirectoryWatcher> getDirectoryWatcher()

Provides a DirectoryWatcher to use to monitor files and directories for changes. This component may not be available on all platforms, in which case this method will return Optional.empty().

Returns:

the directory watcher, if one is available.

getServiceRegistry

public AnnotatedServiceRegistry getServiceRegistry()

Provides access to the service registry for looking up configuration that is associated with a secret store but configured elsewhere, such as service account settings.

Returns:

the service registry.

toString

public String toString()

Overrides:

toString in class Object