Uses of Class org.forgerock.secrets.ValidSecretsReference (OpenAM Server Only 7.4.2 Documentation)

Packages that use ValidSecretsReference
Package	Description
org.forgerock.json.jose.jwe	Classes and interfaces for JWT encryption and JWEs.
org.forgerock.json.jose.jws	Classes and interfaces for JWT signing and JWS'.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.

Uses of ValidSecretsReference in org.forgerock.json.jose.jwe

Methods in org.forgerock.json.jose.jwe with parameters of type ValidSecretsReference
Modifier and Type	Method	Description
`Promise<? extends EncryptedJwt,JweDecryptionCheckedException>`	EncryptedJwt.`decrypt(ValidSecretsReference<? extends CryptoKey,NeverThrowsException> secretsReference)`	Attempts to decrypt the JWT using any available keys from the given `ValidSecretsReference`.
`Promise<SignedThenEncryptedJwt,JweDecryptionCheckedException>`	SignedThenEncryptedJwt.`decrypt(ValidSecretsReference<? extends CryptoKey,NeverThrowsException> validSecretsReference)`
`Promise<SignedThenEncryptedJwt,JweDecryptionCheckedException>`	SignedThenEncryptedJwt.`decryptAndVerify(ValidSecretsReference<? extends CryptoKey,NeverThrowsException> decryptionSecretsReference, ValidSecretsReference<VerificationKey,NeverThrowsException> verificationSecretsReference)`	Decrypts the outer JWT and then verifies the signature on the inner JWT using supplied valid secrets.
`Promise<byte[],JweDecryptionCheckedException>`	EncryptedJwt.`decryptRawPayload(ValidSecretsReference<? extends CryptoKey,NeverThrowsException> secretsReference)`	Attempts to decrypt the raw payload of the JWT using any keys from the given the `Secret`s contained in the given `ValidSecretsReference`.

Uses of ValidSecretsReference in org.forgerock.json.jose.jws

Methods in org.forgerock.json.jose.jws with parameters of type ValidSecretsReference
Modifier and Type	Method	Description
`Promise<? extends EncryptedJwt,JweDecryptionCheckedException>`	EncryptedThenSignedJwt.`decrypt(ValidSecretsReference<? extends CryptoKey,NeverThrowsException> secretsReference)`	Decrypts the inner encrypted JWE so that the payload can be accessed.
`Promise<SigningHandler,NeverThrowsException>`	SigningManager.`newVerificationHandler(ValidSecretsReference<VerificationKey,NeverThrowsException> validSecrets)`	Constructs a new SigningHandler configured for verifying with the provided valid secrets reference.

Uses of ValidSecretsReference in org.forgerock.secrets

Methods in org.forgerock.secrets that return ValidSecretsReference
Modifier and Type	Method	Description
`<S extends Secret> ValidSecretsReference<S,NeverThrowsException>`	SecretsProvider.`createValidOrNamedReference(Purpose<S> purpose, String name)`	Creates the valid secrets reference from the given purpose.
`<S extends Secret> ValidSecretsReference<S,NeverThrowsException>`	SecretsProvider.`createValidReference(Purpose<S> purpose)`	Creates the valid secrets reference from the given purpose.
`ValidSecretsReference<S,E>`	ValidSecretsReference.`refresh()`	Force the refresh of the secret reference.
`static <T extends Secret> ValidSecretsReference<T,NeverThrowsException>`	ValidSecretsReference.`valid(SecretsProvider secretsProvider, Purpose<T> purpose, Clock clock)`	Creates a reference to the valid secrets for the given purpose using the given secrets provider.
`static <T extends Secret> ValidSecretsReference<T,NeverThrowsException>`	ValidSecretsReference.`validOrNamed(SecretsProvider secretsProvider, Purpose<T> purpose, String name, Clock clock)`	This creates a reference to either the named secret or all valid secrets for the purpose.