com.belladati.sdk.exception.auth

Enum AuthorizationException.Reason

java.lang.Object

java.lang.Enum<AuthorizationException.Reason>

com.belladati.sdk.exception.auth.AuthorizationException.Reason

All Implemented Interfaces:

Serializable, Comparable<AuthorizationException.Reason>

Enclosing class:

AuthorizationException

public static enum AuthorizationException.Reason
extends Enum<AuthorizationException.Reason>

Possible causes of an AuthorizationException. When dealing with an AuthorizationException, use its reason to display an appropriate message to the user.

Note: As of BellaDati 2.7.6, not all reasons are currently supported by the server.

Author:

Chris Hennigfeld

Enum Constant Summary

Enum Constants

Enum Constant and Description
BD_MOBILE_DISABLED BellaDati Mobile only: BellaDati Mobile access isn't enabled for the domain.
CONSUMER_KEY_UNKNOWN Consumer key doesn't exist on the server.
CONSUMER_SECRET_INVALID Consumer secret doesn't match the consumer key.
DOMAIN_EXPIRED Domain license has expired.
OTHER An uncategorized error occurred.
TIMESTAMP_REFUSED Timestamp doesn't match the server's time.
TOKEN_EXPIRED Request or access token has expired, requires re-authentication.
TOKEN_INVALID Request or access token is invalid, may require re-authentication.
TOKEN_UNAUTHORIZED Request token hasn't been authorized.
USER_ACCOUNT_LOCKED xAuth only: credentials are correct but user is locked.
USER_CREDENTIALS_INVALID xAuth only: username doesn't exist or password was incorrect.
USER_DOMAIN_MISMATCH xAuth only: credentials are correct but user isn't in the domain.
X_AUTH_DISABLED xAuth only: xAuth isn't enabled for the domain.

Method Summary

Methods

Modifier and Type	Method and Description
String	getMessage() Returns an English-language description of this reason.
static AuthorizationException.Reason	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthorizationException.Reason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONSUMER_KEY_UNKNOWN

public static final AuthorizationException.Reason CONSUMER_KEY_UNKNOWN

Consumer key doesn't exist on the server.

CONSUMER_SECRET_INVALID

public static final AuthorizationException.Reason CONSUMER_SECRET_INVALID

Consumer secret doesn't match the consumer key.

DOMAIN_EXPIRED

public static final AuthorizationException.Reason DOMAIN_EXPIRED

Domain license has expired.

TOKEN_INVALID

public static final AuthorizationException.Reason TOKEN_INVALID

Request or access token is invalid, may require re-authentication.

TOKEN_UNAUTHORIZED

public static final AuthorizationException.Reason TOKEN_UNAUTHORIZED

Request token hasn't been authorized.

TOKEN_EXPIRED

public static final AuthorizationException.Reason TOKEN_EXPIRED

Request or access token has expired, requires re-authentication.

TIMESTAMP_REFUSED

public static final AuthorizationException.Reason TIMESTAMP_REFUSED

Timestamp doesn't match the server's time. This exception is an instance of InvalidTimestampException, cast to get accepted timestamp range.

USER_CREDENTIALS_INVALID

public static final AuthorizationException.Reason USER_CREDENTIALS_INVALID

xAuth only: username doesn't exist or password was incorrect.

USER_ACCOUNT_LOCKED

public static final AuthorizationException.Reason USER_ACCOUNT_LOCKED

xAuth only: credentials are correct but user is locked.

USER_DOMAIN_MISMATCH

public static final AuthorizationException.Reason USER_DOMAIN_MISMATCH

xAuth only: credentials are correct but user isn't in the domain.

X_AUTH_DISABLED

public static final AuthorizationException.Reason X_AUTH_DISABLED

xAuth only: xAuth isn't enabled for the domain.

BD_MOBILE_DISABLED

public static final AuthorizationException.Reason BD_MOBILE_DISABLED

BellaDati Mobile only: BellaDati Mobile access isn't enabled for the domain.

OTHER

public static final AuthorizationException.Reason OTHER

An uncategorized error occurred. Refer to the exception's message for details.

Method Detail

values

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

Returns:

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

valueOf

public static AuthorizationException.Reason 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

getMessage

public String getMessage()

Returns an English-language description of this reason.

Returns:

an English-language description of this reason