org.forgerock.json.jose.tokenhandler

Class JwtTokenHandler

java.lang.Object

org.forgerock.json.jose.tokenhandler.JwtTokenHandler

All Implemented Interfaces:

TokenHandler

public final class JwtTokenHandler
extends Object
implements TokenHandler

Token handler for creating tokens using a JWT as the store.

Constructor Summary

Constructors

Constructor and Description
JwtTokenHandler(JweAlgorithm jweAlgorithm, EncryptionMethod jweMethod, KeyPair jweKeyPair, JwsAlgorithm jwsAlgorithm, SigningHandler jwsHandler) Constructs a new JWT token handler that never expires.
JwtTokenHandler(JweAlgorithm jweAlgorithm, EncryptionMethod jweMethod, KeyPair jweKeyPair, JwsAlgorithm jwsAlgorithm, SigningHandler jwsHandler, Optional<Long> tokenLifeTimeInSeconds, int tokenStatePaddingLength) Constructs a new JWT token handler.

Method Summary

Modifier and Type	Method and Description
String	generate(JsonValue state) Generates a new token using the state.
void	validate(String snapshotToken) Validates the passed token.
JsonValue	validateAndExtractState(String snapshotToken) Validates and parses the token, extracting any encapsulated state.

Methods inherited from class java.lang.Object

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

Constructor Detail

JwtTokenHandler

public JwtTokenHandler(JweAlgorithm jweAlgorithm,
                       EncryptionMethod jweMethod,
                       KeyPair jweKeyPair,
                       JwsAlgorithm jwsAlgorithm,
                       SigningHandler jwsHandler)

Constructs a new JWT token handler that never expires.

Parameters:

jweAlgorithm - the JWE algorithm use to construct the key pair

jweMethod - the encryption method to use

jweKeyPair - key pair for the purpose of encryption

jwsAlgorithm - the JWS algorithm to use

jwsHandler - the signing handler

JwtTokenHandler

public JwtTokenHandler(JweAlgorithm jweAlgorithm,
                       EncryptionMethod jweMethod,
                       KeyPair jweKeyPair,
                       JwsAlgorithm jwsAlgorithm,
                       SigningHandler jwsHandler,
                       Optional<Long> tokenLifeTimeInSeconds,
                       int tokenStatePaddingLength)

Constructs a new JWT token handler.

Parameters:

jweAlgorithm - the JWE algorithm use to construct the key pair

jweMethod - the encryption method to use

jweKeyPair - key pair for the purpose of encryption

jwsAlgorithm - the JWS algorithm to use

jwsHandler - the signing handler

tokenLifeTimeInSeconds - token life time in seconds

tokenStatePaddingLength - desired length of state claim after padding

Method Detail

generate

public String generate(JsonValue state)
                throws TokenHandlerException

Description copied from interface: TokenHandler

Generates a new token using the state.

Specified by:

generate in interface TokenHandler

Parameters:

state - the state

Returns:

token

Throws:

TokenHandlerException - on failure to generate token

validate

public void validate(String snapshotToken)
              throws TokenHandlerException

Description copied from interface: TokenHandler

Validates the passed token.

Specified by:

validate in interface TokenHandler

Parameters:

snapshotToken - the token to be validated

Throws:

InvalidTokenException - on invalid token

ExpiredTokenException - on expired token

TokenHandlerException - on other failure to validate token

validateAndExtractState

public JsonValue validateAndExtractState(String snapshotToken)
                                  throws TokenHandlerException

Description copied from interface: TokenHandler

Validates and parses the token, extracting any encapsulated state.

Specified by:

validateAndExtractState in interface TokenHandler

Parameters:

snapshotToken - the token to be validated and parsed

Returns:

the state

Throws:

InvalidTokenException - on invalid token

ExpiredTokenException - on expired token

TokenHandlerException - on other failure to validate or extract token