Uses of Class org.forgerock.secrets.GenericSecret (OpenAM Server Only 7.2.2 Documentation)

Packages that use GenericSecret
Package	Description
org.forgerock.http.filter	Core `Filter` implementations.
org.forgerock.http.oauth2	This package provides APIs for OAuth 2.0 services implementations.
org.forgerock.oauth.clients.oauth2	OAuth 2.0 ForgeRock Client Implementation.
org.forgerock.openam.scripting.api.secrets	A package containing a set of script-friendly classes and functionality that are intended to simplify use of the Secrets API from within a scripting context.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.gcpkms	A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.
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.propertyresolver	Provides a `SecretStore` implementation that loads secrets from a Common Configuration `PropertyResolver` and then decodes it with a `SecretPropertyFormat`.
org.forgerock.secrets.vault	Secrets backend that reads secrets from a remote Hashicorp Vault server.

Uses of GenericSecret in org.forgerock.http.filter

Method parameters in org.forgerock.http.filter with type arguments of type GenericSecret
Modifier and Type	Method	Description
`static Filter`	Filters.`newBearerTokenAuthFilter(SecretReference<GenericSecret> tokenReference)`	Creates an authentication `Filter` that puts a Bearer Authorization header in the request.
`static Filter`	Filters.`newBearerTokenAuthFilterWithoutRetry(SecretReference<GenericSecret> tokenReference)`	Creates an authentication `Filter` that puts a Bearer Authorization header in the request.
`static Filter`	Filters.`newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password)`	Creates an authentication `Filter` that put a Basic Authorization header in the request.
`static Filter`	Filters.`newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password, Charset charset)`	Creates an authentication `Filter` that put a Basic Authorization header in the request.
`static Filter`	Filters.`newUrlEncodedHttpBasicAuthFilter(String username, SecretReference<GenericSecret> password)`	Creates an authentication `Filter` that put a Basic Authorization header in the request.

Uses of GenericSecret in org.forgerock.http.oauth2

Constructor parameters in org.forgerock.http.oauth2 with type arguments of type GenericSecret
Constructor	Description
`ClientSecretBasicAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)`	Deprecated. Creates and instance of ClientSecretBasicAuthenticationFilter.
`ClientSecretPostAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)`	Creates an instance of this class.

Uses of GenericSecret in org.forgerock.oauth.clients.oauth2

Methods in org.forgerock.oauth.clients.oauth2 that return types with arguments of type GenericSecret
Modifier and Type	Method	Description
`SecretReference<GenericSecret>`	OAuth2ClientConfiguration.`getClientSecretReference()`	Returns a reference to the client secret.

Method parameters in org.forgerock.oauth.clients.oauth2 with type arguments of type GenericSecret
Modifier and Type	Method	Description
`T`	OAuth2ClientConfiguration.Builder.`withClientSecret(SecretReference<GenericSecret> clientSecret)`	Set the clientSecret.

Uses of GenericSecret in org.forgerock.openam.scripting.api.secrets

Constructors in org.forgerock.openam.scripting.api.secrets with parameters of type GenericSecret
Constructor	Description
`Secret(GenericSecret genericSecret)`	Default constructor exposing required dependencies.

Uses of GenericSecret in org.forgerock.secrets

Fields in org.forgerock.secrets with type parameters of type GenericSecret
Modifier and Type	Field	Description
`static Purpose<GenericSecret>`	Purpose.`PASSWORD`	Indicates a secret intended to be used as a password for authentication to some service.

Methods in org.forgerock.secrets that return GenericSecret
Modifier and Type	Method	Description
`static GenericSecret`	GenericSecret.`password(char[] password)`	A helper utility for constructing a Generic Secret from a password that never expires.
`static GenericSecret`	GenericSecret.`password(String id, char[] password)`	A helper utility for constructing a Generic Secret from a password that never expires.
`static GenericSecret`	GenericSecret.`password(String id, char[] password, Clock clock)`	A helper utility for constructing a Generic Secret from a password with a default expiry time.

Uses of GenericSecret in org.forgerock.secrets.gcpkms

Constructor parameters in org.forgerock.secrets.gcpkms with type arguments of type GenericSecret
Constructor	Description
`SecretsApiBearerTokenCredentials(Function<URI,SecretReference<GenericSecret>> bearerTokenLookup)`	Initialises the credentials with the given mapping from URIs to bearer token references.
`SecretsApiBearerTokenCredentials(SecretReference<GenericSecret> bearerToken)`	Initialises the credentials with a single bearer token to use for all URIs.

Uses of GenericSecret in org.forgerock.secrets.keystore

Constructor parameters in org.forgerock.secrets.keystore with type arguments of type GenericSecret
Constructor	Description
`KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword)`	Initialises the keystore using the same password for the keystore and all keys and default configuration options.
`KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, SecretReference<GenericSecret> keyEntryPassword, Options options, KeyStoreSecretStore.StableIdProvider stableIdProvider)`	Initialises the key store.
`KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, Options options)`	Initialises the keystore using the same password for the keystore and all keys.

Uses of GenericSecret in org.forgerock.secrets.propertyresolver

Constructor parameters in org.forgerock.secrets.propertyresolver with type arguments of type GenericSecret
Constructor	Description
`PemPropertyFormat(SecretsProvider secretsProvider, Purpose<GenericSecret> decryptionPasswordPurpose)`	Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.
`PemPropertyFormat(SecretsProvider secretsProvider, Purpose<GenericSecret> decryptionPasswordPurpose, Supplier<SecretBuilder> secretBuilderSupplier)`	Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.

Uses of GenericSecret in org.forgerock.secrets.vault

Methods in org.forgerock.secrets.vault that return types with arguments of type GenericSecret
Modifier and Type	Method	Description
`static SecretReference<GenericSecret>`	AppRoleTokenStore.`createTokenReference(String roleId, SecretReference<GenericSecret> secretReference, VaultConfig config)`	Returns a `SecretReference` that will obtain a Vault authentication token using the AppRole login method.
`static SecretReference<GenericSecret>`	JwtAuthenticationTokenStore.`createTokenReference(String role, SecretReference<GenericSecret> secretReference, VaultConfig config)`	Returns a `SecretReference` that will obtain a Vault login token by logging in with the given JWT.

Method parameters in org.forgerock.secrets.vault with type arguments of type GenericSecret
Modifier and Type	Method	Description
`static SecretReference<GenericSecret>`	AppRoleTokenStore.`createTokenReference(String roleId, SecretReference<GenericSecret> secretReference, VaultConfig config)`	Returns a `SecretReference` that will obtain a Vault authentication token using the AppRole login method.
`static SecretReference<GenericSecret>`	JwtAuthenticationTokenStore.`createTokenReference(String role, SecretReference<GenericSecret> secretReference, VaultConfig config)`	Returns a `SecretReference` that will obtain a Vault login token by logging in with the given JWT.

Constructor parameters in org.forgerock.secrets.vault with type arguments of type GenericSecret
Constructor	Description
`VaultDatabaseCredentialsSecretStore(SecretReference<GenericSecret> tokenReference, VaultConfig config)`	Constructs a secret store to retrieve database credentials from Vault with the given options.
`VaultKeyValueSecretStore(SecretReference<GenericSecret> tokenReference, Map<JsonPointer,? extends VaultKeyValueSecretStore.SecretFieldDecoder> fieldDecoders, VaultConfig config)`	Constructs the key-value store using the given authentication token and options.
`VaultPkiSecretStore(SecretReference<GenericSecret> tokenReference, VaultConfig config, JsonValue certificateRequestPayload)`	Initializes the PKI secret store using the given authentication token and configuration options.
`VaultTransitSecretStore(SecretReference<GenericSecret> tokenReference, VaultConfig config)`	Initializes the transit secret store with the given Vault login token and options.