lithium.community.android.sdk.auth

Class LiAuthorizationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

lithium.community.android.sdk.auth.LiAuthorizationException

All Implemented Interfaces:

java.io.Serializable

public final class LiAuthorizationException
extends java.lang.Exception

Returned as a response to OAuth2 requests if they fail. Specifically:

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LiAuthorizationException.AuthorizationRequestErrors Error codes related to failed authorization requests.
static class	LiAuthorizationException.GeneralErrors Error codes specific to AppAuth for Android, rather than those defined in the OAuth2 and OpenID specifications.
static class	LiAuthorizationException.RegistrationRequestErrors Error codes related to failed registration requests.
static class	LiAuthorizationException.TokenRequestErrors Error codes related to failed token requests.

Field Summary

Fields

Modifier and Type	Field and Description
int	code The error code describing the class of problem encountered from the set defined in this class.
java.lang.String	error The error string as it is found in the OAuth2 protocol.
java.lang.String	errorDescription The human readable error message associated with this exception, if available.
android.net.Uri	errorUri A URI identifying a human-readable web page with information about this error.
static java.lang.String	EXTRA_EXCEPTION The extra string that used to store an LiAuthorizationException in an intent by toIntent().
protected static java.lang.String	KEY_CODE
protected static java.lang.String	KEY_ERROR
protected static java.lang.String	KEY_ERROR_DESCRIPTION
protected static java.lang.String	KEY_ERROR_URI
protected static java.lang.String	KEY_TYPE
static java.lang.String	PARAM_ERROR The OAuth2 parameter used to indicate the type of error during an authorization or token request.
static java.lang.String	PARAM_ERROR_DESCRIPTION The OAuth2 parameter used to provide a human readable description of the error which occurred.
static java.lang.String	PARAM_ERROR_URI The OAuth2 parameter used to provide a URI to a human-readable page which describes the error.
int	type The type of the error.
static int	TYPE_GENERAL_ERROR The error type used for all errors that are not specific to OAuth related responses.
static int	TYPE_OAUTH_AUTHORIZATION_ERROR The error type for OAuth specific errors on the authorization endpoint.
static int	TYPE_OAUTH_REGISTRATION_ERROR The error type for OAuth specific errors on the registration endpoint.
static int	TYPE_OAUTH_TOKEN_ERROR The error type for OAuth specific errors on the token endpoint.
static int	TYPE_RESOURCE_SERVER_AUTHORIZATION_ERROR The error type for authorization errors encountered out of band on the resource server.

Constructor Summary

Constructors

Constructor and Description
LiAuthorizationException(int type, int code, java.lang.String error, java.lang.String errorDescription, android.net.Uri errorUri, java.lang.Throwable rootCause) Instantiates an authorization request with optional root cause information.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Exceptions are considered to be equal if their type and code are the same; all other properties are irrelevant for comparison.
static LiAuthorizationException	fromIntent(android.content.Intent data) Extracts an LiAuthorizationException from an intent produced by toIntent().
static LiAuthorizationException	fromJson(org.json.JSONObject json) Reconstructs an LiAuthorizationException from the JSON produced by toJson().
static LiAuthorizationException	fromJson(java.lang.String jsonStr) Reconstructs an LiAuthorizationException from the JSON produced by toJsonString().
static LiAuthorizationException	fromOAuthTemplate(LiAuthorizationException ex, java.lang.String errorOverride, java.lang.String errorDescriptionOverride, android.net.Uri errorUriOverride) Creates an exception based on one of the existing values defined in LiAuthorizationException.AuthorizationRequestErrors or LiAuthorizationException.TokenRequestErrors, adding information retrieved from OAuth error response.
static LiAuthorizationException	fromTemplate(LiAuthorizationException ex, java.lang.Throwable rootCause) Creates an exception based on one of the existing values defined in LiAuthorizationException.GeneralErrors, LiAuthorizationException.AuthorizationRequestErrors or LiAuthorizationException.TokenRequestErrors, providing a root cause.
static LiAuthorizationException	generalEx(int code, java.lang.String errorDescription)
int	hashCode()
android.content.Intent	toIntent() Creates an intent from this exception.
org.json.JSONObject	toJson() Produces a JSON representation of the authorization exception, for transmission or storage.
java.lang.String	toJsonString() Provides a JSON string representation of an authorization exception, for transmission or storage.
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXTRA_EXCEPTION

public static final java.lang.String EXTRA_EXCEPTION

The extra string that used to store an LiAuthorizationException in an intent by toIntent().

See Also:

Constant Field Values

PARAM_ERROR

public static final java.lang.String PARAM_ERROR

The OAuth2 parameter used to indicate the type of error during an authorization or token request.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 4.1.2.1, "The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.2, Constant Field Values

PARAM_ERROR_DESCRIPTION

public static final java.lang.String PARAM_ERROR_DESCRIPTION

The OAuth2 parameter used to provide a human readable description of the error which occurred.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 4.1.2.1, "The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.2, Constant Field Values

PARAM_ERROR_URI

public static final java.lang.String PARAM_ERROR_URI

The OAuth2 parameter used to provide a URI to a human-readable page which describes the error.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 4.1.2.1, "The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.2, Constant Field Values

TYPE_GENERAL_ERROR

public static final int TYPE_GENERAL_ERROR

The error type used for all errors that are not specific to OAuth related responses.

See Also:

Constant Field Values

TYPE_OAUTH_AUTHORIZATION_ERROR

public static final int TYPE_OAUTH_AUTHORIZATION_ERROR

The error type for OAuth specific errors on the authorization endpoint. This error type is used when the server responds to an authorization request with an explicit OAuth error, as defined by The OAuth2 specification. If the authorization response is invalid and not explicitly an error response, another error type will be used.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 4.1.2.1, Constant Field Values

TYPE_OAUTH_TOKEN_ERROR

public static final int TYPE_OAUTH_TOKEN_ERROR

The error type for OAuth specific errors on the token endpoint. This error type is used when the server responds with HTTP 400 and an OAuth error, as defined by The OAuth2 specification. If an HTTP 400 response does not parse as an OAuth error (i.e. no 'error' field is present or the JSON is invalid), another error domain will be used.

See Also:

Constant Field Values

TYPE_RESOURCE_SERVER_AUTHORIZATION_ERROR

public static final int TYPE_RESOURCE_SERVER_AUTHORIZATION_ERROR

The error type for authorization errors encountered out of band on the resource server.

See Also:

Constant Field Values

TYPE_OAUTH_REGISTRATION_ERROR

public static final int TYPE_OAUTH_REGISTRATION_ERROR

The error type for OAuth specific errors on the registration endpoint.

See Also:

Constant Field Values

KEY_TYPE

protected static final java.lang.String KEY_TYPE

See Also:

Constant Field Values

KEY_CODE

protected static final java.lang.String KEY_CODE

See Also:

Constant Field Values

KEY_ERROR

protected static final java.lang.String KEY_ERROR

See Also:

Constant Field Values

KEY_ERROR_DESCRIPTION

protected static final java.lang.String KEY_ERROR_DESCRIPTION

See Also:

Constant Field Values

KEY_ERROR_URI

protected static final java.lang.String KEY_ERROR_URI

See Also:

Constant Field Values

type

public final int type

The type of the error.

See Also:

TYPE_GENERAL_ERROR, TYPE_OAUTH_AUTHORIZATION_ERROR, TYPE_OAUTH_TOKEN_ERROR, TYPE_RESOURCE_SERVER_AUTHORIZATION_ERROR

code

public final int code

The error code describing the class of problem encountered from the set defined in this class.

error

public final java.lang.String error

The error string as it is found in the OAuth2 protocol.

errorDescription

public final java.lang.String errorDescription

The human readable error message associated with this exception, if available.

errorUri

public final android.net.Uri errorUri

A URI identifying a human-readable web page with information about this error.

Constructor Detail

LiAuthorizationException

public LiAuthorizationException(int type,
                                int code,
                                java.lang.String error,
                                java.lang.String errorDescription,
                                android.net.Uri errorUri,
                                java.lang.Throwable rootCause)

Instantiates an authorization request with optional root cause information.

Method Detail

generalEx

public static LiAuthorizationException generalEx(int code,
                                                 java.lang.String errorDescription)

fromTemplate

public static LiAuthorizationException fromTemplate(LiAuthorizationException ex,
                                                    java.lang.Throwable rootCause)

Creates an exception based on one of the existing values defined in LiAuthorizationException.GeneralErrors, LiAuthorizationException.AuthorizationRequestErrors or LiAuthorizationException.TokenRequestErrors, providing a root cause.

fromOAuthTemplate

public static LiAuthorizationException fromOAuthTemplate(LiAuthorizationException ex,
                                                         java.lang.String errorOverride,
                                                         java.lang.String errorDescriptionOverride,
                                                         android.net.Uri errorUriOverride)

Creates an exception based on one of the existing values defined in LiAuthorizationException.AuthorizationRequestErrors or LiAuthorizationException.TokenRequestErrors, adding information retrieved from OAuth error response.

fromJson

public static LiAuthorizationException fromJson(java.lang.String jsonStr)
                                         throws org.json.JSONException

Reconstructs an LiAuthorizationException from the JSON produced by toJsonString().

Throws:

org.json.JSONException - if the JSON is malformed or missing required properties

fromJson

public static LiAuthorizationException fromJson(org.json.JSONObject json)
                                         throws org.json.JSONException

Reconstructs an LiAuthorizationException from the JSON produced by toJson().

Throws:

org.json.JSONException - if the JSON is malformed or missing required properties

fromIntent

public static LiAuthorizationException fromIntent(android.content.Intent data)

Extracts an LiAuthorizationException from an intent produced by toIntent(). This is used to retrieve an error response in the handler registered for a call to

toJson

public org.json.JSONObject toJson()

Produces a JSON representation of the authorization exception, for transmission or storage. This does not include any provided root cause.

toJsonString

public java.lang.String toJsonString()

Provides a JSON string representation of an authorization exception, for transmission or storage. This does not include any provided root cause.

toIntent

public android.content.Intent toIntent()

Creates an intent from this exception. Used to carry error responses to the handling activity specified in calls to

equals

public boolean equals(java.lang.Object obj)

Exceptions are considered to be equal if their type and code are the same; all other properties are irrelevant for comparison.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable