Package org.forgerock.openig.tools.jwt.validation

Class JwtValidator

java.lang.Object

org.forgerock.openig.tools.jwt.validation.JwtValidator

public final class JwtValidator
extends Object

The JwtValidator is responsible for the JWT validation. Constraints could be applied using the Builder to several claims in order to verify the claim's value (expiration, presence, etc.). The JwtValidator is stateless and immutable therefore, it can be reused to apply the same set of constraints to another Jwt.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JwtValidator.Builder	Builder for the JwtValidator.

Method Summary

Modifier and Type	Method	Description
static JwtValidator.Builder	builder(Clock clock)	Builder for the JwtValidator with a clock to use for temporal constraints.
Promise<JwtValidatorResult,NeverThrowsException>	report(Jwt jwt)	Returns the result of the JWT validation and a list of any violations.
Promise<JwtValidatorResult,NeverThrowsException>	report(Jwt jwt, Map<String,?> attributes)	Returns the result of the JWT validation and a list of any violations.

Methods inherited from class java.lang.Object

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

Method Details

report

public Promise<JwtValidatorResult,NeverThrowsException> report(Jwt jwt)

Returns the result of the JWT validation and a list of any violations.

Parameters:

jwt - The given JWT to analyze.

Returns:

Promise of a JwtValidatorResult containing the list of any Violations.

report

public Promise<JwtValidatorResult,NeverThrowsException> report(Jwt jwt,
 Map<String,?> attributes)

Returns the result of the JWT validation and a list of any violations.

Parameters:

jwt - The given JWT to analyze.

attributes - Map of additional context attributes.

Returns:

Promise of a JwtValidatorResult containing the list of any Violations.

builder

public static JwtValidator.Builder builder(Clock clock)

Builder for the JwtValidator with a clock to use for temporal constraints.

Parameters:

clock - The clock to use for temporal constraints

Returns:

a builder.