Package org.forgerock.api.commons

Enum Class CommonsApi.Errors

java.lang.Object
java.lang.Enum<CommonsApi.Errors>
org.forgerock.api.commons.CommonsApi.Errors
All Implemented Interfaces:
Serializable, Comparable<CommonsApi.Errors>, java.lang.constant.Constable
Enclosing class:
CommonsApi
public static enum CommonsApi.Errors extends Enum<CommonsApi.Errors>
Common api errors.

  • Enum Constant Details

    • BAD_REQUEST

      public static final CommonsApi.Errors BAD_REQUEST
      The "bad request" error.

    • UNAUTHORIZED

      public static final CommonsApi.Errors UNAUTHORIZED
      The "unauthorized" error.

    • PAYMENT_REQUIRED

      public static final CommonsApi.Errors PAYMENT_REQUIRED
      The "payment required" error.

    • FORBIDDEN

      public static final CommonsApi.Errors FORBIDDEN
      The "forbidden" error.

    • NOT_FOUND

      public static final CommonsApi.Errors NOT_FOUND
      The "not found" error.

    • METHOD_NOT_ALLOWED

      public static final CommonsApi.Errors METHOD_NOT_ALLOWED
      The "method not allowed" error.

    • NOT_ACCEPTABLE

      public static final CommonsApi.Errors NOT_ACCEPTABLE
      The "not acceptable" error.

    • PROXY_AUTH_REQUIRED

      public static final CommonsApi.Errors PROXY_AUTH_REQUIRED
      The "proxy auth required" error.

    • REQUEST_TIMEOUT

      public static final CommonsApi.Errors REQUEST_TIMEOUT
      The "request timeout" error.

    • CONFLICT

      public static final CommonsApi.Errors CONFLICT
      The "conflict" error.

    • GONE

      public static final CommonsApi.Errors GONE
      The "gone" error.

    • LENGTH_REQUIRED

      public static final CommonsApi.Errors LENGTH_REQUIRED
      The "length required" error.

    • VERSION_MISMATCH

      public static final CommonsApi.Errors VERSION_MISMATCH
      The "version mismatch" error.

    • PRECONDITION_FAILED

      public static final CommonsApi.Errors PRECONDITION_FAILED
      The "precondition failed" error.

    • REQUEST_ENTITY_TOO_LARGE

      public static final CommonsApi.Errors REQUEST_ENTITY_TOO_LARGE
      The "request entity too large" error.

    • REQUEST_URI_TOO_LARGE

      public static final CommonsApi.Errors REQUEST_URI_TOO_LARGE
      The "request uri too large" error.

    • UNSUPPORTED_MEDIA_TYPE

      public static final CommonsApi.Errors UNSUPPORTED_MEDIA_TYPE
      The "unsupported media type" error.

    • RANGE_NOT_SATISFIABLE

      public static final CommonsApi.Errors RANGE_NOT_SATISFIABLE
      The "range not satisfiable" error.

    • EXPECTATION_FAILED

      public static final CommonsApi.Errors EXPECTATION_FAILED
      The "expectation failed" error.

    • VERSION_REQUIRED

      public static final CommonsApi.Errors VERSION_REQUIRED
      The "version required " error.

    • PRECONDITION_REQUIRED

      public static final CommonsApi.Errors PRECONDITION_REQUIRED
      The "precondition required" error.

    • INTERNAL_SERVER_ERROR

      public static final CommonsApi.Errors INTERNAL_SERVER_ERROR
      The "internal server error" error.

    • NOT_SUPPORTED

      public static final CommonsApi.Errors NOT_SUPPORTED
      The "not supported" error.

    • BAD_GATEWAY

      public static final CommonsApi.Errors BAD_GATEWAY
      The "bad gateway" error.

    • UNAVAILABLE

      public static final CommonsApi.Errors UNAVAILABLE
      The "unavailable" error.

    • GATEWAY_TIMEOUT

      public static final CommonsApi.Errors GATEWAY_TIMEOUT
      The "gateway timeout" error.

    • HTTP_VERSION_NOT_SUPPORTED

      public static final CommonsApi.Errors HTTP_VERSION_NOT_SUPPORTED
      The "http version not supported" error.

  • Method Details

    • values

      public static CommonsApi.Errors[] 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 CommonsApi.Errors 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

    • getReference

      public String getReference()
      The reference to use in an API description.
      Returns:
      the reference of this error