com.neovisionaries.android.oauth20

Enum OAuth20Error

java.lang.Object

java.lang.Enum<OAuth20Error>

com.neovisionaries.android.oauth20.OAuth20Error

All Implemented Interfaces:

Serializable, Comparable<OAuth20Error>

public enum OAuth20Error
extends Enum<OAuth20Error>

Values for error from OAuth 2.0 endpoints.

Since:

1.9

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
access_denied The resource owner or authorization server denied the request.
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_scope The requested scope is invalid, unknown, or malformed.
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

Modifier and Type	Method and Description
static OAuth20Error	valueOf(String name) Returns the enum constant of this type with the specified name.
static OAuth20Error[]	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 OAuth20Error access_denied

The resource owner or authorization server denied the request.

invalid_client

public static final OAuth20Error 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 OAuth20Error 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 OAuth20Error 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_scope

public static final OAuth20Error invalid_scope

The requested scope is invalid, unknown, or malformed.

server_error

public static final OAuth20Error 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 OAuth20Error 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 OAuth20Error 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 OAuth20Error unsupported_grant_type

The authorization grant type is not supported by the authorization server.

unsupported_response_type

public static final OAuth20Error 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 OAuth20Error[] 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 (OAuth20Error c : OAuth20Error.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OAuth20Error 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