com.helger.photon.basic.security.login

Enum ELoginResult

java.lang.Object

java.lang.Enum<ELoginResult>

com.helger.photon.basic.security.login.ELoginResult

All Implemented Interfaces:

com.helger.commons.name.IHasDisplayText, com.helger.commons.state.ISuccessIndicator, Serializable, Comparable<ELoginResult>

public enum ELoginResult
extends Enum<ELoginResult>
implements com.helger.commons.state.ISuccessIndicator, com.helger.commons.name.IHasDisplayText

Represents the different login results.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID_PASSWORD The provided password is invalid
SESSION_ALREADY_HAS_USER Another user is already logged in this session
SUCCESS Login was successfully
SUCCESS_WITH_LOGOUT Login was successfully but logged out previous session
USER_ALREADY_LOGGED_IN The user was already logged in
USER_IS_DELETED User is marked as deleted
USER_IS_DISABLED User is disabled
USER_IS_MISSING_ROLE User does not have the correct role
USER_NOT_EXISTING No such user

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayText(Locale aContentLocale)
boolean	hasMessage()
boolean	isFailure()
boolean	isSuccess()
static ELoginResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static ELoginResult[]	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

SUCCESS

public static final ELoginResult SUCCESS

Login was successfully

SUCCESS_WITH_LOGOUT

public static final ELoginResult SUCCESS_WITH_LOGOUT

Login was successfully but logged out previous session

USER_NOT_EXISTING

public static final ELoginResult USER_NOT_EXISTING

No such user

USER_IS_DELETED

public static final ELoginResult USER_IS_DELETED

User is marked as deleted

USER_IS_DISABLED

public static final ELoginResult USER_IS_DISABLED

User is disabled

USER_IS_MISSING_ROLE

public static final ELoginResult USER_IS_MISSING_ROLE

User does not have the correct role

INVALID_PASSWORD

public static final ELoginResult INVALID_PASSWORD

The provided password is invalid

USER_ALREADY_LOGGED_IN

public static final ELoginResult USER_ALREADY_LOGGED_IN

The user was already logged in

SESSION_ALREADY_HAS_USER

public static final ELoginResult SESSION_ALREADY_HAS_USER

Another user is already logged in this session

Method Detail

values

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

Returns:

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

valueOf

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

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface com.helger.commons.state.ISuccessIndicator

isFailure

public boolean isFailure()

Specified by:

isFailure in interface com.helger.commons.state.ISuccessIndicator

hasMessage

public boolean hasMessage()

getDisplayText

@Nullable
public String getDisplayText(@Nonnull
                             Locale aContentLocale)

Specified by:

getDisplayText in interface com.helger.commons.name.IHasDisplayText