Package net.shibboleth.oidc.jwt.claims

Class AbstractClaimsValidator

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent
net.shibboleth.oidc.jwt.claims.AbstractClaimsValidator
All Implemented Interfaces:
ClaimsValidator, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent
Direct Known Subclasses:
AccessTokenHashValidator, ACRClaimsValidator, AudienceClaimsValidator, AuthenticationTimeClaimsValidator, ExactMatchClaimsValidator, ExpiryClaimsValidator, FunctionClaimsValidator, IssuedAtClaimsValidator, JWTIdentifierClaimsValidator, JWTIdentifierRevocationValidator, NotBeforeClaimsValidator, ProhibitedClaimsValidator, RequiredClaimsValidator
public abstract class AbstractClaimsValidator extends AbstractIdentifiableInitializableComponent implements ClaimsValidator
Base class for claims validators.

  • Field Details

    • activationCondition

      @Nonnull private BiPredicate<ProfileRequestContext,com.nimbusds.jwt.JWTClaimsSet> activationCondition
      Does this validator apply to this request? Default is true.

  • Constructor Details

    • AbstractClaimsValidator

      public AbstractClaimsValidator()
      Constructor.

  • Method Details

    • setActivationCondition

      public void setActivationCondition(@Nonnull BiPredicate<ProfileRequestContext,com.nimbusds.jwt.JWTClaimsSet> condition)
      Set an activation condition for this validator.
      Parameters:
      condition - condition to set

    • validate

      public void validate(@Nonnull com.nimbusds.jwt.JWTClaimsSet claims, @Nonnull ProfileRequestContext context) throws JWTValidationException
      Validate all, or part of, the given JWT claims set. Can take supporting information from the given context tree.

      Throws an exception if validation fails.

      Specified by:
      validate in interface ClaimsValidator
      Parameters:
      claims - the claims to validate.
      context - the profile request context.
      Throws:
      JWTValidationException - when validation is unsuccessful due to a failed attempt

    • doValidate

      protected abstract void doValidate(@Nonnull com.nimbusds.jwt.JWTClaimsSet claims, @Nonnull ProfileRequestContext context) throws JWTValidationException
      Perform validation of the given claims supported by the supplied context.
      Parameters:
      claims - the claims to validate.
      context - the profile request context.
      Throws:
      JWTValidationException - when validation is unsuccessful due to a failed attempt