com.atlassian.asap.api.exception

Class InvalidTokenException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.atlassian.asap.api.exception.InvalidTokenException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidClaimException, InvalidHeaderException, JwtParseException, SignatureMismatchException, TokenExpiredException, TokenTooEarlyException, UnsupportedAlgorithmException

public abstract class InvalidTokenException
extends Exception

Indicates a JWT was syntactically well formed (parses successfully), but failed to validate.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InvalidTokenException(String message)
protected	InvalidTokenException(String message, Throwable cause)
protected	InvalidTokenException(Throwable cause)

Method Summary

Modifier and Type	Method and Description
String	getSafeDetails() Returns safe-to-propagate details about this exception, eg.

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

InvalidTokenException

protected InvalidTokenException(String message)

InvalidTokenException

protected InvalidTokenException(String message,
                                Throwable cause)

InvalidTokenException

protected InvalidTokenException(Throwable cause)

Method Detail

getSafeDetails

public String getSafeDetails()

Returns safe-to-propagate details about this exception, eg. the class name (eg. TokenTooEarlyException, MissingRequiredClaimException, etc.), that we can safely include in any information sent back to the caller (eg. exception messages). May be extended by descendants to provide additional safe-to-propagate details, where appropriate for more specialised exceptions.

Returns:

a string which contains basic details about this exception, and is safe to propagate and log