Uses of Class
org.forgerock.secrets.SecretsProvider
-
Packages that use SecretsProvider Package Description org.forgerock.openig.secrets Provides the Common Secrets API for accessing secrets of various kinds.org.forgerock.openig.util Miscellaneous utility classes.org.forgerock.secrets Provides a unified API for accessing secrets of various kinds. -
-
Uses of SecretsProvider in org.forgerock.openig.secrets
Subclasses of SecretsProvider in org.forgerock.openig.secrets Modifier and Type Class Description class
SecretsServiceProvider
Adapter class to present an instance ofSecretsService
as aSecretsProvider
.Methods in org.forgerock.openig.secrets that return SecretsProvider Modifier and Type Method Description static SecretsProvider
SecretsUtils. getSecretsProviderOrSecretsService(org.slf4j.Logger logger, JsonValue node, Heap heap)
Returns aSecretsProvider
as specified with the secretsProvider attribute or falling back to a newSecretsProvider
wrapping theSecretsService
found in the heap.Methods in org.forgerock.openig.secrets that return types with arguments of type SecretsProvider Modifier and Type Method Description static Function<JsonValue,SecretsProvider,HeapException>
SecretsProviderHeaplet. secretsProvider(Heap heap)
Method supporting other client heaplets that wish to create aSecretsProvider
using alternative compact configuration formats.Methods in org.forgerock.openig.secrets with parameters of type SecretsProvider Modifier and Type Method Description static byte[]
SecretsUtils. getPasswordSecretIdOrPasswordAsByte(SecretsProvider secretsProvider, JsonValue secretIdNode, JsonValue deprecatedNode, org.slf4j.Logger logger)
Retrieve a required shared secret value (asbyte[]
) from the givensecretIdNode
anddeprecatedNode
nodes.static <S extends CryptoKey>
SSecretsUtils. retrieveCryptoKeyFromSecretId(SecretsProvider secretsProvider, JsonValue secretIdNode, Class<S> type)
Retrieves aCryptoKey
from the given node.static <S extends CryptoKey>
KeySecretsUtils. retrieveKeyFromSecretId(SecretsProvider secretsProvider, JsonValue secretIdNode, Class<S> type)
Retrieves aKey
from the given node.static SecretReference<GenericSecret>
SecretsUtils. retrievePasswordAsReference(SecretsProvider secretsProvider, JsonValue secretIdNode, JsonValue deprecatedNode, org.slf4j.Logger logger)
Retrieve a required password as aSecretReference
from the givensecretIdNode
anddeprecatedNode
nodes.static SecretReference<GenericSecret>
SecretsUtils. retrievePasswordAsReference(SecretsProvider secretsProvider, JsonValue secretIdNode, JsonValue deprecatedNode, org.slf4j.Logger logger, boolean isRequired)
DefaultSecretsService.Builder
DefaultSecretsService.Builder. withSecretsProvider(SecretsProvider provider)
Configure this service with the givenprovider
.Constructors in org.forgerock.openig.secrets with parameters of type SecretsProvider Constructor Description DefaultSecretsService(SecretsProvider provider)
Constructs a newDefaultSecretsService
with a given provider. -
Uses of SecretsProvider in org.forgerock.openig.util
Methods in org.forgerock.openig.util with parameters of type SecretsProvider Modifier and Type Method Description static <S extends Secret>
Function<JsonValue,SecretReference<S>,JsonValueException>JsonValues. secretReferenceOf(Function<JsonValue,Purpose<S>,JsonValueException> purposeTransformer, SecretsProvider secretsProvider)
Returns a function that returns aSecretReference
for thePurpose
represented by the givenString
value label and known to the suppliedSecretsProvider
. -
Uses of SecretsProvider in org.forgerock.secrets
Methods in org.forgerock.secrets that return SecretsProvider Modifier and Type Method Description <T extends Secret>
SecretsProviderSecretsProvider. setActiveStore(SecretStore<? super T> store, Purpose<? extends T>... purposes)
Sets the active store to use for the given purpose.SecretsProvider
SecretsProvider. setDefaultStores(SecretStore<?> activeStore, SecretStore<?>... defaultStores)
Sets the default store(s) to use if there is no specific store configured for a particular purpose.Methods in org.forgerock.secrets with parameters of type SecretsProvider Modifier and Type Method Description static <T extends Secret>
SecretReference<T>SecretReference. active(SecretsProvider secretsProvider, Purpose<T> purpose, Clock clock)
Creates a reference to the active secret for the given purpose using the given secrets provider.static <T extends Secret>
SecretReference<T>SecretReference. named(SecretsProvider secretsProvider, Purpose<T> purpose, String name, Clock clock)
Creates a reference to a named secret using the given secrets provider.Constructors in org.forgerock.secrets with parameters of type SecretsProvider Constructor Description SecretReference(SecretsProvider provider, Purpose<T> purpose)
Deprecated.SecretReference(SecretsProvider provider, Purpose<T> purpose, Clock clock)
Deprecated.SecretsLoadStoreParameter(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose, Clock clock)
Initialises the keystore with the given secrets API objects.
-