com.auth0.jwt

Class JWTVerifier.BaseVerification

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

The Verification class holds the Claims required by a JWT to be valid.

Method Summary

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	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.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	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)

Require a specific Issuer ("iss") claim.

Specified by:

withIssuer in interface Verification

Parameters:

issuer - the required Issuer value

Returns:

this same Verification instance.

withSubject

public Verification withSubject(java.lang.String subject)

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)

Require a specific Audience ("aud") claim.

Specified by:

withAudience in interface Verification

Parameters:

audience - the required Audience value

Returns:

this same Verification instance.

acceptLeeway

public Verification acceptLeeway(long leeway)
                          throws java.lang.IllegalArgumentException

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

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

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

Set a specific leeway window in seconds in which the Issued At ("iat") Claim will still be valid. Issued At Date is always verified when the value is present. This method overrides the value set with acceptLeeway

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.

withJWTId

public Verification withJWTId(java.lang.String jwtId)

Require a specific JWT Id ("jti") claim.

Specified by:

withJWTId in interface Verification

Parameters:

jwtId - the required Id value

Returns:

this same Verification instance.

withClaim

public Verification withClaim(java.lang.String name,
                              java.lang.Boolean value)
                       throws java.lang.IllegalArgumentException

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

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

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

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

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

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

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

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()

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.