Uses of Class
org.forgerock.secrets.GenericSecret

Packages that use GenericSecret

Package	Description
org.forgerock.http.filter	Core Filter implementations.
org.forgerock.http.handler	Core Handler 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.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.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.
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)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newHttpBasicAuthenticationFilter(CredentialPair) instead
static Filter	Filters.newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password, Charset charset)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newHttpBasicAuthenticationFilter(CredentialPair, Charset) instead
static Filter	Filters.newHttpBasicAuthenticationFilter(CredentialPair<GenericSecret> credentialPair)	Creates an authentication Filter that puts a Basic Authorization header in the request.
static Filter	Filters.newHttpBasicAuthenticationFilter(CredentialPair<GenericSecret> credentialPair, Charset charset)	Creates an authentication Filter that puts a Basic Authorization header in the request.
static Filter	Filters.newUrlEncodedHttpBasicAuthFilter(String username, SecretReference<GenericSecret> password)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newUrlEncodedHttpBasicAuthFilter(CredentialPair) instead
static Filter	Filters.newUrlEncodedHttpBasicAuthFilter(CredentialPair<GenericSecret> credentialPair)	Creates an authentication Filter that put a Basic Authorization header in the request.

Uses of GenericSecret in org.forgerock.http.handler

Methods in org.forgerock.http.handler that return types with arguments of type GenericSecret

Modifier and Type	Method	Description
Supplier<PrincipalAndSecret<GenericSecret>>	HttpClientHandler.ProxyInfo.getCredentials()	Returns the Supplier containing the username and password to use when authenticating to the proxy.

Method parameters in org.forgerock.http.handler with type arguments of type GenericSecret

Modifier and Type	Method	Description
static Promise<HttpClientHandler.ProxyInfo,NeverThrowsException>	HttpClientHandler.ProxyInfo.asyncProxyInfo(URI proxyUri, CredentialPair<GenericSecret> credentialPair, Clock clock, Duration refreshDuration)	Creates an instance of ProxyInfo for a proxy that requires authentication, this will update its secrets in the background and will not block threads.
static HttpClientHandler.ProxyInfo	HttpClientHandler.ProxyInfo.blockingProxyInfo(URI proxyUri, CredentialPair<GenericSecret> credentialPair)	Creates an instance of ProxyInfo for a proxy that requires authentication, this will block and wait for a credentialPair to return a value.
static HttpClientHandler.ProxyInfo	HttpClientHandler.ProxyInfo.proxyInfo(URI proxyUri, Supplier<PrincipalAndSecret<GenericSecret>> supplier)	Creates an instance of ProxyInfo for a proxy that does not require authentication.

Uses of GenericSecret in org.forgerock.http.oauth2

Constructor parameters in org.forgerock.http.oauth2 with type arguments of type GenericSecret

Modifier	Constructor	Description
	ClientSecretBasicAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)	Deprecated. Creates and instance of ClientSecretBasicAuthenticationFilter.
	ClientSecretPostAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)	Deprecated, for removal: This API element is subject to removal in a future version. Use ClientSecretPostAuthenticationFilter(CredentialPair) instead.
	ClientSecretPostAuthenticationFilter(CredentialPair<GenericSecret> credentials)	Creates a filter that will add the client credentials to the request body.

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.secrets

Fields in org.forgerock.secrets with type parameters of type GenericSecret

Modifier and Type	Field	Description
static final 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

Modifier	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

Modifier	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.oauth2

Methods in org.forgerock.secrets.oauth2 with type parameters of type GenericSecret

Modifier and Type	Method	Description
<S extends GenericSecret> Promise<S,NoSuchSecretException>	AccessTokenSecretStore.getActive(Purpose<S> purpose)
<S extends GenericSecret> Promise<S,NoSuchSecretException>	AccessTokenSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends GenericSecret> Promise<Stream<S>,NeverThrowsException>	AccessTokenSecretStore.getValid(Purpose<S> purpose)

Methods in org.forgerock.secrets.oauth2 that return types with arguments of type GenericSecret

Modifier and Type	Method	Description
Class<GenericSecret>	AccessTokenSecretStore.getStoredType()

Method parameters in org.forgerock.secrets.oauth2 with type arguments of type GenericSecret

Modifier and Type	Method	Description
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.forPurpose(Purpose<GenericSecret> purpose)	Configures the purpose for which this access token store is to be used.
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretBasicAuth(String clientId, SecretReference<GenericSecret> clientSecretRef)	Deprecated, for removal: This API element is subject to removal in a future version. use AccessTokenSecretStore.Builder.withClientSecretBasicAuth(CredentialPair) instead
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretBasicAuth(CredentialPair<GenericSecret> credentials)	Configures the token store to supply client credentials via HTTP Basic Authentication.
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretPostAuth(String clientId, SecretReference<GenericSecret> clientSecretRef)	Deprecated, for removal: This API element is subject to removal in a future version. use AccessTokenSecretStore.Builder.withClientSecretPostAuth(CredentialPair) instead
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretPostAuth(CredentialPair<GenericSecret> credentials)	Configures the token store to supply client credentials via client_secret_post method.

Constructor parameters in org.forgerock.secrets.oauth2 with type arguments of type GenericSecret

Modifier	Constructor	Description
	JwtBearerGrantTypeHandler(SecretReference<GenericSecret> jwtReference)	Constructs the handler with the given source of JWTs.
	JwtBearerGrantTypeHandler(SecretReference<GenericSecret> jwtReference, String clientId, Collection<String> scope)	Constructs the handler with the given source of JWTs, for the given client and scope.
	JwtBearerGrantTypeHandler(SecretReference<GenericSecret> jwtReference, Collection<String> scope)	Constructs the handler with the given source of JWTs, for the given scope.
	ResourceOwnerPasswordGrantTypeHandler(String clientId, String username, SecretReference<GenericSecret> password)	Deprecated, for removal: This API element is subject to removal in a future version. Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair) instead.
	ResourceOwnerPasswordGrantTypeHandler(String clientId, String username, SecretReference<GenericSecret> password, Collection<String> scope)	Deprecated, for removal: This API element is subject to removal in a future version. Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair, Collection) instead.
	ResourceOwnerPasswordGrantTypeHandler(String clientId, CredentialPair<GenericSecret> ownerCredentials)	Initialises the grant type handler with the given credentials and the default scope for this client.
	ResourceOwnerPasswordGrantTypeHandler(String clientId, CredentialPair<GenericSecret> ownerCredentials, Collection<String> scope)	Initialises the grant type handler with the given resource owner credentials.

Uses of GenericSecret in org.forgerock.secrets.propertyresolver

Constructor parameters in org.forgerock.secrets.propertyresolver with type arguments of type GenericSecret

Modifier	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

Modifier	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.