org.ldaptive.auth.ext
Enum PasswordExpirationAccountState.Error

java.lang.Object
  java.lang.Enum<PasswordExpirationAccountState.Error>
      org.ldaptive.auth.ext.PasswordExpirationAccountState.Error

All Implemented Interfaces:

Serializable, Comparable<PasswordExpirationAccountState.Error>, AccountState.Error

Enclosing class:

PasswordExpirationAccountState

public static enum PasswordExpirationAccountState.Error
extends Enum<PasswordExpirationAccountState.Error>
implements AccountState.Error

Enum to define password expiration error.

Enum Constant Summary

PASSWORD_EXPIRED
password expired.

Method Summary

int	getCode() Returns the error code.
String	getMessage() Returns the error message.
void	throwSecurityException() Throws the LoginException that best maps to this error.
static PasswordExpirationAccountState.Error	valueOf(String name) Returns the enum constant of this type with the specified name.
static PasswordExpirationAccountState.Error[]	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

PASSWORD_EXPIRED

public static final PasswordExpirationAccountState.Error PASSWORD_EXPIRED

password expired.

Method Detail

values

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

Returns:

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

valueOf

public static PasswordExpirationAccountState.Error 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

getCode

public int getCode()

Returns the error code.

Specified by:

getCode in interface AccountState.Error

Returns:

error code

getMessage

public String getMessage()

Returns the error message.

Specified by:

getMessage in interface AccountState.Error

Returns:

error message

throwSecurityException

public void throwSecurityException()
                            throws LoginException

Throws the LoginException that best maps to this error.

Specified by:

throwSecurityException in interface AccountState.Error

Throws:

LoginException - for this account state error