AuthorizationException (AppAuth for Android)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - net.openid.appauth.AuthorizationException

All Implemented Interfaces:

java.io.Serializable
```
public final class AuthorizationException
extends java.lang.Exception
```
Returned as a response to OAuth2 requests if they fail. Specifically:
- The response to token requests,
- The response to configuration retrieval.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuthorizationException.AuthorizationRequestErrors` Error codes related to failed authorization requests.
`static class`	`AuthorizationException.GeneralErrors` Error codes specific to AppAuth for Android, rather than those defined in the OAuth2 and OpenID specifications.
`static class`	`AuthorizationException.RegistrationRequestErrors` Error codes related to failed registration requests.
`static class`	`AuthorizationException.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 `AuthorizationException` in an intent by `toIntent()`.
`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
`AuthorizationException(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

All Methods Static Methods Instance Methods Concrete Methods
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 AuthorizationException`	`fromIntent(android.content.Intent data)` Extracts an `AuthorizationException` from an intent produced by `toIntent()`.
`static AuthorizationException`	`fromJson(org.json.JSONObject json)` Reconstructs an `AuthorizationException` from the JSON produced by `toJson()`.
`static AuthorizationException`	`fromJson(java.lang.String jsonStr)` Reconstructs an `AuthorizationException` from the JSON produced by `toJsonString()`.
`static AuthorizationException`	`fromOAuthRedirect(android.net.Uri redirectUri)` Creates an exception from an OAuth redirect URI that describes an authorization failure.
`static AuthorizationException`	`fromOAuthTemplate(AuthorizationException 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 `AuthorizationException.AuthorizationRequestErrors` or `AuthorizationException.TokenRequestErrors`, adding information retrieved from OAuth error response.
`static AuthorizationException`	`fromTemplate(AuthorizationException ex, java.lang.Throwable rootCause)` Creates an exception based on one of the existing values defined in `AuthorizationException.GeneralErrors`, `AuthorizationException.AuthorizationRequestErrors` or `AuthorizationException.TokenRequestErrors`, providing a root cause.
`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 AuthorizationException 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, section 4.1.2.1. 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, section 5.2. 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:
    
    The OAuth 2.0 Authorization Framework" (RFC 6749), Section 5.2, 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
  - 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
```
@Nullable
public final java.lang.String error
```
    The error string as it is found in the OAuth2 protocol.
  - errorDescription
```
@Nullable
public final java.lang.String errorDescription
```
    The human readable error message associated with this exception, if available.
  - errorUri
```
@Nullable
public final android.net.Uri errorUri
```
    A URI identifying a human-readable web page with information about this error.
- Constructor Detail
  - AuthorizationException
```
public AuthorizationException(int type,
                              int code,
                              @Nullable
                              java.lang.String error,
                              @Nullable
                              java.lang.String errorDescription,
                              @Nullable
                              android.net.Uri errorUri,
                              @Nullable
                              java.lang.Throwable rootCause)
```
    Instantiates an authorization request with optional root cause information.
- Method Detail
  - fromTemplate
```
public static AuthorizationException fromTemplate(@NonNull
                                                  AuthorizationException ex,
                                                  @Nullable
                                                  java.lang.Throwable rootCause)
```
    Creates an exception based on one of the existing values defined in AuthorizationException.GeneralErrors, AuthorizationException.AuthorizationRequestErrors or AuthorizationException.TokenRequestErrors, providing a root cause.
  - fromOAuthTemplate
```
public static AuthorizationException fromOAuthTemplate(@NonNull
                                                       AuthorizationException ex,
                                                       @Nullable
                                                       java.lang.String errorOverride,
                                                       @Nullable
                                                       java.lang.String errorDescriptionOverride,
                                                       @Nullable
                                                       android.net.Uri errorUriOverride)
```
    Creates an exception based on one of the existing values defined in AuthorizationException.AuthorizationRequestErrors or AuthorizationException.TokenRequestErrors, adding information retrieved from OAuth error response.
  - fromOAuthRedirect
```
public static AuthorizationException fromOAuthRedirect(@NonNull
                                                       android.net.Uri redirectUri)
```
    Creates an exception from an OAuth redirect URI that describes an authorization failure.
  - fromJson
```
public static AuthorizationException fromJson(@NonNull
                                              java.lang.String jsonStr)
                                       throws org.json.JSONException
```
    Reconstructs an AuthorizationException from the JSON produced by toJsonString().
    
    Throws:
    
    org.json.JSONException - if the JSON is malformed or missing required properties
  - fromJson
```
public static AuthorizationException fromJson(@NonNull
                                              org.json.JSONObject json)
                                       throws org.json.JSONException
```
    Reconstructs an AuthorizationException from the JSON produced by toJson().
    
    Throws:
    
    org.json.JSONException - if the JSON is malformed or missing required properties
  - fromIntent
```
@Nullable
public static AuthorizationException fromIntent(android.content.Intent data)
```
    Extracts an AuthorizationException from an intent produced by toIntent(). This is used to retrieve an error response in the handler registered for a call to AuthorizationService.performAuthorizationRequest(net.openid.appauth.AuthorizationRequest, android.app.PendingIntent).
  - toJson
```
@NonNull
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
```
@NonNull
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
```
@NonNull
public android.content.Intent toIntent()
```
    Creates an intent from this exception. Used to carry error responses to the handling activity specified in calls to AuthorizationService.performAuthorizationRequest(net.openid.appauth.AuthorizationRequest, android.app.PendingIntent).
  - 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

Class AuthorizationException

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

EXTRA_EXCEPTION

PARAM_ERROR

PARAM_ERROR_DESCRIPTION

PARAM_ERROR_URI

TYPE_GENERAL_ERROR

TYPE_OAUTH_AUTHORIZATION_ERROR

TYPE_OAUTH_TOKEN_ERROR

TYPE_RESOURCE_SERVER_AUTHORIZATION_ERROR

TYPE_OAUTH_REGISTRATION_ERROR

type

code

error

errorDescription

errorUri

Constructor Detail

AuthorizationException

Method Detail

fromTemplate

fromOAuthTemplate

fromOAuthRedirect

fromJson

fromJson

fromIntent

toJson

toJsonString

toIntent

equals

hashCode

toString