CommonsApi (OpenAM Server Only 6.5.5 Documentation)

java.lang.Object
- org.forgerock.api.commons.CommonsApi

public final class CommonsApi
extends Object

Commons ForgeRock API description.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CommonsApi.Errors
Common api errors.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CommonsApi.Errors` Common api errors.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BAD_GATEWAY_REF` JSON Reference to `CommonsApi.Errors.BAD_GATEWAY` in an API Description.
`static String`	`BAD_REQUEST_REF` JSON Reference to `CommonsApi.Errors.BAD_REQUEST` in an API Description.
`static ApiDescription`	`COMMONS_API_DESCRIPTION` The api description of "frapi:common" which only contains errors so far.
`static String`	`CONFLICT_REF` JSON Reference to `CommonsApi.Errors.CONFLICT` in an API Description.
`static String`	`EXPECTATION_FAILED_REF` JSON Reference to `CommonsApi.Errors.EXPECTATION_FAILED` in an API Description.
`static String`	`FORBIDDEN_REF` JSON Reference to `CommonsApi.Errors.FORBIDDEN` in an API Description.
`static String`	`GATEWAY_TIMEOUT_REF` JSON Reference to `CommonsApi.Errors.GATEWAY_TIMEOUT` in an API Description.
`static String`	`GONE_REF` JSON Reference to `CommonsApi.Errors.GONE` in an API Description.
`static String`	`HTTP_VERSION_NOT_SUPPORTED_REF` JSON Reference to `CommonsApi.Errors.HTTP_VERSION_NOT_SUPPORTED` in an API Description.
`static String`	`INTERNAL_SERVER_ERROR_REF` JSON Reference to `CommonsApi.Errors.INTERNAL_SERVER_ERROR` in an API Description.
`static String`	`LENGTH_REQUIRED_REF` JSON Reference to `CommonsApi.Errors.LENGTH_REQUIRED` in an API Description.
`static String`	`METHOD_NOT_ALLOWED_REF` JSON Reference to `CommonsApi.Errors.METHOD_NOT_ALLOWED` in an API Description.
`static String`	`NOT_ACCEPTABLE_REF` JSON Reference to `CommonsApi.Errors.NOT_ACCEPTABLE` in an API Description.
`static String`	`NOT_FOUND_REF` JSON Reference to `CommonsApi.Errors.NOT_FOUND` in an API Description.
`static String`	`NOT_SUPPORTED_REF` JSON Reference to `CommonsApi.Errors.NOT_SUPPORTED` in an API Description.
`static String`	`PAYMENT_REQUIRED_REF` JSON Reference to `CommonsApi.Errors.PAYMENT_REQUIRED` in an API Description.
`static String`	`PRECONDITION_FAILED_REF` JSON Reference to `CommonsApi.Errors.PRECONDITION_FAILED` in an API Description.
`static String`	`PRECONDITION_REQUIRED_REF` JSON Reference to `CommonsApi.Errors.PRECONDITION_REQUIRED` in an API Description.
`static String`	`PROXY_AUTH_REQUIRED_REF` JSON Reference to `CommonsApi.Errors.PROXY_AUTH_REQUIRED` in an API Description.
`static String`	`RANGE_NOT_SATISFIABLE_REF` JSON Reference to `CommonsApi.Errors.RANGE_NOT_SATISFIABLE` in an API Description.
`static String`	`REQUEST_ENTITY_TOO_LARGE_REF` JSON Reference to `CommonsApi.Errors.REQUEST_ENTITY_TOO_LARGE` in an API Description.
`static String`	`REQUEST_TIMEOUT_REF` JSON Reference to `CommonsApi.Errors.REQUEST_TIMEOUT` in an API Description.
`static String`	`REQUEST_URI_TOO_LARGE_REF` JSON Reference to `CommonsApi.Errors.REQUEST_URI_TOO_LARGE` in an API Description.
`static String`	`UNAUTHORIZED_REF` JSON Reference to `CommonsApi.Errors.UNAUTHORIZED` in an API Description.
`static String`	`UNAVAILABLE_REF` JSON Reference to `CommonsApi.Errors.UNAVAILABLE` in an API Description.
`static String`	`UNSUPPORTED_MEDIA_TYPE_REF` JSON Reference to `CommonsApi.Errors.UNSUPPORTED_MEDIA_TYPE` in an API Description.
`static String`	`VERSION_MISMATCH_REF` JSON Reference to `CommonsApi.Errors.VERSION_MISMATCH` in an API Description.
`static String`	`VERSION_REQUIRED_REF` JSON Reference to `CommonsApi.Errors.VERSION_REQUIRED` in an API Description.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COMMONS_API_DESCRIPTION
```
public static final ApiDescription COMMONS_API_DESCRIPTION
```
    The api description of "frapi:common" which only contains errors so far.
  - BAD_REQUEST_REF
```
public static final String BAD_REQUEST_REF
```
    JSON Reference to CommonsApi.Errors.BAD_REQUEST in an API Description.
    
    See Also:
    
    Constant Field Values
  - UNAUTHORIZED_REF
```
public static final String UNAUTHORIZED_REF
```
    JSON Reference to CommonsApi.Errors.UNAUTHORIZED in an API Description.
    
    See Also:
    
    Constant Field Values
  - PAYMENT_REQUIRED_REF
```
public static final String PAYMENT_REQUIRED_REF
```
    JSON Reference to CommonsApi.Errors.PAYMENT_REQUIRED in an API Description.
    
    See Also:
    
    Constant Field Values
  - FORBIDDEN_REF
```
public static final String FORBIDDEN_REF
```
    JSON Reference to CommonsApi.Errors.FORBIDDEN in an API Description.
    
    See Also:
    
    Constant Field Values
  - NOT_FOUND_REF
```
public static final String NOT_FOUND_REF
```
    JSON Reference to CommonsApi.Errors.NOT_FOUND in an API Description.
    
    See Also:
    
    Constant Field Values
  - METHOD_NOT_ALLOWED_REF
```
public static final String METHOD_NOT_ALLOWED_REF
```
    JSON Reference to CommonsApi.Errors.METHOD_NOT_ALLOWED in an API Description.
    
    See Also:
    
    Constant Field Values
  - NOT_ACCEPTABLE_REF
```
public static final String NOT_ACCEPTABLE_REF
```
    JSON Reference to CommonsApi.Errors.NOT_ACCEPTABLE in an API Description.
    
    See Also:
    
    Constant Field Values
  - PROXY_AUTH_REQUIRED_REF
```
public static final String PROXY_AUTH_REQUIRED_REF
```
    JSON Reference to CommonsApi.Errors.PROXY_AUTH_REQUIRED in an API Description.
    
    See Also:
    
    Constant Field Values
  - REQUEST_TIMEOUT_REF
```
public static final String REQUEST_TIMEOUT_REF
```
    JSON Reference to CommonsApi.Errors.REQUEST_TIMEOUT in an API Description.
    
    See Also:
    
    Constant Field Values
  - CONFLICT_REF
```
public static final String CONFLICT_REF
```
    JSON Reference to CommonsApi.Errors.CONFLICT in an API Description.
    
    See Also:
    
    Constant Field Values
  - GONE_REF
```
public static final String GONE_REF
```
    JSON Reference to CommonsApi.Errors.GONE in an API Description.
    
    See Also:
    
    Constant Field Values
  - LENGTH_REQUIRED_REF
```
public static final String LENGTH_REQUIRED_REF
```
    JSON Reference to CommonsApi.Errors.LENGTH_REQUIRED in an API Description.
    
    See Also:
    
    Constant Field Values
  - VERSION_MISMATCH_REF
```
public static final String VERSION_MISMATCH_REF
```
    JSON Reference to CommonsApi.Errors.VERSION_MISMATCH in an API Description.
    
    See Also:
    
    Constant Field Values
  - PRECONDITION_FAILED_REF
```
public static final String PRECONDITION_FAILED_REF
```
    JSON Reference to CommonsApi.Errors.PRECONDITION_FAILED in an API Description.
    
    See Also:
    
    Constant Field Values
  - REQUEST_ENTITY_TOO_LARGE_REF
```
public static final String REQUEST_ENTITY_TOO_LARGE_REF
```
    JSON Reference to CommonsApi.Errors.REQUEST_ENTITY_TOO_LARGE in an API Description.
    
    See Also:
    
    Constant Field Values
  - REQUEST_URI_TOO_LARGE_REF
```
public static final String REQUEST_URI_TOO_LARGE_REF
```
    JSON Reference to CommonsApi.Errors.REQUEST_URI_TOO_LARGE in an API Description.
    
    See Also:
    
    Constant Field Values
  - UNSUPPORTED_MEDIA_TYPE_REF
```
public static final String UNSUPPORTED_MEDIA_TYPE_REF
```
    JSON Reference to CommonsApi.Errors.UNSUPPORTED_MEDIA_TYPE in an API Description.
    
    See Also:
    
    Constant Field Values
  - RANGE_NOT_SATISFIABLE_REF
```
public static final String RANGE_NOT_SATISFIABLE_REF
```
    JSON Reference to CommonsApi.Errors.RANGE_NOT_SATISFIABLE in an API Description.
    
    See Also:
    
    Constant Field Values
  - EXPECTATION_FAILED_REF
```
public static final String EXPECTATION_FAILED_REF
```
    JSON Reference to CommonsApi.Errors.EXPECTATION_FAILED in an API Description.
    
    See Also:
    
    Constant Field Values
  - VERSION_REQUIRED_REF
```
public static final String VERSION_REQUIRED_REF
```
    JSON Reference to CommonsApi.Errors.VERSION_REQUIRED in an API Description.
    
    See Also:
    
    Constant Field Values
  - PRECONDITION_REQUIRED_REF
```
public static final String PRECONDITION_REQUIRED_REF
```
    JSON Reference to CommonsApi.Errors.PRECONDITION_REQUIRED in an API Description.
    
    See Also:
    
    Constant Field Values
  - INTERNAL_SERVER_ERROR_REF
```
public static final String INTERNAL_SERVER_ERROR_REF
```
    JSON Reference to CommonsApi.Errors.INTERNAL_SERVER_ERROR in an API Description.
    
    See Also:
    
    Constant Field Values
  - NOT_SUPPORTED_REF
```
public static final String NOT_SUPPORTED_REF
```
    JSON Reference to CommonsApi.Errors.NOT_SUPPORTED in an API Description.
    
    See Also:
    
    Constant Field Values
  - BAD_GATEWAY_REF
```
public static final String BAD_GATEWAY_REF
```
    JSON Reference to CommonsApi.Errors.BAD_GATEWAY in an API Description.
    
    See Also:
    
    Constant Field Values
  - UNAVAILABLE_REF
```
public static final String UNAVAILABLE_REF
```
    JSON Reference to CommonsApi.Errors.UNAVAILABLE in an API Description.
    
    See Also:
    
    Constant Field Values
  - GATEWAY_TIMEOUT_REF
```
public static final String GATEWAY_TIMEOUT_REF
```
    JSON Reference to CommonsApi.Errors.GATEWAY_TIMEOUT in an API Description.
    
    See Also:
    
    Constant Field Values
  - HTTP_VERSION_NOT_SUPPORTED_REF
```
public static final String HTTP_VERSION_NOT_SUPPORTED_REF
```
    JSON Reference to CommonsApi.Errors.HTTP_VERSION_NOT_SUPPORTED in an API Description.
    
    See Also:
    
    Constant Field Values

Class CommonsApi

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMMONS_API_DESCRIPTION

BAD_REQUEST_REF

UNAUTHORIZED_REF

PAYMENT_REQUIRED_REF

FORBIDDEN_REF

NOT_FOUND_REF

METHOD_NOT_ALLOWED_REF

NOT_ACCEPTABLE_REF

PROXY_AUTH_REQUIRED_REF

REQUEST_TIMEOUT_REF

CONFLICT_REF

GONE_REF

LENGTH_REQUIRED_REF

VERSION_MISMATCH_REF

PRECONDITION_FAILED_REF

REQUEST_ENTITY_TOO_LARGE_REF

REQUEST_URI_TOO_LARGE_REF

UNSUPPORTED_MEDIA_TYPE_REF

RANGE_NOT_SATISFIABLE_REF

EXPECTATION_FAILED_REF

VERSION_REQUIRED_REF

PRECONDITION_REQUIRED_REF

INTERNAL_SERVER_ERROR_REF

NOT_SUPPORTED_REF

BAD_GATEWAY_REF

UNAVAILABLE_REF

GATEWAY_TIMEOUT_REF

HTTP_VERSION_NOT_SUPPORTED_REF