Package nl.gx.webmanager.authorization

Enum AuthorizationService.LoginStatus

java.lang.Object

java.lang.Enum<AuthorizationService.LoginStatus>

nl.gx.webmanager.authorization.AuthorizationService.LoginStatus

All Implemented Interfaces:

Serializable, Comparable<AuthorizationService.LoginStatus>

Enclosing interface:

AuthorizationService

public static enum AuthorizationService.LoginStatus
extends Enum<AuthorizationService.LoginStatus>

The response (state) during a login attempt. After a AuthorizationService.formLogin(String, String, HttpServletRequest) this AuthorizationService.LoginStatus represents the status of the login.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANGE_PASSWORD	A password change is required to complete login
CHANGE_PASSWORD_DO_NOT_MATCH	The password update failed, because the retyped password is different
ERROR	An unexpected error occurred
FAIL	Failed to login in: incorrect credentials, permissions, etc
SUCCESS	User logged in successfully
TOKEN_REQUIRED	A 2FA token is required to complete login

Method Summary

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

ERROR

public static final AuthorizationService.LoginStatus ERROR

An unexpected error occurred

SUCCESS

public static final AuthorizationService.LoginStatus SUCCESS

User logged in successfully

FAIL

public static final AuthorizationService.LoginStatus FAIL

Failed to login in: incorrect credentials, permissions, etc

TOKEN_REQUIRED

public static final AuthorizationService.LoginStatus TOKEN_REQUIRED

A 2FA token is required to complete login

CHANGE_PASSWORD

public static final AuthorizationService.LoginStatus CHANGE_PASSWORD

A password change is required to complete login

CHANGE_PASSWORD_DO_NOT_MATCH

public static final AuthorizationService.LoginStatus CHANGE_PASSWORD_DO_NOT_MATCH

The password update failed, because the retyped password is different

Method Detail

values

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

Returns:

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

valueOf

public static AuthorizationService.LoginStatus 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