com.highdeal.cnd.message

Enum IAuthenticationListener.Reason

java.lang.Object

java.lang.Enum<IAuthenticationListener.Reason>

com.highdeal.cnd.message.IAuthenticationListener.Reason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IAuthenticationListener.Reason>

Enclosing interface:

IAuthenticationListener

public static enum IAuthenticationListener.Reason
extends java.lang.Enum<IAuthenticationListener.Reason>

This enumeration lists the possible reasons for the message authentication exception.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL_NOT_ALLOWED User is not allowed to use this communication channel
INVALID_LOGIN_OR_PASSWORD Login or password are invalid
INVALID_ROLE User does not have the required role
LOCKED_USER User account is locked
NOT_ALLOWED Authentication is not expected

Method Summary

Modifier and Type	Method and Description
int	getNumericalId() Gets the numerical identifier of the reason.
static IAuthenticationListener.Reason	getReasonFromId(int id) Gets the reason from the identifier.
static IAuthenticationListener.Reason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IAuthenticationListener.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

INVALID_LOGIN_OR_PASSWORD

public static final IAuthenticationListener.Reason INVALID_LOGIN_OR_PASSWORD

Login or password are invalid

INVALID_ROLE

public static final IAuthenticationListener.Reason INVALID_ROLE

User does not have the required role

LOCKED_USER

public static final IAuthenticationListener.Reason LOCKED_USER

User account is locked

CHANNEL_NOT_ALLOWED

public static final IAuthenticationListener.Reason CHANNEL_NOT_ALLOWED

User is not allowed to use this communication channel

NOT_ALLOWED

public static final IAuthenticationListener.Reason NOT_ALLOWED

Authentication is not expected

Method Detail

values

public static IAuthenticationListener.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 (IAuthenticationListener.Reason c : IAuthenticationListener.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 IAuthenticationListener.Reason 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

getNumericalId

public int getNumericalId()

Gets the numerical identifier of the reason.

Returns:

the numerical identifier of the reason

getReasonFromId

public static final IAuthenticationListener.Reason getReasonFromId(int id)

Gets the reason from the identifier.

Parameters:

id - the identifier from which the reason must be retrieved

Returns:

the reason