Uses of Interface org.forgerock.secrets.SecretStore (IG Aggregated Javadoc 2023.11.0 Documentation)

Packages that use SecretStore
Package	Description
org.forgerock.openig.secrets	Provides the Common Secrets API for accessing secrets of various kinds.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.
org.forgerock.secrets.keystore	Implementations of `SecretStore` for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.
org.forgerock.secrets.oauth2	A Secrets API backend that can obtain OAuth 2 access tokens from a token endpoint, along with a collection of grant type handlers.
org.forgerock.secrets.propertyresolver	Provides a `SecretStore` implementation that loads secrets from a Common Configuration `PropertyResolver` and then decodes it with a `SecretPropertyFormat`.

Uses of SecretStore in org.forgerock.openig.secrets

Classes in org.forgerock.openig.secrets that implement SecretStore
Modifier and Type	Class	Description
`class`	`Base64EncodedSecretStore`	A `Base64EncodedSecretStore` stores secret values (such as password or simple shared secrets) in a base64-encoded form in memory.

Methods in org.forgerock.openig.secrets that return SecretStore
Modifier and Type	Method	Description
`static SecretStore<Secret>`	SystemAndEnvSecretStoreHeaplet.`newBase64SysEnvSecretStore()`	Returns a new instance of a SecretStore that reads base64-encoded secrets (passwords or symmetric keys) from system properties and environment variables.

Methods in org.forgerock.openig.secrets with parameters of type SecretStore
Modifier and Type	Method	Description
`SecretsProvider`	DefaultSecretsService.`setDefaultStores(SecretStore<?> activeStore, SecretStore<?>... defaultStores)`	Deprecated.
`SecretsProvider`	SecretsService.`setDefaultStores(SecretStore<?> activeStore, SecretStore<?>... defaultStores)`	Sets the default store(s) to use if there is no specific store configured for a particular purpose.

Method parameters in org.forgerock.openig.secrets with type arguments of type SecretStore
Modifier and Type	Method	Description
`DefaultSecretsService.Builder`	DefaultSecretsService.Builder.`withDefaultStore(Supplier<SecretStore<?>> supplier)`	Configure this service with a default SecretStore supplier.

Uses of SecretStore in org.forgerock.secrets

Classes in org.forgerock.secrets that implement SecretStore
Modifier and Type	Class	Description
`class`	`ThreadPoolSecretStore<T extends Secret>`	A secret store that wraps another secret store and performs all query operations in a background thread using a thread pool.

Methods in org.forgerock.secrets with parameters of type SecretStore
Modifier and Type	Method	Description
`protected <T extends Secret> void`	SecretsProvider.`setActiveStore(SecretStore<? super T> store, Purpose<? extends T> purpose)`	Sets the active store to use for the given purpose.
`<T extends Secret> SecretsProvider`	SecretsProvider.`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.
`static <S extends Secret> ThreadPoolSecretStore<S>`	ThreadPoolSecretStore.`wrap(SecretStore<S> store)`	Wraps the given store in an asynchronous thread-pool executor using the system `ForkJoinPool.commonPool()`.
`static <S extends Secret> ThreadPoolSecretStore<S>`	ThreadPoolSecretStore.`wrap(SecretStore<S> store, ExecutorService executor)`	Wraps the given store in an asynchronous thread-pool executor using the given thread pool.

Uses of SecretStore in org.forgerock.secrets.jwkset

Classes in org.forgerock.secrets.jwkset that implement SecretStore
Modifier and Type	Class	Description
`class`	`JwkSetSecretStore`	A secret store that loads cryptographic keys from a local or remote `JWKSet`.

Uses of SecretStore in org.forgerock.secrets.keystore

Classes in org.forgerock.secrets.keystore that implement SecretStore
Modifier and Type	Class	Description
`class`	`KeyStoreSecretStore`	A secret store for cryptographic keys based on a standard Java `KeyStore`.

Uses of SecretStore in org.forgerock.secrets.oauth2

Classes in org.forgerock.secrets.oauth2 that implement SecretStore
Modifier and Type	Class	Description
`class`	`AccessTokenSecretStore`	A secret store that can obtain access tokens from an OAuth 2 provider.

Uses of SecretStore in org.forgerock.secrets.propertyresolver

Classes in org.forgerock.secrets.propertyresolver that implement SecretStore
Modifier and Type	Class	Description
`class`	`FileSystemSecretStore`	A `PropertyResolverSecretStore` that uses a `FlatFileResolver` to retrieve properties from.
`class`	`PropertyResolverSecretStore`	A `SecretStore` implementation that resolves secrets as base64-encoded strings from an underlying `PropertyResolver`.