Package org.forgerock.secrets.propertyresolver

Class JwtWrappedPropertyFormat

java.lang.Object

org.forgerock.secrets.propertyresolver.JwtWrappedPropertyFormat

All Implemented Interfaces:

SecretPropertyFormat, SecretDecoder

public class JwtWrappedPropertyFormat
extends Object
implements SecretPropertyFormat

A SecretPropertyFormat that wraps another format, extracting the secret value from a JWT before delegating to the wrapped format.

Field Summary

Fields inherited from interface org.forgerock.secrets.SecretDecoder

RAW

Fields inherited from interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat

PLAIN

Constructor Summary

Constructors

Constructor	Description
JwtWrappedPropertyFormat(SecretPropertyFormat format, ValidSecretsReference<? extends CryptoKey,NeverThrowsException> validSecretsReference)	Constructs a new JwtWrappedPropertyFormat.

Method Summary

Modifier and Type	Method	Description
SecretBuilder	decode(String propertyValue)	Decodes the input property value, setting relevant properties on a SecretBuilder object.
Promise<SecretBuilder,NoSuchSecretException>	decodeToPromise(String propertyValue)	Decodes the input property value, setting relevant properties on a SecretBuilder object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.forgerock.secrets.propertyresolver.SecretPropertyFormat

decodeToPromise

Constructor Details

JwtWrappedPropertyFormat

public JwtWrappedPropertyFormat(SecretPropertyFormat format,
 ValidSecretsReference<? extends CryptoKey,NeverThrowsException> validSecretsReference)

Constructs a new JwtWrappedPropertyFormat.

Parameters:

format - the format to delegate to after unwrapping the JWT

validSecretsReference - the secret to use for decrypting the JWT

Method Details

decode

public SecretBuilder decode(String propertyValue)
                     throws NoSuchSecretException

Description copied from interface: SecretPropertyFormat

Decodes the input property value, setting relevant properties on a SecretBuilder object.

Specified by:

decode in interface SecretPropertyFormat

Parameters:

propertyValue - the value of the secret property.

Returns:

the decoded secret information.

Throws:

NoSuchSecretException - If the property value does not contain a value that can be decoded.

decodeToPromise

public Promise<SecretBuilder,NoSuchSecretException> decodeToPromise(String propertyValue)

Description copied from interface: SecretPropertyFormat

Decodes the input property value, setting relevant properties on a SecretBuilder object.

Specified by:

decodeToPromise in interface SecretPropertyFormat

Parameters:

propertyValue - the value of the secret property.

Returns:

a promise of the decoded secret information.