Module io.helidon.security.jwt

Package io.helidon.security.jwt

Class JwtValidator.Builder

java.lang.Object

io.helidon.security.jwt.JwtValidator.Builder

All Implemented Interfaces:

Builder<JwtValidator.Builder,JwtValidator>, Supplier<JwtValidator>

Enclosing interface:

JwtValidator

public static final class JwtValidator.Builder
extends Object
implements Builder<JwtValidator.Builder,JwtValidator>

Builder of the JwtValidator.

Method Summary

Modifier and Type	Method	Description
JwtValidator.Builder	addAudienceValidator(String expectedAudience)	Add new AudienceValidator with the expected audience.
JwtValidator.Builder	addAudienceValidator(Consumer<AudienceValidator.Builder> builderConsumer)	Add new AudienceValidator instance based on the builder configuration.
JwtValidator.Builder	addAudienceValidator(Set<String> expectedAudience)	Add new AudienceValidator with the expected audience.
JwtValidator.Builder	addClaimValidator(ClaimValidator claimValidator)	Add ClaimValidator instance.
JwtValidator.Builder	addCriticalValidator()	Add new "crit" claim validator.
JwtValidator.Builder	addDefaultTimeValidators()	Add default time validators.
JwtValidator.Builder	addDefaultTimeValidators(Instant now, Duration allowedTimeSkew, boolean mandatory)	Add default time validators with specific time settings.
JwtValidator.Builder	addExpirationValidator()	Add new ExpirationValidator instance.
JwtValidator.Builder	addExpirationValidator(Consumer<ExpirationValidator.Builder> builderConsumer)	Add new ExpirationValidator instance based on the builder configuration.
JwtValidator.Builder	addFieldValidator(Consumer<FieldValidator.Builder> builderConsumer)	Add new FieldValidator based on the builder configuration.
JwtValidator.Builder	addHeaderFieldValidator(String claimKey, String fieldName, String expectedValue)	Add new FieldValidator of the header field.
JwtValidator.Builder	addIssuerValidator(String expectedIssuer)	Add new JWT issuer validator.
JwtValidator.Builder	addIssuerValidator(String expectedIssuer, boolean mandatory)	Add new JWT issuer validator.
JwtValidator.Builder	addIssueTimeValidator()	Add new IssueTimeValidator instance.
JwtValidator.Builder	addIssueTimeValidator(Consumer<IssueTimeValidator.Builder> builderConsumer)	Add new IssueTimeValidator instance based on the builder configuration.
JwtValidator.Builder	addMaxTokenAgeValidator(Duration expectedMaxTokenAge)	Add new MaxTokenAgeValidator with the expected max token age.
JwtValidator.Builder	addMaxTokenAgeValidator(Consumer<MaxTokenAgeValidator.Builder> builderConsumer)	Add new MaxTokenAgeValidator instance based on the builder configuration.
JwtValidator.Builder	addNotBeforeValidator()	Add new NotBeforeValidator instance.
JwtValidator.Builder	addNotBeforeValidator(Consumer<NotBeforeValidator.Builder> builderConsumer)	Add new NotBeforeValidator instance based on the builder configuration.
JwtValidator.Builder	addPayloadFieldValidator(String claimKey, String fieldName, String expectedValue)	Add new FieldValidator of the payload field.
JwtValidator.Builder	addUserPrincipalValidator()	Add new UserPrincipalValidator.
JwtValidator.Builder	addUserPrincipalValidator(Consumer<UserPrincipalValidator.Builder> builderConsumer)	Add new UserPrincipalValidator instance based on the builder configuration.
JwtValidator.Builder	addValidator(JwtScope scope, Validator<Jwt> validator, String... claims)	Add Validator instance among the claim validators.
JwtValidator.Builder	addValidator(Validator<Jwt> validator, String... claims)	Add Validator instance among the claim validators.
JwtValidator	build()	Build the instance from this builder.
JwtValidator.Builder	clearValidators()	Clear all add validators.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Method Details

build

public JwtValidator build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<JwtValidator.Builder,JwtValidator>

Returns:

instance of the built type

addClaimValidator

public JwtValidator.Builder addClaimValidator(ClaimValidator claimValidator)

Add ClaimValidator instance.

Parameters:

claimValidator - claim validator to be added

Returns:

updated builder instance

addValidator

public JwtValidator.Builder addValidator(Validator<Jwt> validator,
 String... claims)

Add Validator instance among the claim validators. Default scope is set to JwtScope.PAYLOAD.

Parameters:

validator - to be added

claims - claims handled by the validator

Returns:

updated builder instance

addValidator

public JwtValidator.Builder addValidator(JwtScope scope,
 Validator<Jwt> validator,
 String... claims)

Add Validator instance among the claim validators.

Parameters:

scope - scope of the validator

validator - to be added

claims - claims handled by the validator

Returns:

updated builder instance

addHeaderFieldValidator

public JwtValidator.Builder addHeaderFieldValidator(String claimKey,
 String fieldName,
 String expectedValue)

Add new FieldValidator of the header field.

Parameters:

claimKey - claim key

fieldName - header field to be validated

expectedValue - expected value of the field

Returns:

updated builder instance

addPayloadFieldValidator

public JwtValidator.Builder addPayloadFieldValidator(String claimKey,
 String fieldName,
 String expectedValue)

Add new FieldValidator of the payload field.

Parameters:

claimKey - claim key

fieldName - payload field to be validated

expectedValue - expected value of the field

Returns:

updated builder instance

addFieldValidator

public JwtValidator.Builder addFieldValidator(Consumer<FieldValidator.Builder> builderConsumer)

Add new FieldValidator based on the builder configuration.

Parameters:

builderConsumer - consumer of the builder

Returns:

updated builder instance

addIssuerValidator

public JwtValidator.Builder addIssuerValidator(String expectedIssuer)

Add new JWT issuer validator. This issuer claim is set as mandatory to be present by default.

Parameters:

expectedIssuer - expected JWT issuer

Returns:

updated builder instance

addIssuerValidator

public JwtValidator.Builder addIssuerValidator(String expectedIssuer,
 boolean mandatory)

Add new JWT issuer validator.

Parameters:

expectedIssuer - expected JWT issuer

mandatory - whether this issuer claim is mandatory

Returns:

updated builder instance

addDefaultTimeValidators

public JwtValidator.Builder addDefaultTimeValidators()

Add default time validators. This adds the following validators:

• ExpirationValidator
• IssueTimeValidator
• NotBeforeValidator

Returns:

updated builder instance

addDefaultTimeValidators

public JwtValidator.Builder addDefaultTimeValidators(Instant now,
 Duration allowedTimeSkew,
 boolean mandatory)

Add default time validators with specific time settings. This adds the following validators:

• ExpirationValidator
• IssueTimeValidator
• NotBeforeValidator

Parameters:

now - time which is considered current time during the time validation

allowedTimeSkew - allowed time skew

mandatory - whether the time claims are mandatory to be present

Returns:

updated builder instance

addExpirationValidator

public JwtValidator.Builder addExpirationValidator()

Add new ExpirationValidator instance.

Returns:

updated builder instance

addExpirationValidator

public JwtValidator.Builder addExpirationValidator(Consumer<ExpirationValidator.Builder> builderConsumer)

Add new ExpirationValidator instance based on the builder configuration.

Parameters:

builderConsumer - consumer of the builder

Returns:

updated builder instance

addNotBeforeValidator

public JwtValidator.Builder addNotBeforeValidator()

Add new NotBeforeValidator instance.

Returns:

updated builder instance

addNotBeforeValidator

public JwtValidator.Builder addNotBeforeValidator(Consumer<NotBeforeValidator.Builder> builderConsumer)

Add new NotBeforeValidator instance based on the builder configuration.

Parameters:

builderConsumer - consumer of the builder

Returns:

updated builder instance

addIssueTimeValidator

public JwtValidator.Builder addIssueTimeValidator()

Add new IssueTimeValidator instance.

Returns:

updated builder instance

addIssueTimeValidator

public JwtValidator.Builder addIssueTimeValidator(Consumer<IssueTimeValidator.Builder> builderConsumer)

Add new IssueTimeValidator instance based on the builder configuration.

Parameters:

builderConsumer - consumer of the builder

Returns:

updated builder instance

addCriticalValidator

public JwtValidator.Builder addCriticalValidator()

Add new "crit" claim validator. This validator behaves as mentioned in RFC 7515 - 4.1.11.

Returns:

updated builder instance

See Also:

• RFC 7515 - 4.1.11

addUserPrincipalValidator

public JwtValidator.Builder addUserPrincipalValidator()

Add new UserPrincipalValidator. This validator is mandatory by default.

Returns:

updated builder instance

addUserPrincipalValidator

public JwtValidator.Builder addUserPrincipalValidator(Consumer<UserPrincipalValidator.Builder> builderConsumer)

Add new UserPrincipalValidator instance based on the builder configuration. This validator is mandatory by default.

Parameters:

builderConsumer - consumer of the builder

Returns:

updated builder instance

addMaxTokenAgeValidator

public JwtValidator.Builder addMaxTokenAgeValidator(Duration expectedMaxTokenAge)

Add new MaxTokenAgeValidator with the expected max token age.

Parameters:

expectedMaxTokenAge - expected max token age

Returns:

updated builder instance

addMaxTokenAgeValidator

public JwtValidator.Builder addMaxTokenAgeValidator(Consumer<MaxTokenAgeValidator.Builder> builderConsumer)

Add new MaxTokenAgeValidator instance based on the builder configuration.

Parameters:

builderConsumer - consumer of the builder

Returns:

updated builder instance

addAudienceValidator

public JwtValidator.Builder addAudienceValidator(String expectedAudience)

Add new AudienceValidator with the expected audience. This validator is mandatory by default.

Parameters:

expectedAudience - expected audience

Returns:

updated builder instance

addAudienceValidator

public JwtValidator.Builder addAudienceValidator(Set<String> expectedAudience)

Add new AudienceValidator with the expected audience. This validator is mandatory by default.

Parameters:

expectedAudience - expected audience

Returns:

updated builder instance

addAudienceValidator

public JwtValidator.Builder addAudienceValidator(Consumer<AudienceValidator.Builder> builderConsumer)

Add new AudienceValidator instance based on the builder configuration. This validator is mandatory by default.

Parameters:

builderConsumer - consumer of the builder

Returns:

updated builder instance

clearValidators

public JwtValidator.Builder clearValidators()

Clear all add validators.

Returns:

updated builder instance