io.jsonwebtoken

Class IncorrectClaimException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.jsonwebtoken.JwtException

io.jsonwebtoken.ClaimJwtException

io.jsonwebtoken.InvalidClaimException

io.jsonwebtoken.IncorrectClaimException

All Implemented Interfaces:

Serializable

public class IncorrectClaimException
extends InvalidClaimException

Exception thrown when discovering that a required claim does not equal the required value, indicating the JWT is invalid and may not be used.

Since:

0.6

See Also:

Serialized Form

Field Summary

Fields inherited from class io.jsonwebtoken.ClaimJwtException

INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE, MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
IncorrectClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified header, claims and explanation message.
IncorrectClaimException(Header header, Claims claims, String claimName, Object claimValue, String message, Throwable cause) Creates a new instance with the specified header, claims, explanation message and underlying cause.

Method Summary

Methods inherited from class io.jsonwebtoken.InvalidClaimException

getClaimName, getClaimValue

Methods inherited from class io.jsonwebtoken.ClaimJwtException

getClaims, getHeader

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IncorrectClaimException

public IncorrectClaimException(Header header,
                       Claims claims,
                       String claimName,
                       Object claimValue,
                       String message)

Creates a new instance with the specified header, claims and explanation message.

Parameters:

header - the header inspected

claims - the claims with the incorrect claim value

claimName - the name of the claim that could not be validated

claimValue - the value of the claim that could not be validated

message - the exception message

IncorrectClaimException

public IncorrectClaimException(Header header,
                       Claims claims,
                       String claimName,
                       Object claimValue,
                       String message,
                       Throwable cause)

Creates a new instance with the specified header, claims, explanation message and underlying cause.

Parameters:

header - the header inspected

claims - the claims with the incorrect claim value

claimName - the name of the claim that could not be validated

claimValue - the value of the claim that could not be validated

message - the exception message

cause - the underlying cause that resulted in this exception being thrown