io.jsonwebtoken

Class ClaimJwtException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.jsonwebtoken.JwtException

io.jsonwebtoken.ClaimJwtException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExpiredJwtException, InvalidClaimException, PrematureJwtException

public abstract class ClaimJwtException
extends JwtException

ClaimJwtException is a subclass of the JwtException that is thrown after a validation of an JWT claim failed.

Since:

0.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE Deprecated. will be removed in a future release.
static String	MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE Deprecated. will be removed in a future release.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClaimJwtException(Header header, Claims claims, String message) Creates a new instance with the specified header, claims and exception message.
protected	ClaimJwtException(Header header, Claims claims, String message, Throwable cause) Creates a new instance with the specified header, claims and exception message as a result of encountering the specified cause.

Method Summary

Methods

Modifier and Type	Method and Description
Claims	getClaims() Returns the Claims that failed validation.
Header	getHeader() Returns the header associated with the claims that failed validation.

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

Field Detail

INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE

@Deprecated
public static final String INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE

Deprecated. will be removed in a future release.

Deprecated as this is an implementation detail accidentally exposed in the JJWT 0.5 public API. It is no longer referenced anywhere in JJWT's implementation and will be removed in a future release.

See Also:

Constant Field Values

MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE

@Deprecated
public static final String MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE

Deprecated. will be removed in a future release.

Deprecated as this is an implementation detail accidentally exposed in the JJWT 0.5 public API. It is no longer referenced anywhere in JJWT's implementation and will be removed in a future release.

See Also:

Constant Field Values

Constructor Detail

ClaimJwtException

protected ClaimJwtException(Header header,
                 Claims claims,
                 String message)

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

Parameters:

header - the header inspected

claims - the claims obtained

message - the exception message

ClaimJwtException

protected ClaimJwtException(Header header,
                 Claims claims,
                 String message,
                 Throwable cause)

Creates a new instance with the specified header, claims and exception message as a result of encountering the specified cause.

Parameters:

header - the header inspected

claims - the claims obtained

message - the exception message

cause - the exception that caused this ClaimJwtException to be thrown.

Method Detail

getClaims

public Claims getClaims()

Returns the Claims that failed validation.

Returns:

the Claims that failed validation.

getHeader

public Header getHeader()

Returns the header associated with the claims that failed validation.

Returns:

the header associated with the claims that failed validation.