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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<DirectoryWatcher>getDirectoryWatcher()Provides aDirectoryWatcherto use to monitor files and directories for changes.Optional<Realm>getRealm()The realm that the store is being instantiated in, orOptional.empty()if it is being created as a global store.AnnotatedServiceRegistrygetServiceRegistry()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.StringtoString() 
 - 
 
- 
- 
Method Detail
- 
getRealm
public Optional<Realm> getRealm()
The realm that the store is being instantiated in, orOptional.empty()if it is being created as a global store.- Returns:
 - the store realm.
 
 
- 
getDirectoryWatcher
public Optional<DirectoryWatcher> getDirectoryWatcher()
Provides aDirectoryWatcherto use to monitor files and directories for changes. This component may not be available on all platforms, in which case this method will returnOptional.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.
 
 
 - 
 
 -