Enum Class ErrorCategory

java.lang.Object
java.lang.Enum<ErrorCategory>
com.revetsec.ErrorCategory
All Implemented Interfaces:
Serializable, Comparable<ErrorCategory>, Constable

The broad kind of failure a RevetsecException reports.

Every RevetsecException has exactly one category. The documented category, reason, cause and response status determine its fixed temporary condition classification (see RevetsecException.isTemporaryCondition()). Only TRANSPORT and REMOTE_ERROR failures may be marked temporary; no category establishes whether earlier work had effects or is safe to replay.

Since:
1.0.0
Author:
Mark Allen
  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Revetsec's configuration or runtime environment prevents the operation, in a way that could be discovered only at runtime, such as remote metadata that is incompatible with the configuration, or a default HTTP client that could not be started in this JVM.
    The input could not be parsed, or it exceeded a configured limit: bad syntax, bad encoding, an oversized document or an unexpected structure.
    The remote party answered with an error, such as an HTTP error status or a protocol error response.
    An external exchange or admitted operation did not yield ordinary successful output.
    The input uses a feature that Revetsec does not support.
    The input was well formed but failed a security or protocol check, such as a signature, issuer, audience, lifetime or state check.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    static ErrorCategory[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • MALFORMED_INPUT

      public static final ErrorCategory MALFORMED_INPUT
      The input could not be parsed, or it exceeded a configured limit: bad syntax, bad encoding, an oversized document or an unexpected structure. Never transient.
    • VALIDATION_FAILURE

      public static final ErrorCategory VALIDATION_FAILURE
      The input was well formed but failed a security or protocol check, such as a signature, issuer, audience, lifetime or state check. Never transient.
    • REMOTE_ERROR

      public static final ErrorCategory REMOTE_ERROR
      The remote party answered with an error, such as an HTTP error status or a protocol error response. Transient only for HTTP 429 or 5xx, or OAuth error=temporarily_unavailable.
    • TRANSPORT

      public static final ErrorCategory TRANSPORT
      An external exchange or admitted operation did not yield ordinary successful output. Selected timeout, I/O and held-back-request conditions may be marked temporary. Interrupted threads and documented fixed commit outcome reasons retain their false classification; the category alone is no effect or replay verdict.
    • CONFIGURATION

      public static final ErrorCategory CONFIGURATION
      Revetsec's configuration or runtime environment prevents the operation, in a way that could be discovered only at runtime, such as remote metadata that is incompatible with the configuration, or a default HTTP client that could not be started in this JVM. Never transient.
    • UNSUPPORTED

      public static final ErrorCategory UNSUPPORTED
      The input uses a feature that Revetsec does not support. Never transient.
  • Method Details

    • values

      public static ErrorCategory[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ErrorCategory valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null