Class RevetsecException

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AccessTokenValidationException, InvalidSealedStateException, JoseException, JwksUnavailableException, JwsSigningException, KeyImportException, OAuthClientMetadataCacheException, OAuthException, OAuthServerException, OidcException, OidcLogoutException, ScimResourceWorkLimitException

@NotThreadSafe public abstract class RevetsecException extends RuntimeException
The root of every exception Revetsec throws for a condition that a remote party, the input or the runtime environment can cause.

Programmer misuse, such as a null argument or an out-of-range setting, throws NullPointerException, IllegalArgumentException or IllegalStateException instead.

Every instance has:

The constructor is protected only so that Revetsec's own packages can extend this class. Applications catch Revetsec exceptions; they do not subclass or construct them, except through the factories a type documents for that purpose.
Since:
1.0.0
Author:
Mark Allen
See Also:
  • Method Details

    • getCategory

      Returns the category of this failure.
      Returns:
      the category of this failure
      Since:
      1.0.0
    • isTemporaryCondition

      Returns whether this failure is classified as a temporary condition.

      It is true only for a ErrorCategory.TRANSPORT failure caused by a timeout or an I/O error, or by a request Revetsec held back so that it can be sent later, and for a ErrorCategory.REMOTE_ERROR with HTTP status 429 or 5xx or the OAuth error temporarily_unavailable. It is always false for an interrupted thread and for every other category. Documented fixed outcome reasons, including an unknown commit or a known commit whose output was withheld, retain their false classification even if a separately authorized later operation could succeed.

      This classification supplies no permission to replay an operation. Neither value establishes whether a request was sent, whether earlier work had effects, whether a credential remains usable, or whether the operation is idempotent. A timeout, HTTP 429/5xx or OAuth temporarily_unavailable can follow remote consumption or commitment. A false value does not establish a permanent condition or zero effects. Follow the particular operation's effect, pending-state and reconciliation contract; do not automatically repeat a code redemption, rotating refresh, callback, credential mutation or application action.

      Returns:
      whether this failure is classified as a temporary condition
      Since:
      1.0.0