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

Class JwtValidator.Builder

java.lang.Object

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

Enclosing class:

JwtValidator

public static class JwtValidator.Builder
extends Object

Builder for the JwtValidator.

Method Summary

Modifier and Type	Method	Description
JwtValidator	build()	Builds the JwtValidator.
JwtValidator.Builder	claim(String key, JwtClaimConstraint<JsonValue> jwtClaimConstraint)	Adds a JwtClaimConstraint on a claim.
<T, E extends Exception> JwtValidator.Builder	claim(String key, Function<JsonValue,? extends T,E> transformer, JwtClaimConstraint<T> jwtClaimConstraint)	Adds a JwtClaimConstraint on a claim.
JwtValidator.Builder	claims(String key, JwtClaimConstraint<String> jwtClaimConstraint)	Adds a JwtClaimConstraint on a claim.
<T> JwtValidator.Builder	claimSet(String key, Function<Optional<JwtClaimsSet>,Optional<T>> adapter, JwtClaimConstraint<T> jwtClaimConstraint)	Deprecated. since 2024.3.0, with OPENIG-8029.
<T> JwtValidator.Builder	claimSet(String key, Function<Optional<JwtClaimsSet>,Optional<T>> adapter, JwtClaimConstraint<T> jwtClaimConstraint, boolean optional)	Adds a JwtClaimConstraint on the claimSet.
JwtValidator.Builder	jwt(JwtConstraint jwtConstraint)	Adds a JwtConstraint on the JWT.
JwtValidator.Builder	optionalClaim(String key, JwtClaimConstraint<JsonValue> jwtClaimConstraint)	Adds a JsonValue based JwtClaimConstraint on an optional claim.
<T, E extends Exception> JwtValidator.Builder	optionalClaim(String key, Function<JsonValue,? extends T,E> transformer, JwtClaimConstraint<T> jwtClaimConstraint)	Adds a JwtClaimConstraint on an optional claim.
JwtValidator.Builder	optionalClaims(String key, JwtClaimConstraint<String> jwtClaimConstraint)	Adds a String based JwtClaimConstraint on an optional claim.
JwtValidator.Builder	withSkewAllowance(TemporalAmount skewAllowance)	Specifies the skew allowance to use for temporal constraints validations.

Methods inherited from class java.lang.Object

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

Method Details

withSkewAllowance

public JwtValidator.Builder withSkewAllowance(TemporalAmount skewAllowance)

Specifies the skew allowance to use for temporal constraints validations.

Parameters:

skewAllowance - The skew allowance to use for temporal constraints validations

Returns:

This builder.

claim

public <T,
E extends Exception> JwtValidator.Builder claim(String key,
 Function<JsonValue,? extends T,E> transformer,
 JwtClaimConstraint<T> jwtClaimConstraint)

Adds a JwtClaimConstraint on a claim.

Type Parameters:

T - The type of the jwtClaimConstraint.

E - The exception type.

Parameters:

key - The claim's key.

transformer - The transformer function to apply to the claim.

jwtClaimConstraint - The constraint to apply.

Returns:

This builder.

optionalClaim

public <T,
E extends Exception> JwtValidator.Builder optionalClaim(String key,
 Function<JsonValue,? extends T,E> transformer,
 JwtClaimConstraint<T> jwtClaimConstraint)

Adds a JwtClaimConstraint on an optional claim.

Type Parameters:

T - The type of the jwtClaimConstraint.

E - The exception type.

Parameters:

key - The claim's key.

transformer - The transformer function to apply to the optional claim.

jwtClaimConstraint - The constraint to apply.

Returns:

This builder.

claim

public JwtValidator.Builder claim(String key,
 JwtClaimConstraint<JsonValue> jwtClaimConstraint)

Adds a JwtClaimConstraint on a claim.

Parameters:

key - The claim's key or a pointer such forgerock/ssoToken, not null.

jwtClaimConstraint - The constraint to apply on the claim.

Returns:

This builder.

optionalClaim

public JwtValidator.Builder optionalClaim(String key,
 JwtClaimConstraint<JsonValue> jwtClaimConstraint)

Adds a JsonValue based JwtClaimConstraint on an optional claim.

Parameters:

key - The claim's key or a pointer such forgerock/ssoToken, not null.

jwtClaimConstraint - The constraint to apply on the optional claim.

Returns:

This builder.

claims

public JwtValidator.Builder claims(String key,
 JwtClaimConstraint<String> jwtClaimConstraint)

Adds a JwtClaimConstraint on a claim.

Parameters:

key - The claim's key.

jwtClaimConstraint - The constraint to apply on the claim.

Returns:

This builder.

optionalClaims

public JwtValidator.Builder optionalClaims(String key,
 JwtClaimConstraint<String> jwtClaimConstraint)

Adds a String based JwtClaimConstraint on an optional claim.

Parameters:

key - The claim's key.

jwtClaimConstraint - The constraint to apply on the optional claim.

Returns:

This builder.

claimSet

@Deprecated(since="2024.3.0")
public <T> JwtValidator.Builder claimSet(String key,
 Function<Optional<JwtClaimsSet>,Optional<T>> adapter,
 JwtClaimConstraint<T> jwtClaimConstraint)

Deprecated.

since 2024.3.0, with OPENIG-8029. Use claimSet(String, java.util.function.Function, JwtClaimConstraint, boolean) instead.

Adds a JwtClaimConstraint on the claimSet.

Type Parameters:

T - The type of result of the function.

Parameters:

key - The name of the claim's key.

adapter - The adapter function to apply.

jwtClaimConstraint - The constraint to apply on the claimSet.

Returns:

This builder.

claimSet

public <T> JwtValidator.Builder claimSet(String key,
 Function<Optional<JwtClaimsSet>,Optional<T>> adapter,
 JwtClaimConstraint<T> jwtClaimConstraint,
 boolean optional)

Adds a JwtClaimConstraint on the claimSet.

Type Parameters:

T - The type of result of the function.

Parameters:

key - The name of the claim's key.

adapter - The adapter function to apply.

jwtClaimConstraint - The constraint to apply on the claimSet.

optional - Set to true to mark this as an optional claim.

Returns:

This builder.

jwt

public JwtValidator.Builder jwt(JwtConstraint jwtConstraint)

Adds a JwtConstraint on the JWT.

Parameters:

jwtConstraint - The constraint to apply on the JWT.

Returns:

This builder.

build

public JwtValidator build()

Builds the JwtValidator.

Returns:

a new JwtValidator.