org.opends.server.controls
Enum PasswordPolicyErrorType

java.lang.Object
  extended by java.lang.Enum<PasswordPolicyErrorType>
      extended by org.opends.server.controls.PasswordPolicyErrorType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PasswordPolicyErrorType>

public enum PasswordPolicyErrorType
extends java.lang.Enum<PasswordPolicyErrorType>

This enumeration defines the set of password policy errors that may be included in the password policy response control defined in draft-behera-ldap-password-policy.


Enum Constant Summary
ACCOUNT_LOCKED
          The error type that will be used to indicate that the user's account is locked.
CHANGE_AFTER_RESET
          The error type that will be used to indicate that the user's password must be changed because it has been administratively reset.
INSUFFICIENT_PASSWORD_QUALITY
          The error type that will be used to indicate that the provided password is not acceptable according to the configured password validators.
MUST_SUPPLY_OLD_PASSWORD
          The error type that will be used to indicate that the user's current password must be provided in order to choose a new password.
PASSWORD_EXPIRED
          The error type that will be used to indicate that the user's password is expired.
PASSWORD_IN_HISTORY
          The error type that will be used to indicate that the provided password is in the user's password history.
PASSWORD_MOD_NOT_ALLOWED
          The error type that will be used to indicate that user password changes are not allowed.
PASSWORD_TOO_SHORT
          The error type that will be used to indicate that the provided password is too short.
PASSWORD_TOO_YOUNG
          The error type that will be used to indicate that the user's password is too young (i.e., it was changed too recently to allow it to be changed again).
 
Field Summary
static int TYPE_ACCOUNT_LOCKED
          The value that will be used for the accountLocked type.
static int TYPE_CHANGE_AFTER_RESET
          The value that will be used for the changeAfterReset type.
static int TYPE_INSUFFICIENT_PASSWORD_QUALITY
          The value that will be used for the insufficientPasswordQuality type.
static int TYPE_MUST_SUPPLY_OLD_PASSWORD
          The value that will be used for the mustSupplyOldPassword type.
static int TYPE_PASSWORD_EXPIRED
          The value that will be used for the passwordExpired type.
static int TYPE_PASSWORD_IN_HISTORY
          The value that will be used for the passwordInHistory type.
static int TYPE_PASSWORD_MOD_NOT_ALLOWED
          The value that will be used for the passwordModNotAllowed type.
static int TYPE_PASSWORD_TOO_SHORT
          The value that will be used for the passwordTooShort type.
static int TYPE_PASSWORD_TOO_YOUNG
          The value that will be used for the passwordTooYoung type.
 
Method Summary
 int intValue()
          Retrieves the integer value associated with the error type to use in the associated enumerated element in the password policy response control.
 java.lang.String toString()
          Retrieves a string representation of this password policy error type.
static PasswordPolicyErrorType valueOf(int value)
          Retrieves the password policy error type for the provided integer value.
static PasswordPolicyErrorType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PasswordPolicyErrorType[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

PASSWORD_EXPIRED

public static final PasswordPolicyErrorType PASSWORD_EXPIRED
The error type that will be used to indicate that the user's password is expired.


ACCOUNT_LOCKED

public static final PasswordPolicyErrorType ACCOUNT_LOCKED
The error type that will be used to indicate that the user's account is locked.


CHANGE_AFTER_RESET

public static final PasswordPolicyErrorType CHANGE_AFTER_RESET
The error type that will be used to indicate that the user's password must be changed because it has been administratively reset.


PASSWORD_MOD_NOT_ALLOWED

public static final PasswordPolicyErrorType PASSWORD_MOD_NOT_ALLOWED
The error type that will be used to indicate that user password changes are not allowed.


MUST_SUPPLY_OLD_PASSWORD

public static final PasswordPolicyErrorType MUST_SUPPLY_OLD_PASSWORD
The error type that will be used to indicate that the user's current password must be provided in order to choose a new password.


INSUFFICIENT_PASSWORD_QUALITY

public static final PasswordPolicyErrorType INSUFFICIENT_PASSWORD_QUALITY
The error type that will be used to indicate that the provided password is not acceptable according to the configured password validators.


PASSWORD_TOO_SHORT

public static final PasswordPolicyErrorType PASSWORD_TOO_SHORT
The error type that will be used to indicate that the provided password is too short.


PASSWORD_TOO_YOUNG

public static final PasswordPolicyErrorType PASSWORD_TOO_YOUNG
The error type that will be used to indicate that the user's password is too young (i.e., it was changed too recently to allow it to be changed again).


PASSWORD_IN_HISTORY

public static final PasswordPolicyErrorType PASSWORD_IN_HISTORY
The error type that will be used to indicate that the provided password is in the user's password history.

Field Detail

TYPE_PASSWORD_EXPIRED

public static final int TYPE_PASSWORD_EXPIRED
The value that will be used for the passwordExpired type.

See Also:
Constant Field Values

TYPE_ACCOUNT_LOCKED

public static final int TYPE_ACCOUNT_LOCKED
The value that will be used for the accountLocked type.

See Also:
Constant Field Values

TYPE_CHANGE_AFTER_RESET

public static final int TYPE_CHANGE_AFTER_RESET
The value that will be used for the changeAfterReset type.

See Also:
Constant Field Values

TYPE_PASSWORD_MOD_NOT_ALLOWED

public static final int TYPE_PASSWORD_MOD_NOT_ALLOWED
The value that will be used for the passwordModNotAllowed type.

See Also:
Constant Field Values

TYPE_MUST_SUPPLY_OLD_PASSWORD

public static final int TYPE_MUST_SUPPLY_OLD_PASSWORD
The value that will be used for the mustSupplyOldPassword type.

See Also:
Constant Field Values

TYPE_INSUFFICIENT_PASSWORD_QUALITY

public static final int TYPE_INSUFFICIENT_PASSWORD_QUALITY
The value that will be used for the insufficientPasswordQuality type.

See Also:
Constant Field Values

TYPE_PASSWORD_TOO_SHORT

public static final int TYPE_PASSWORD_TOO_SHORT
The value that will be used for the passwordTooShort type.

See Also:
Constant Field Values

TYPE_PASSWORD_TOO_YOUNG

public static final int TYPE_PASSWORD_TOO_YOUNG
The value that will be used for the passwordTooYoung type.

See Also:
Constant Field Values

TYPE_PASSWORD_IN_HISTORY

public static final int TYPE_PASSWORD_IN_HISTORY
The value that will be used for the passwordInHistory type.

See Also:
Constant Field Values
Method Detail

values

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

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

valueOf

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

intValue

public int intValue()
Retrieves the integer value associated with the error type to use in the associated enumerated element in the password policy response control.

Returns:
The integer value associated with the error type to use in the associated enumerated element in the password policy response control.

valueOf

public static PasswordPolicyErrorType valueOf(int value)
Retrieves the password policy error type for the provided integer value.

Parameters:
value - The value for which to retrieve the corresponding error type.
Returns:
The requested password policy error type, or null if the provided value does not match any error types.

toString

public java.lang.String toString()
Retrieves a string representation of this password policy error type.

Overrides:
toString in class java.lang.Enum<PasswordPolicyErrorType>
Returns:
A string representation of this password policy error type.