com.auth0.jwt

Class JWTVerifier.Verification

java.lang.Object

com.auth0.jwt.JWTVerifier.Verification

Enclosing class:

JWTVerifier

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

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

Method Summary

Modifier and Type	Method and Description
JWTVerifier.Verification	acceptExpiresAt(long leeway) Set a specific leeway window in seconds in which the Expires At ("exp") Claim will still be valid.
JWTVerifier.Verification	acceptIssuedAt(long leeway) Set a specific leeway window in seconds in which the Issued At ("iat") Claim will still be valid.
JWTVerifier.Verification	acceptLeeway(long leeway) Define the default window in milliseconds in which the Not Before, Issued At and Expires At Claims will still be valid.
JWTVerifier.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.Verification	withAudience(java.lang.String... audience) Require a specific Audience ("aud") claim.
JWTVerifier.Verification	withClaim(java.lang.String name, java.lang.Object value) Require a specific Claim value.
JWTVerifier.Verification	withIssuer(java.lang.String issuer) Require a specific Issuer ("iss") claim.
JWTVerifier.Verification	withJWTId(java.lang.String jwtId) Require a specific JWT Id ("jti") claim.
JWTVerifier.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 JWTVerifier.Verification withIssuer(java.lang.String issuer)

Require a specific Issuer ("iss") claim.

Parameters:

issuer - the required Issuer value

Returns:

this same Verification instance.

withSubject

public JWTVerifier.Verification withSubject(java.lang.String subject)

Require a specific Subject ("sub") claim.

Parameters:

subject - the required Subject value

Returns:

this same Verification instance.

withAudience

public JWTVerifier.Verification withAudience(java.lang.String... audience)

Require a specific Audience ("aud") claim.

Parameters:

audience - the required Audience value

Returns:

this same Verification instance.

acceptLeeway

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

Define the default window in milliseconds 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.

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

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

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

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 JWTVerifier.Verification withJWTId(java.lang.String jwtId)

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

Parameters:

jwtId - the required Id value

Returns:

this same Verification instance.

withClaim

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

Require a specific Claim value.

Parameters:

name - the Claim's name

value - the Claim's value. Must be an instance of Integer, Double, Boolean, Date or String class.

Returns:

this same Verification instance.

Throws:

java.lang.IllegalArgumentException - if the name is null or the value class is not allowed.

build

public JWTVerifier build()

Creates a new and reusable instance of the JWTVerifier with the configuration already provided.

Returns:

a new JWTVerifier instance.