io.jsonwebtoken

Class InvalidClaimException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.jsonwebtoken.JwtException

io.jsonwebtoken.ClaimJwtException

io.jsonwebtoken.InvalidClaimException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IncorrectClaimException, MissingClaimException

public class InvalidClaimException
extends ClaimJwtException

Exception indicating a parsed claim is invalid in some way. Subclasses reflect the specific reason the claim is invalid.

Since:

0.6

See Also:

IncorrectClaimException, MissingClaimException, Serialized Form

Field Summary

Fields inherited from class io.jsonwebtoken.ClaimJwtException

INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE, MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InvalidClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified header, claims and explanation message.
protected	InvalidClaimException(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

Modifier and Type	Method and Description
String	getClaimName() Returns the name of the invalid claim.
Object	getClaimValue() Returns the claim value that could not be validated.

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

InvalidClaimException

protected InvalidClaimException(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 obtained

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

InvalidClaimException

protected InvalidClaimException(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 obtained

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

Method Detail

getClaimName

public String getClaimName()

Returns the name of the invalid claim.

Returns:

the name of the invalid claim.

getClaimValue

public Object getClaimValue()

Returns the claim value that could not be validated.

Returns:

the claim value that could not be validated.