org.forgerock.openam.secrets

Class Secrets

java.lang.Object

org.forgerock.openam.secrets.Secrets

@Singleton
public class Secrets
extends Object

The top-level API to obtain secrets in AM. This class will provide secrets from all secret stores that are defined in SMS configuration, and any other sources that are applicable to the AM runtime.

Since:

AM 6.5.0

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.

Constructor Summary

Constructors

Constructor and Description
Secrets(AnnotatedServiceRegistry serviceRegistry) DI constructor for the Secrets class.

Method Summary

Modifier and Type	Method and Description
SecretsProviderFacade	getGlobalSecrets() Get the global secrets provider for the realm.
SecretsProviderFacade	getRealmSecrets(Realm realm) Get a secrets provider for the realm.
protected SecretsReferenceProvider	getSecretsReferenceProvider(List<SecretStore> allStores)
boolean	isGlobalSecretsService(String serviceName) Check to see if this is a purpose.
boolean	isSecretService(String serviceName) Check to see if a service is a Secret API service.
void	registerSecretStore(Class<? extends BaseSecretStoreProvider> storeType) Register a secret store type.
void	start() Start the secrets service.

Methods inherited from class java.lang.Object

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

Constructor Detail

Secrets

@Inject
public Secrets(AnnotatedServiceRegistry serviceRegistry)

DI constructor for the Secrets class.

Parameters:

serviceRegistry - The service registry for annotated services, which all configuration-based secret stores are expected to be.

Method Detail

registerSecretStore

public void registerSecretStore(Class<? extends BaseSecretStoreProvider> storeType)

Register a secret store type. This method is only expected to be called from the plugin tools.

Parameters:

storeType - The type of the secrets store.

start

public void start()

Start the secrets service.

getGlobalSecrets

public SecretsProviderFacade getGlobalSecrets()
                                       throws SecretException

Get the global secrets provider for the realm.

Returns:

A secrets provider for all the secret stores that are configured globally.

Throws:

SecretException - In the case of failure to read configuration.

getRealmSecrets

public SecretsProviderFacade getRealmSecrets(Realm realm)
                                      throws SecretException

Get a secrets provider for the realm.

Parameters:

realm - The realm.

Returns:

A secrets provider for all the secret stores that are configured.

Throws:

SecretException - In the case of failure to read configuration.

isSecretService

public boolean isSecretService(String serviceName)

Check to see if a service is a Secret API service.

Parameters:

serviceName - The name of the service to check.

isGlobalSecretsService

public boolean isGlobalSecretsService(String serviceName)

Check to see if this is a purpose.

Parameters:

serviceName - The name of the service to check.

getSecretsReferenceProvider

protected SecretsReferenceProvider getSecretsReferenceProvider(List<SecretStore> allStores)