ErrorCode (com.authlete:authlete-java-common 2.9 API)

java.lang.Object
- java.lang.Enum<ErrorCode>
- - com.authlete.common.types.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ErrorCode>
```
public enum ErrorCode
extends Enum<ErrorCode>
```
Values for error from OAuth 2.0 endpoints.
Some error codes are not used by Authlete. For example, because Authlete supports the request parameter and the request_uri parameter, request_not_supported and request_uri_not_supported are not used.

Author:

Takahiko Kawasaki

See Also:

RFC 6749 (OAuth 2.0), 4.1.2.1. Error Response, RFC 6749 (OAuth 2.0), 4.2.2.1. Error Response, RFC 6749 (OAuth 2.0), 5.2. Error Response, RFC 6750 (OAuth 2.0 Bearer Token Usage), 3.1. Error Codes, OpenID Connect Core 1.0, 3.1.2.6. Authorization Error Response

Enum Constant Summary

Enum Constants
Enum Constant and Description
`access_denied` The resource owner or authorization server denied the request.
`account_selection_required` The End-User is REQUIRED to select a session at the Authorization Server.
`consent_required` The Authorization Server requires End-User consent.
`insufficient_scope` The request requires higher privileges than provided by the access token.
`interaction_required` The Authorization Server requires End-User interaction of some form to proceed.
`invalid_client` Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).
`invalid_grant` The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
`invalid_request` The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.
`invalid_request_object` The `request` parameter contains an invalid Request Object.
`invalid_request_uri` The `request_uri` in the Authorization Request returns an error or contains invalid data.
`invalid_scope` The requested scope is invalid, unknown, or malformed.
`invalid_token` The access token provided is expired, revoked, malformed, or invalid for other reasons.
`login_required` The Authorization Server requires End-User authentication.
`registration_not_supported` The OP does not support use of the `registration` parameter defined in Section 7.2.1.
`request_not_supported` The OP does not support use of the `request` parameter defined in Section 6.
`request_uri_not_supported` The OP does not support use of the `request_uri` parameter defined in Section 6.
`server_error` The authorization server encountered an unexpected condition that prevented it from fulfilling the request.
`temporarily_unavailable` The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
`unauthorized_client` The client is not authorized to request an authorization code or an access token using this method.
`unsupported_grant_type` The authorization grant type is not supported by the authorization server.
`unsupported_response_type` The authorization server does not support obtaining an authorization code or an access token using this method.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ErrorCode[]`	`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
  - access_denied
```
public static final ErrorCode access_denied
```
    The resource owner or authorization server denied the request.
  - account_selection_required
```
public static final ErrorCode account_selection_required
```
    The End-User is REQUIRED to select a session at the Authorization Server. The End-User MAY be authenticated at the Authorization Server with different associated accounts, but the End-User did not select a session. This error MAY be returned when the prompt parameter value in the Authentication Request is none, but the Authentication Request cannot be completed without displaying a user interface to prompt for a session to use.
  - consent_required
```
public static final ErrorCode consent_required
```
    The Authorization Server requires End-User consent. This error MAY be returned when the prompt parameter value in the Authentication Request is none, but the Authentication Request cannot be completed without displaying a user interface for End-User consent.
  - insufficient_scope
```
public static final ErrorCode insufficient_scope
```
    The request requires higher privileges than provided by the access token.
  - interaction_required
```
public static final ErrorCode interaction_required
```
    The Authorization Server requires End-User interaction of some form to proceed. This error MAY be returned when the prompt parameter value in the Authentication Request is none, but the Authentication Request cannot be completed without displaying a user interface for End-User interaction.
  - invalid_client
```
public static final ErrorCode invalid_client
```
    Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method). The authorization server MAY return an HTTP 401 (Unauthorized) status code to indicate which HTTP authentication schemes are supported. If the client attempted to authenticate via the "Authorization" request header field, the authorization server MUST respond with an HTTP 401 (Unauthorized) status code and include the "WWW-Authenticate" response header field matching the authentication scheme used by the client.
  - invalid_grant
```
public static final ErrorCode invalid_grant
```
    The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
  - invalid_request
```
public static final ErrorCode invalid_request
```
    The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.
  - invalid_request_uri
```
public static final ErrorCode invalid_request_uri
```
    The request_uri in the Authorization Request returns an error or contains invalid data.
  - invalid_request_object
```
public static final ErrorCode invalid_request_object
```
    The request parameter contains an invalid Request Object.
  - invalid_scope
```
public static final ErrorCode invalid_scope
```
    The requested scope is invalid, unknown, or malformed.
  - invalid_token
```
public static final ErrorCode invalid_token
```
    The access token provided is expired, revoked, malformed, or invalid for other reasons.
  - login_required
```
public static final ErrorCode login_required
```
    The Authorization Server requires End-User authentication. This error MAY be returned when the prompt parameter value in the Authentication Request is none, but the Authentication Request cannot be completed without displaying a user interface for End-User authentication.
  - registration_not_supported
```
public static final ErrorCode registration_not_supported
```
    The OP does not support use of the registration parameter defined in Section 7.2.1.
  - request_not_supported
```
public static final ErrorCode request_not_supported
```
    The OP does not support use of the request parameter defined in Section 6.
  - request_uri_not_supported
```
public static final ErrorCode request_uri_not_supported
```
    The OP does not support use of the request_uri parameter defined in Section 6.
  - server_error
```
public static final ErrorCode server_error
```
    The authorization server encountered an unexpected condition that prevented it from fulfilling the request. (This error code is needed because a 500 Internal Server Error HTTP status code cannot be returned to the client via an HTTP redirect.)
  - temporarily_unavailable
```
public static final ErrorCode temporarily_unavailable
```
    The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server. (This error code is needed because a 503 Service Unavailable HTTP status code cannot be returned to the client via an HTTP redirect.)
  - unauthorized_client
```
public static final ErrorCode unauthorized_client
```
    The client is not authorized to request an authorization code or an access token using this method.
  - unsupported_grant_type
```
public static final ErrorCode unsupported_grant_type
```
    The authorization grant type is not supported by the authorization server.
  - unsupported_response_type
```
public static final ErrorCode unsupported_response_type
```
    The authorization server does not support obtaining an authorization code or an access token using this method.
- Method Detail
  - values
```
public static ErrorCode[] 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 (ErrorCode c : ErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ErrorCode 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

Enum ErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

access_denied

account_selection_required

consent_required

insufficient_scope

interaction_required

invalid_client

invalid_grant

invalid_request

invalid_request_uri

invalid_request_object

invalid_scope

invalid_token

login_required

registration_not_supported

request_not_supported

request_uri_not_supported

server_error

temporarily_unavailable

unauthorized_client

unsupported_grant_type

unsupported_response_type

Method Detail

values

valueOf