org.gatein.security.oauth.exception

Enum OAuthExceptionCode

java.lang.Object

java.lang.Enum<OAuthExceptionCode>

org.gatein.security.oauth.exception.OAuthExceptionCode

All Implemented Interfaces:

Serializable, Comparable<OAuthExceptionCode>

public enum OAuthExceptionCode
extends Enum<OAuthExceptionCode>

Enum with various exception codes

Author:

Marek Posolda

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_TOKEN_ERROR Error when we have invalid or revoked access token
DUPLICATE_OAUTH_PROVIDER_USERNAME This error could happen during saving of user into GateIn identity database.
FACEBOOK_ERROR Some error during Facebook processing
GOOGLE_ERROR Some error during Google processing
INVALID_STATE Error when state parameter from request parameter, which is sent from OAuth provider, is not equals to previously sent state
IO_ERROR Generic IO error (for example network error)
LINKEDIN_ERROR Some error during LinkedIn processing
PERSISTENCE_ERROR Error during DB operation (For example get/set/remove access token from DB)
TOKEN_REVOCATION_FAILED Error when revoking of accessToken of any provider failed
TWITTER_ERROR Some error during Twitter processing
UNKNOWN_ERROR Unspecified GateIn+OAuth error
USER_DENIED_SCOPE Error when OAuth2 flow failed because user denied to permit privileges (scope) for OAuth provider

Method Summary

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

UNKNOWN_ERROR

public static final OAuthExceptionCode UNKNOWN_ERROR

Unspecified GateIn+OAuth error

DUPLICATE_OAUTH_PROVIDER_USERNAME

public static final OAuthExceptionCode DUPLICATE_OAUTH_PROVIDER_USERNAME

This error could happen during saving of user into GateIn identity database. It happens when there is an attempt to save user with facebookUsername (or googleUsername), but there is already an existing user with same facebookUsername. For example: We want to save user 'john' with facebookUsername 'john.doyle' but we already have user 'johny2' with same facebookUsername 'john.doyle'

TWITTER_ERROR

public static final OAuthExceptionCode TWITTER_ERROR

Some error during Twitter processing

FACEBOOK_ERROR

public static final OAuthExceptionCode FACEBOOK_ERROR

Some error during Facebook processing

GOOGLE_ERROR

public static final OAuthExceptionCode GOOGLE_ERROR

Some error during Google processing

LINKEDIN_ERROR

public static final OAuthExceptionCode LINKEDIN_ERROR

Some error during LinkedIn processing

ACCESS_TOKEN_ERROR

public static final OAuthExceptionCode ACCESS_TOKEN_ERROR

Error when we have invalid or revoked access token

IO_ERROR

public static final OAuthExceptionCode IO_ERROR

Generic IO error (for example network error)

INVALID_STATE

public static final OAuthExceptionCode INVALID_STATE

Error when state parameter from request parameter, which is sent from OAuth provider, is not equals to previously sent state

TOKEN_REVOCATION_FAILED

public static final OAuthExceptionCode TOKEN_REVOCATION_FAILED

Error when revoking of accessToken of any provider failed

USER_DENIED_SCOPE

public static final OAuthExceptionCode USER_DENIED_SCOPE

Error when OAuth2 flow failed because user denied to permit privileges (scope) for OAuth provider

PERSISTENCE_ERROR

public static final OAuthExceptionCode PERSISTENCE_ERROR

Error during DB operation (For example get/set/remove access token from DB)

Method Detail

values

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

Returns:

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

valueOf

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