Package org.forgerock.json.jose.tokenhandler

Class SecretsJwtTokenHandler.Builder

java.lang.Object

org.forgerock.json.jose.tokenhandler.SecretsJwtTokenHandler.Builder

Enclosing class:

SecretsJwtTokenHandler

public static final class SecretsJwtTokenHandler.Builder
extends Object

Builder pattern object for configuring a SecretsJwtTokenHandler.

Method Summary

Modifier and Type	Method	Description
SecretsJwtTokenHandler	build()	Builds the SecretsJwtTokenHandler based on the configuration specified.
SecretsJwtTokenHandler.Builder	clock(Clock clock)	Specifies the clock to use for checking if tokens have expired.
SecretsJwtTokenHandler.Builder	decryptionPurpose(Purpose<? extends CryptoKey> decryptionKeyPurpose)	Specifies the Purpose used to retrieve decryption keys from the secrets provider.
SecretsJwtTokenHandler.Builder	encryptionMethod(EncryptionMethod encryptionMethod)	Specifies the JWE content encryption method to use when encrypting tokens produced by this token handler.
SecretsJwtTokenHandler.Builder	encryptionPurpose(Purpose<? extends CryptoKey> encryptionKeyPurpose)	Specifies the Purpose used to retrieve encryption keys from the secrets provider.
SecretsJwtTokenHandler.Builder	jweAlgorithm(JweAlgorithm algorithm)	Specifies the JWE key management algorithm to use when encrypting tokens produced by this token handler.
SecretsJwtTokenHandler.Builder	jwsAlgorithm(JwsAlgorithm algorithm)	Specifies the JWS signature algorithm to use to sign tokens produced by this token handler.
SecretsJwtTokenHandler.Builder	secretsProvider(SecretsProvider secretsProvider)	Configures the SecretsProvider from which to retrieve signing and encryption keys.
SecretsJwtTokenHandler.Builder	signingPurpose(Purpose<SigningKey> signingKeyPurpose)	Specifies the Purpose used to retrieve signing keys from the secrets provider.
SecretsJwtTokenHandler.Builder	tokenLifetimeInSeconds(long tokenLifetimeSeconds)	Specifies the maximum lifetime (in seconds) of the tokens produced by this token handler.
SecretsJwtTokenHandler.Builder	tokenLifetimeInSeconds(Optional<Long> tokenLifeTimeInSeconds)	Specifies the maximum lifetime (in seconds) of the tokens produced by this token handler.
SecretsJwtTokenHandler.Builder	verificationPurpose(Purpose<VerificationKey> verificationKeyPurpose)	Specifies the Purpose used to retrieve verification keys from the secrets provider.

Methods inherited from class java.lang.Object

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

Method Detail

jweAlgorithm

public SecretsJwtTokenHandler.Builder jweAlgorithm(JweAlgorithm algorithm)

Specifies the JWE key management algorithm to use when encrypting tokens produced by this token handler. Defaults to JweAlgorithm.RSA_OAEP_256.

Parameters:

algorithm - the algorithm to use.

Returns:

this builder.

encryptionMethod

public SecretsJwtTokenHandler.Builder encryptionMethod(EncryptionMethod encryptionMethod)

Specifies the JWE content encryption method to use when encrypting tokens produced by this token handler. Defaults to EncryptionMethod.A128CBC_HS256.

Parameters:

encryptionMethod - the encryption method to use.

Returns:

this builder.

jwsAlgorithm

public SecretsJwtTokenHandler.Builder jwsAlgorithm(JwsAlgorithm algorithm)

Specifies the JWS signature algorithm to use to sign tokens produced by this token handler. Defaults to JwsAlgorithm.HS256.

Parameters:

algorithm - the JWS signature algorithm.

Returns:

this builder.

tokenLifetimeInSeconds

public SecretsJwtTokenHandler.Builder tokenLifetimeInSeconds(long tokenLifetimeSeconds)

Specifies the maximum lifetime (in seconds) of the tokens produced by this token handler.

Parameters:

tokenLifetimeSeconds - the lifetime in seconds. Must be greater than zero.

Returns:

this builder.

tokenLifetimeInSeconds

public SecretsJwtTokenHandler.Builder tokenLifetimeInSeconds(Optional<Long> tokenLifeTimeInSeconds)

Specifies the maximum lifetime (in seconds) of the tokens produced by this token handler.

Parameters:

tokenLifeTimeInSeconds - the lifetime in seconds. If present, must be greater than zero.

Returns:

this builder.

secretsProvider

public SecretsJwtTokenHandler.Builder secretsProvider(SecretsProvider secretsProvider)

Configures the SecretsProvider from which to retrieve signing and encryption keys.

Parameters:

secretsProvider - the secrets provider.

Returns:

this builder.

signingPurpose

public SecretsJwtTokenHandler.Builder signingPurpose(Purpose<SigningKey> signingKeyPurpose)

Specifies the Purpose used to retrieve signing keys from the secrets provider.

Parameters:

signingKeyPurpose - the signing purpose.

Returns:

this builder.

verificationPurpose

public SecretsJwtTokenHandler.Builder verificationPurpose(Purpose<VerificationKey> verificationKeyPurpose)

Specifies the Purpose used to retrieve verification keys from the secrets provider.

Parameters:

verificationKeyPurpose - the verification purpose.

Returns:

this builder.

encryptionPurpose

public SecretsJwtTokenHandler.Builder encryptionPurpose(Purpose<? extends CryptoKey> encryptionKeyPurpose)

Specifies the Purpose used to retrieve encryption keys from the secrets provider. This will typically be a DataEncryptionKey, KeyEncryptionKey, or KeyAgreementKey, depending on JWE algorithm being used.

Parameters:

encryptionKeyPurpose - the encryption purpose.

Returns:

this builder.

decryptionPurpose

public SecretsJwtTokenHandler.Builder decryptionPurpose(Purpose<? extends CryptoKey> decryptionKeyPurpose)

Specifies the Purpose used to retrieve decryption keys from the secrets provider. This will typically be a DataDecryptionKey, KeyDecryptionKey, or KeyAgreementKey, depending on JWE algorithm being used.

Parameters:

decryptionKeyPurpose - the decryption purpose.

Returns:

this builder.

clock

public SecretsJwtTokenHandler.Builder clock(Clock clock)

Specifies the clock to use for checking if tokens have expired.

Parameters:

clock - the clock to use for checking token expiry.

Returns:

this builder.

build

public SecretsJwtTokenHandler build()

Builds the SecretsJwtTokenHandler based on the configuration specified.

Returns:

the configured token handler.

Throws:

IllegalArgumentException - if any of the specified configuration values are invalid.

NullPointerException - if a required value has not been specified and has no default.