ProhibitedClaimsValidator (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.ProhibitedClaimsValidator

All Implemented Interfaces:

ClaimsValidator, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent
```
@ThreadSafeAfterInit
public class ProhibitedClaimsValidator
extends AbstractClaimsValidator
```
Verify the claims set does not contain any of the described set of claims.

Field Summary

Fields
Modifier and Type Field Description

private Set<String> prohibitedClaims
The names of the JWT claims that must not be present, empty set if none.

Constructor Summary

Constructors
Constructor Description

ProhibitedClaimsValidator()
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`	`setProhibitedClaims(Collection<String> claims)`	Set the prohibited 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
  - prohibitedClaims
```
@Nonnull
@NonnullElements
private Set<String> prohibitedClaims
```
    The names of the JWT claims that must not be present, empty set if none.
- Constructor Detail
  - ProhibitedClaimsValidator
```
public ProhibitedClaimsValidator()
```
    Constructor.
- Method Detail
  - setProhibitedClaims
```
public void setProhibitedClaims(@Nullable
                                Collection<String> claims)
```
    Set the prohibited claims.
    
    Parameters:
    
    claims - the prohibited 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