org.forgerock.selfservice.core.snapshot

Interface SnapshotTokenHandler

All Known Implementing Classes:

JwtTokenHandler

public interface SnapshotTokenHandler

Responsible for the validation, generation and parsing of snapshot tokens used for keying a snapshot of some state.

Since:

0.1.0

Method Summary

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

Method Detail

generate

String generate(JsonValue state)
         throws ResourceException

Generates a new snapshot token using the state.

Parameters:

state - the state

Returns:

snapshot token

Throws:

ResourceException - thrown should some issue occur creating the snapshot token

validate

void validate(String snapshotToken)
       throws ResourceException

Validates the passed snapshot token.

Parameters:

snapshotToken - the snapshot token to be validated

Throws:

ResourceException - thrown should some issue be found with the token

validateAndExtractState

JsonValue validateAndExtractState(String snapshotToken)
                           throws ResourceException

Validates and parses the token, extracting any encapsulated state.

Parameters:

snapshotToken - the snapshot token to be validated and parsed

Returns:

the state

Throws:

ResourceException - thrown should some issue be found with the token