CommonsApi.Errors (OpenAM Server Only 6.5.5 Documentation)

java.lang.Object
- java.lang.Enum<CommonsApi.Errors>
- - org.forgerock.api.commons.CommonsApi.Errors

All Implemented Interfaces:

Serializable, Comparable<CommonsApi.Errors>

Enclosing class:

CommonsApi
```
public static enum CommonsApi.Errors
extends Enum<CommonsApi.Errors>
```
Common api errors.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BAD_GATEWAY` The "bad gateway" error.
`BAD_REQUEST` The "bad request" error.
`CONFLICT` The "conflict" error.
`EXPECTATION_FAILED` The "expectation failed" error.
`FORBIDDEN` The "forbidden" error.
`GATEWAY_TIMEOUT` The "gateway timeout" error.
`GONE` The "gone" error.
`HTTP_VERSION_NOT_SUPPORTED` The "http version not supported" error.
`INTERNAL_SERVER_ERROR` The "internal server error" error.
`LENGTH_REQUIRED` The "length required" error.
`METHOD_NOT_ALLOWED` The "method not allowed" error.
`NOT_ACCEPTABLE` The "not acceptable" error.
`NOT_FOUND` The "not found" error.
`NOT_SUPPORTED` The "not supported" error.
`PAYMENT_REQUIRED` The "payment required" error.
`PRECONDITION_FAILED` The "precondition failed" error.
`PRECONDITION_REQUIRED` The "precondition required" error.
`PROXY_AUTH_REQUIRED` The "proxy auth required" error.
`RANGE_NOT_SATISFIABLE` The "range not satisfiable" error.
`REQUEST_ENTITY_TOO_LARGE` The "request entity too large" error.
`REQUEST_TIMEOUT` The "request timeout" error.
`REQUEST_URI_TOO_LARGE` The "request uri too large" error.
`UNAUTHORIZED` The "unauthorized" error.
`UNAVAILABLE` The "unavailable" error.
`UNSUPPORTED_MEDIA_TYPE` The "unsupported media type" error.
`VERSION_MISMATCH` The "version mismatch" error.
`VERSION_REQUIRED` The "version required " error.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getReference()` The reference to use in an API description.
`static CommonsApi.Errors`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CommonsApi.Errors[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - 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 Detail
  - values
```
public static CommonsApi.Errors[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (CommonsApi.Errors c : CommonsApi.Errors.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CommonsApi.Errors valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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

Enum CommonsApi.Errors

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BAD_REQUEST

UNAUTHORIZED

PAYMENT_REQUIRED

FORBIDDEN

NOT_FOUND

METHOD_NOT_ALLOWED

NOT_ACCEPTABLE

PROXY_AUTH_REQUIRED

REQUEST_TIMEOUT

CONFLICT

GONE

LENGTH_REQUIRED

VERSION_MISMATCH

PRECONDITION_FAILED

REQUEST_ENTITY_TOO_LARGE

REQUEST_URI_TOO_LARGE

UNSUPPORTED_MEDIA_TYPE

RANGE_NOT_SATISFIABLE

EXPECTATION_FAILED

VERSION_REQUIRED

PRECONDITION_REQUIRED

INTERNAL_SERVER_ERROR

NOT_SUPPORTED

BAD_GATEWAY

UNAVAILABLE

GATEWAY_TIMEOUT

HTTP_VERSION_NOT_SUPPORTED

Method Detail

values

valueOf

getReference