org.cyclos.model.access.identityproviders

Enum IdentityProviderCallbackStatus

java.lang.Object

java.lang.Enum<IdentityProviderCallbackStatus>

org.cyclos.model.access.identityproviders.IdentityProviderCallbackStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IdentityProviderCallbackStatus>

public enum IdentityProviderCallbackStatus
extends java.lang.Enum<IdentityProviderCallbackStatus>

The possible outcomes of an identity provider callback

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
DENIED The user has denied the request
ERROR An error.
LINKED The provider was linked to the currently authenticated user
LOGIN_EMAIL Successful login, and the user was not previously linked to the provider, but was matched by e-mail.
LOGIN_LINK Successful login, and the user was previously linked to the provider
LOGIN_NO_EMAIL No matching user was found for this provider, and no e-mail could be read from the provider.
LOGIN_NO_MATCH No matching user was found for this provider, neither by id nor e-mail.
REGISTRATION_DATA The profile data was read, and is available to get data for filling up the registration form
REGISTRATION_DONE The profile data was read, the user has been directly registered and a session has been created for the user.

Method Summary

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

LOGIN_LINK

public static final IdentityProviderCallbackStatus LOGIN_LINK

Successful login, and the user was previously linked to the provider

LOGIN_EMAIL

public static final IdentityProviderCallbackStatus LOGIN_EMAIL

Successful login, and the user was not previously linked to the provider, but was matched by e-mail. The link was automatically created.

LOGIN_NO_MATCH

public static final IdentityProviderCallbackStatus LOGIN_NO_MATCH

No matching user was found for this provider, neither by id nor e-mail. On the next login, if the user posts together the 'requestId' value and it matches a previously authenticated user, a link was automatically created.

LOGIN_NO_EMAIL

public static final IdentityProviderCallbackStatus LOGIN_NO_EMAIL

No matching user was found for this provider, and no e-mail could be read from the provider. On the next login, if the user posts together the 'requestId' and it matches a previously authenticated user, a link was automatically created.

REGISTRATION_DATA

public static final IdentityProviderCallbackStatus REGISTRATION_DATA

The profile data was read, and is available to get data for filling up the registration form

REGISTRATION_DONE

public static final IdentityProviderCallbackStatus REGISTRATION_DONE

The profile data was read, the user has been directly registered and a session has been created for the user.

LINKED

public static final IdentityProviderCallbackStatus LINKED

The provider was linked to the currently authenticated user

DENIED

public static final IdentityProviderCallbackStatus DENIED

The user has denied the request

ERROR

public static final IdentityProviderCallbackStatus ERROR

An error. An error message will be returned.

Method Detail

values

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

Returns:

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

valueOf

public static IdentityProviderCallbackStatus valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null