Package org.forgerock.openam.secrets

Class SecretsReferenceProvider

java.lang.Object

org.forgerock.openam.secrets.SecretsReferenceProvider

@EvolvingAll
public class SecretsReferenceProvider
extends Object

A class that can provide secret references for a given purpose.

Since:

AM 6.5.0

Constructor Summary

Constructors

Constructor	Description
SecretsReferenceProvider(SecretsProvider secretsProvider)

Method Summary

Modifier and Type	Method	Description
<T extends Secret> SecretReference<T>	get(Purpose<T> purpose)	Get the reference for the secrets that fulfil the purpose.

Methods inherited from class java.lang.Object

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

Constructor Details

SecretsReferenceProvider

public SecretsReferenceProvider(SecretsProvider secretsProvider)

Method Details

get

public <T extends Secret> SecretReference<T> get(Purpose<T> purpose)
                                          throws UnavailableSecretReferenceException

Get the reference for the secrets that fulfil the purpose.

Type Parameters:

T - The type of the secret.

Parameters:

purpose - The purpose.

Returns:

The reference.

Throws:

UnavailableSecretReferenceException