ActiveDirectoryAccountState.Error (Ldaptive 1.2.4 API)

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

All Implemented Interfaces:

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

Enclosing class:

ActiveDirectoryAccountState
```
public static enum ActiveDirectoryAccountState.Error
extends Enum<ActiveDirectoryAccountState.Error>
implements AccountState.Error
```
Enum to define active directory errors. See http://ldapwiki.willeke.com/wiki/ Common%20Active%20Directory%20Bind%20Errors

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACCOUNT_DISABLED` account disabled.
`ACCOUNT_EXPIRED` account expired.
`ACCOUNT_LOCKED_OUT` account locked out.
`INVALID_LOGON_HOURS` invalid logon hours.
`INVALID_WORKSTATION` invalid workstation.
`LOGON_FAILURE` logon failure.
`NO_SUCH_USER` no such user.
`PASSWORD_EXPIRED` password expired.
`PASSWORD_MUST_CHANGE` password must change.

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`code` underlying error code.
`private static int`	`HEX_RADIX` hex radix for hex to decimal conversion.
`private static Pattern`	`PATTERN` pattern to find hex code in active directory messages.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCode()` Returns the error code.
`String`	`getMessage()` Returns the error message.
`static ActiveDirectoryAccountState.Error`	`parse(String message)` Parses the supplied error messages and returns the corresponding error enum.
`void`	`throwSecurityException()` Throws the LoginException that best maps to this error.
`static ActiveDirectoryAccountState.Error`	`valueOf(int code)` Returns the error for the supplied integer constant.
`static ActiveDirectoryAccountState.Error`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ActiveDirectoryAccountState.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
  - NO_SUCH_USER
```
public static final ActiveDirectoryAccountState.Error NO_SUCH_USER
```
    no such user. 0x525.
  - LOGON_FAILURE
```
public static final ActiveDirectoryAccountState.Error LOGON_FAILURE
```
    logon failure. 0x52e.
  - INVALID_LOGON_HOURS
```
public static final ActiveDirectoryAccountState.Error INVALID_LOGON_HOURS
```
    invalid logon hours. 0x530.
  - INVALID_WORKSTATION
```
public static final ActiveDirectoryAccountState.Error INVALID_WORKSTATION
```
    invalid workstation. 0x531.
  - PASSWORD_EXPIRED
```
public static final ActiveDirectoryAccountState.Error PASSWORD_EXPIRED
```
    password expired. 0x532.
  - ACCOUNT_DISABLED
```
public static final ActiveDirectoryAccountState.Error ACCOUNT_DISABLED
```
    account disabled. 0x533.
  - ACCOUNT_EXPIRED
```
public static final ActiveDirectoryAccountState.Error ACCOUNT_EXPIRED
```
    account expired. 0x701.
  - PASSWORD_MUST_CHANGE
```
public static final ActiveDirectoryAccountState.Error PASSWORD_MUST_CHANGE
```
    password must change. 0x773.
  - ACCOUNT_LOCKED_OUT
```
public static final ActiveDirectoryAccountState.Error ACCOUNT_LOCKED_OUT
```
    account locked out. 0x775.
- Field Detail
  - HEX_RADIX
```
private static final int HEX_RADIX
```
    hex radix for hex to decimal conversion.
    
    See Also:
    
    Constant Field Values
  - PATTERN
```
private static final Pattern PATTERN
```
    pattern to find hex code in active directory messages.
  - code
```
private final int code
```
    underlying error code.
- Method Detail
  - values
```
public static ActiveDirectoryAccountState.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 (ActiveDirectoryAccountState.Error c : ActiveDirectoryAccountState.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 ActiveDirectoryAccountState.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()
```
    Description copied from interface: AccountState.Error
    
    Returns the error code.
    
    Specified by:
    
    getCode in interface AccountState.Error
    
    Returns:
    
    error code
  - getMessage
```
public String getMessage()
```
    Description copied from interface: AccountState.Error
    
    Returns the error message.
    
    Specified by:
    
    getMessage in interface AccountState.Error
    
    Returns:
    
    error message
  - throwSecurityException
```
public void throwSecurityException()
                            throws LoginException
```
    Description copied from interface: AccountState.Error
    
    Throws the LoginException that best maps to this error.
    
    Specified by:
    
    throwSecurityException in interface AccountState.Error
    
    Throws:
    
    LoginException - for this account state error
  - valueOf
```
public static ActiveDirectoryAccountState.Error valueOf(int code)
```
    Returns the error for the supplied integer constant.
    
    Parameters:
    
    code - to find error for
    
    Returns:
    
    error
  - parse
```
public static ActiveDirectoryAccountState.Error parse(String message)
```
    Parses the supplied error messages and returns the corresponding error enum. Attempts to find PATTERN and parses the first group match as a hexadecimal integer.
    
    Parameters:
    
    message - to parse
    
    Returns:
    
    active directory error

Enum ActiveDirectoryAccountState.Error

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NO_SUCH_USER

LOGON_FAILURE

INVALID_LOGON_HOURS

INVALID_WORKSTATION

PASSWORD_EXPIRED

ACCOUNT_DISABLED

ACCOUNT_EXPIRED

PASSWORD_MUST_CHANGE

ACCOUNT_LOCKED_OUT

Field Detail

HEX_RADIX

PATTERN

code

Method Detail

values

valueOf

getCode

getMessage

throwSecurityException

valueOf

parse