JWTVerifier.BaseVerification (java-jwt 3.13.0 API)

java.lang.Object
- com.auth0.jwt.JWTVerifier.BaseVerification

All Implemented Interfaces:: Verification

Enclosing class:: JWTVerifier

public static class JWTVerifier.BaseVerification
extends java.lang.Object
implements Verification

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Verification`	`acceptExpiresAt(long leeway)` Set a specific leeway window in seconds in which the Expires At ("exp") Claim will still be valid.
`Verification`	`acceptIssuedAt(long leeway)` Set a specific leeway window in seconds in which the Issued At ("iat") Claim will still be valid.
`Verification`	`acceptLeeway(long leeway)` Define the default window in seconds in which the Not Before, Issued At and Expires At Claims will still be valid.
`Verification`	`acceptNotBefore(long leeway)` Set a specific leeway window in seconds in which the Not Before ("nbf") Claim will still be valid.
`JWTVerifier`	`build()` Creates a new and reusable instance of the JWTVerifier with the configuration already provided.
`JWTVerifier`	`build(Clock clock)` Creates a new and reusable instance of the JWTVerifier with the configuration already provided.
`Verification`	`ignoreIssuedAt()` Skip the Issued At ("iat") date verification.
`Verification`	`withAnyOfAudience(java.lang.String... audience)` Require that the Audience ("aud") claim contain at least one of the specified audiences.
`Verification`	`withArrayClaim(java.lang.String name, java.lang.Integer... items)` Require a specific Array Claim to contain at least the given items.
`Verification`	`withArrayClaim(java.lang.String name, java.lang.Long... items)` Require a specific Array Claim to contain at least the given items.
`Verification`	`withArrayClaim(java.lang.String name, java.lang.String... items)` Require a specific Array Claim to contain at least the given items.
`Verification`	`withAudience(java.lang.String... audience)` Require a specific Audience ("aud") claim.
`Verification`	`withClaim(java.lang.String name, java.lang.Boolean value)` Require a specific Claim value.
`Verification`	`withClaim(java.lang.String name, java.util.Date value)` Require a specific Claim value.
`Verification`	`withClaim(java.lang.String name, java.lang.Double value)` Require a specific Claim value.
`Verification`	`withClaim(java.lang.String name, java.lang.Integer value)` Require a specific Claim value.
`Verification`	`withClaim(java.lang.String name, java.lang.Long value)` Require a specific Claim value.
`Verification`	`withClaim(java.lang.String name, java.lang.String value)` Require a specific Claim value.
`Verification`	`withClaimPresence(java.lang.String name)` Require a claim to be present, with any value.
`Verification`	`withIssuer(java.lang.String... issuer)` Require a specific Issuer ("iss") claim.
`Verification`	`withJWTId(java.lang.String jwtId)` Require a specific JWT Id ("jti") claim.
`Verification`	`withSubject(java.lang.String subject)` Require a specific Subject ("sub") claim.

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

- Method Detail
  - withIssuer
```
public Verification withIssuer(java.lang.String... issuer)
```
    Description copied from interface: Verification
    
    Require a specific Issuer ("iss") claim.
    
    Specified by:
    
    withIssuer in interface Verification
    
    Parameters:
    
    issuer - the required Issuer value. If multiple values are given, the claim must at least match one of them
    
    Returns:
    
    this same Verification instance.
  - withSubject
```
public Verification withSubject(java.lang.String subject)
```
    Description copied from interface: Verification
    
    Require a specific Subject ("sub") claim.
    
    Specified by:
    
    withSubject in interface Verification
    
    Parameters:
    
    subject - the required Subject value
    
    Returns:
    
    this same Verification instance.
  - withAudience
```
public Verification withAudience(java.lang.String... audience)
```
    Description copied from interface: Verification
    
    Require a specific Audience ("aud") claim. If multiple audiences are specified, they must all be present in the "aud" claim. If this is used in conjunction with Verification.withAnyOfAudience(String...), whichever one is configured last will determine the audience validation behavior.
    
    Specified by:
    
    withAudience in interface Verification
    
    Parameters:
    
    audience - the required Audience value
    
    Returns:
    
    this same Verification instance.
  - withAnyOfAudience
```
public Verification withAnyOfAudience(java.lang.String... audience)
```
    Description copied from interface: Verification
    
    Require that the Audience ("aud") claim contain at least one of the specified audiences. If this is used in conjunction with Verification.withAudience(String...), whichever one is configured last will determine the audience validation behavior. Note: This method was added after the interface was released. It is defined as a default method for compatibility reasons. From version 4.0 on, the method will be abstract and all implementations of this interface will have to provide their own implementation. The default implementation throws an UnsupportedOperationException.
    
    Specified by:
    
    withAnyOfAudience in interface Verification
    
    Parameters:
    
    audience - the required Audience value for which the "aud" claim must contain at least one value.
    
    Returns:
    
    this same Verification instance.
  - acceptLeeway
```
public Verification acceptLeeway(long leeway)
                          throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Define the default window in seconds in which the Not Before, Issued At and Expires At Claims will still be valid. Setting a specific leeway value on a given Claim will override this value for that Claim.
    
    Specified by:
    
    acceptLeeway in interface Verification
    
    Parameters:
    
    leeway - the window in seconds in which the Not Before, Issued At and Expires At Claims will still be valid.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if leeway is negative.
  - acceptExpiresAt
```
public Verification acceptExpiresAt(long leeway)
                             throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Set a specific leeway window in seconds in which the Expires At ("exp") Claim will still be valid. Expiration Date is always verified when the value is present. This method overrides the value set with acceptLeeway
    
    Specified by:
    
    acceptExpiresAt in interface Verification
    
    Parameters:
    
    leeway - the window in seconds in which the Expires At Claim will still be valid.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if leeway is negative.
  - acceptNotBefore
```
public Verification acceptNotBefore(long leeway)
                             throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Set a specific leeway window in seconds in which the Not Before ("nbf") Claim will still be valid. Not Before Date is always verified when the value is present. This method overrides the value set with acceptLeeway
    
    Specified by:
    
    acceptNotBefore in interface Verification
    
    Parameters:
    
    leeway - the window in seconds in which the Not Before Claim will still be valid.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if leeway is negative.
  - acceptIssuedAt
```
public Verification acceptIssuedAt(long leeway)
                            throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Set a specific leeway window in seconds in which the Issued At ("iat") Claim will still be valid. This method overrides the value set with Verification.acceptLeeway(long). By default, the Issued At claim is always verified when the value is present, unless disabled with Verification.ignoreIssuedAt(). If Issued At verification has been disabled, no verification of the Issued At claim will be performed, and this method has no effect.
    
    Specified by:
    
    acceptIssuedAt in interface Verification
    
    Parameters:
    
    leeway - the window in seconds in which the Issued At Claim will still be valid.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if leeway is negative.
  - ignoreIssuedAt
```
public Verification ignoreIssuedAt()
```
    Description copied from interface: Verification
    
    Skip the Issued At ("iat") date verification. By default, the verification is performed.
    
    Specified by:
    
    ignoreIssuedAt in interface Verification
    
    Returns:
    
    this same Verification instance.
  - withJWTId
```
public Verification withJWTId(java.lang.String jwtId)
```
    Description copied from interface: Verification
    
    Require a specific JWT Id ("jti") claim.
    
    Specified by:
    
    withJWTId in interface Verification
    
    Parameters:
    
    jwtId - the required Id value
    
    Returns:
    
    this same Verification instance.
  - withClaimPresence
```
public Verification withClaimPresence(java.lang.String name)
                               throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a claim to be present, with any value.
    
    Specified by:
    
    withClaimPresence in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    Returns:
    
    this same Verification instance
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withClaim
```
public Verification withClaim(java.lang.String name,
                              java.lang.Boolean value)
                       throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Claim value.
    
    Specified by:
    
    withClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    value - the Claim's value.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withClaim
```
public Verification withClaim(java.lang.String name,
                              java.lang.Integer value)
                       throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Claim value.
    
    Specified by:
    
    withClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    value - the Claim's value.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withClaim
```
public Verification withClaim(java.lang.String name,
                              java.lang.Long value)
                       throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Claim value.
    
    Specified by:
    
    withClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    value - the Claim's value.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withClaim
```
public Verification withClaim(java.lang.String name,
                              java.lang.Double value)
                       throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Claim value.
    
    Specified by:
    
    withClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    value - the Claim's value.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withClaim
```
public Verification withClaim(java.lang.String name,
                              java.lang.String value)
                       throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Claim value.
    
    Specified by:
    
    withClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    value - the Claim's value.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withClaim
```
public Verification withClaim(java.lang.String name,
                              java.util.Date value)
                       throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Claim value.
    
    Specified by:
    
    withClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    value - the Claim's value.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withArrayClaim
```
public Verification withArrayClaim(java.lang.String name,
                                   java.lang.String... items)
                            throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Array Claim to contain at least the given items.
    
    Specified by:
    
    withArrayClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    items - the items the Claim must contain.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withArrayClaim
```
public Verification withArrayClaim(java.lang.String name,
                                   java.lang.Integer... items)
                            throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Array Claim to contain at least the given items.
    
    Specified by:
    
    withArrayClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    items - the items the Claim must contain.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - withArrayClaim
```
public Verification withArrayClaim(java.lang.String name,
                                   java.lang.Long... items)
                            throws java.lang.IllegalArgumentException
```
    Description copied from interface: Verification
    
    Require a specific Array Claim to contain at least the given items.
    
    Specified by:
    
    withArrayClaim in interface Verification
    
    Parameters:
    
    name - the Claim's name.
    
    items - the items the Claim must contain.
    
    Returns:
    
    this same Verification instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is null.
  - build
```
public JWTVerifier build()
```
    Description copied from interface: Verification
    
    Creates a new and reusable instance of the JWTVerifier with the configuration already provided.
    
    Specified by:
    
    build in interface Verification
    
    Returns:
    
    a new JWTVerifier instance.
  - build
```
public JWTVerifier build(Clock clock)
```
    Creates a new and reusable instance of the JWTVerifier with the configuration already provided. ONLY FOR TEST PURPOSES.
    
    Parameters:
    
    clock - the instance that will handle the current time.
    
    Returns:
    
    a new JWTVerifier instance with a custom Clock.

Class JWTVerifier.BaseVerification

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withIssuer

withSubject

withAudience

withAnyOfAudience

acceptLeeway

acceptExpiresAt

acceptNotBefore

acceptIssuedAt

ignoreIssuedAt

withJWTId

withClaimPresence

withClaim

withClaim

withClaim

withClaim

withClaim

withClaim

withArrayClaim

withArrayClaim

withArrayClaim

build

build