RequiredClaimsValidator (Shibboleth IdP :: Plugins :: OIDC Common :: Parent 2.2.2-SNAPSHOT API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
  - - net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
    - - net.shibboleth.oidc.jwt.claims.AbstractClaimsValidator
      - net.shibboleth.oidc.security.jwt.claims.impl.RequiredClaimsValidator

All Implemented Interfaces:

ClaimsValidator, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent
```
@ThreadSafeAfterInit
public class RequiredClaimsValidator
extends AbstractClaimsValidator
```
Verify the claims set contains the given set of required claims.

Field Summary

Fields
Modifier and Type Field Description

private Set<String> requiredClaims
The names of the JWT claims that must be present, if empty no claims are required.

Constructor Summary

Constructors
Constructor Description

RequiredClaimsValidator()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doValidate(com.nimbusds.jwt.JWTClaimsSet claims, ProfileRequestContext context)`	Perform validation of the given claims supported by the supplied context.
`void`	`setRequiredClaims(Collection<String> claims)`	Set the required claims.

Methods inherited from class net.shibboleth.oidc.jwt.claims.AbstractClaimsValidator
setActivationCondition, validate

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiableComponent
setId

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent
getId

- Field Detail
  - requiredClaims
```
@Nonnull
@NonnullElements
private Set<String> requiredClaims
```
    The names of the JWT claims that must be present, if empty no claims are required.
- Constructor Detail
  - RequiredClaimsValidator
```
public RequiredClaimsValidator()
```
    Constructor.
- Method Detail
  - setRequiredClaims
```
public void setRequiredClaims(@Nullable
                              Collection<String> claims)
```
    Set the required claims.
    
    Parameters:
    
    claims - the required claims.
  - doValidate
```
public void doValidate(@Nonnull
                       com.nimbusds.jwt.JWTClaimsSet claims,
                       @Nonnull
                       ProfileRequestContext context)
                throws JWTValidationException
```
    Perform validation of the given claims supported by the supplied context.
    
    Specified by:
    
    doValidate in class AbstractClaimsValidator
    
    Parameters:
    
    claims - the claims to validate.
    
    context - the profile request context.
    
    Throws:
    
    JWTValidationException - when validation is unsuccessful due to a failed attempt