Package net.openid.appauth

Class AuthorizationException.AuthorizationRequestErrors

java.lang.Object

net.openid.appauth.AuthorizationException.AuthorizationRequestErrors

Enclosing class:

AuthorizationException

public static final class AuthorizationException.AuthorizationRequestErrors
extends Object

Error codes related to failed authorization requests.

See Also:

“The OAuth 2.0 Authorization Framework (RFC 6749), Section 4.1.2.1 https://tools.ietf.org/html/rfc6749#section-4.1.2.1”

Field Summary

Fields

Modifier and Type	Field	Description
static AuthorizationException	ACCESS_DENIED	An access_denied OAuth2 error response.
static AuthorizationException	CLIENT_ERROR	An authorization error occurring on the client rather than the server.
static AuthorizationException	INVALID_REQUEST	An invalid_request OAuth2 error response.
static AuthorizationException	INVALID_SCOPE	An invalid_scope OAuth2 error response.
static AuthorizationException	OTHER	Indicates an OAuth error as per RFC 6749, but the error code is not known to the AppAuth for Android library.
static AuthorizationException	SERVER_ERROR	An server_error OAuth2 error response, equivalent to an HTTP 500 error code, but sent via redirect.
static AuthorizationException	STATE_MISMATCH	Indicates that the response state param did not match the request state param, resulting in the response being discarded.
static AuthorizationException	TEMPORARILY_UNAVAILABLE	A temporarily_unavailable OAuth2 error response, equivalent to an HTTP 503 error code, but sent via redirect.
static AuthorizationException	UNAUTHORIZED_CLIENT	An unauthorized_client OAuth2 error response.
static AuthorizationException	UNSUPPORTED_RESPONSE_TYPE	An unsupported_response_type OAuth2 error response.

Constructor Summary

Constructors

Constructor	Description
AuthorizationRequestErrors()

Method Summary

Modifier and Type	Method	Description
static AuthorizationException	byString(String error)	Returns the matching exception type for the provided OAuth2 error string, or OTHER if unknown.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_REQUEST

public static final AuthorizationException INVALID_REQUEST

An invalid_request OAuth2 error response.

UNAUTHORIZED_CLIENT

public static final AuthorizationException UNAUTHORIZED_CLIENT

An unauthorized_client OAuth2 error response.

ACCESS_DENIED

public static final AuthorizationException ACCESS_DENIED

An access_denied OAuth2 error response.

UNSUPPORTED_RESPONSE_TYPE

public static final AuthorizationException UNSUPPORTED_RESPONSE_TYPE

An unsupported_response_type OAuth2 error response.

INVALID_SCOPE

public static final AuthorizationException INVALID_SCOPE

An invalid_scope OAuth2 error response.

SERVER_ERROR

public static final AuthorizationException SERVER_ERROR

An server_error OAuth2 error response, equivalent to an HTTP 500 error code, but sent via redirect.

TEMPORARILY_UNAVAILABLE

public static final AuthorizationException TEMPORARILY_UNAVAILABLE

A temporarily_unavailable OAuth2 error response, equivalent to an HTTP 503 error code, but sent via redirect.

CLIENT_ERROR

public static final AuthorizationException CLIENT_ERROR

An authorization error occurring on the client rather than the server.

For example, due to client misconfiguration. This error should be treated as unrecoverable.

OTHER

public static final AuthorizationException OTHER

Indicates an OAuth error as per RFC 6749, but the error code is not known to the AppAuth for Android library.

It could be a custom error or code, or one from an OAuth extension. The AuthorizationException.error field provides the exact error string returned by the server.

STATE_MISMATCH

public static final AuthorizationException STATE_MISMATCH

Indicates that the response state param did not match the request state param, resulting in the response being discarded.

Constructor Detail

AuthorizationRequestErrors

public AuthorizationRequestErrors()

Method Detail

byString

@NonNull
public static AuthorizationException byString(String error)

Returns the matching exception type for the provided OAuth2 error string, or OTHER if unknown.