Enum PasswordPolicyErrorType
- java.lang.Object
-
- java.lang.Enum<PasswordPolicyErrorType>
-
- com.unboundid.ldap.sdk.unboundidds.controls.PasswordPolicyErrorType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<PasswordPolicyErrorType>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum PasswordPolicyErrorType extends java.lang.Enum<PasswordPolicyErrorType>
This enum defines a set of error types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCOUNT_LOCKED
The error type that indicates the user's account is locked or disabled.CHANGE_AFTER_RESET
The error type that indicates the user's password must be changed before any other operation will be allowed.INSUFFICIENT_PASSWORD_QUALITY
The error type that indicates the proposed password is too weak to be acceptable.MUST_SUPPLY_OLD_PASSWORD
The error type that indicates the user must provide the current password when attempting to set a new one.PASSWORD_EXPIRED
The error type that indicates the user's password is expired.PASSWORD_IN_HISTORY
The error type that indicates the proposed password is already in the password history.PASSWORD_MOD_NOT_ALLOWED
The error type that indicates that user password changes aren't allowed.PASSWORD_TOO_SHORT
The error type that indicates the proposed password is too short.PASSWORD_TOO_YOUNG
The error type that indicates the user's password cannot be changed because it has not been long enough since it was last changed.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PasswordPolicyErrorType
forName(java.lang.String name)
Retrieves the password policy error type with the specified name.java.lang.String
getName()
Retrieves the human-readable name for this password policy error type.int
intValue()
Retrieves the integer value for this password policy error type.java.lang.String
toString()
Retrieves a string representation for this password policy error type.static PasswordPolicyErrorType
valueOf(int intValue)
Retrieves the password policy error type with the specified int 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.
-
-
-
Enum Constant Detail
-
PASSWORD_EXPIRED
public static final PasswordPolicyErrorType PASSWORD_EXPIRED
The error type that indicates the user's password is expired.
-
ACCOUNT_LOCKED
public static final PasswordPolicyErrorType ACCOUNT_LOCKED
The error type that indicates the user's account is locked or disabled.
-
CHANGE_AFTER_RESET
public static final PasswordPolicyErrorType CHANGE_AFTER_RESET
The error type that indicates the user's password must be changed before any other operation will be allowed.
-
PASSWORD_MOD_NOT_ALLOWED
public static final PasswordPolicyErrorType PASSWORD_MOD_NOT_ALLOWED
The error type that indicates that user password changes aren't allowed.
-
MUST_SUPPLY_OLD_PASSWORD
public static final PasswordPolicyErrorType MUST_SUPPLY_OLD_PASSWORD
The error type that indicates the user must provide the current password when attempting to set a new one.
-
INSUFFICIENT_PASSWORD_QUALITY
public static final PasswordPolicyErrorType INSUFFICIENT_PASSWORD_QUALITY
The error type that indicates the proposed password is too weak to be acceptable.
-
PASSWORD_TOO_SHORT
public static final PasswordPolicyErrorType PASSWORD_TOO_SHORT
The error type that indicates the proposed password is too short.
-
PASSWORD_TOO_YOUNG
public static final PasswordPolicyErrorType PASSWORD_TOO_YOUNG
The error type that indicates the user's password cannot be changed because it has not been long enough since it was last changed.
-
PASSWORD_IN_HISTORY
public static final PasswordPolicyErrorType PASSWORD_IN_HISTORY
The error type that indicates the proposed password is already in the password history.
-
-
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 namejava.lang.NullPointerException
- if the argument is null
-
getName
public java.lang.String getName()
Retrieves the human-readable name for this password policy error type.- Returns:
- The human-readable name for this password policy error type.
-
intValue
public int intValue()
Retrieves the integer value for this password policy error type.- Returns:
- The integer value for this password policy error type.
-
valueOf
public static PasswordPolicyErrorType valueOf(int intValue)
Retrieves the password policy error type with the specified int value.- Parameters:
intValue
- The numeric value associated with the error type.- Returns:
- The associated error type, or
null
if there is no password policy error type with the specified set of values.
-
forName
public static PasswordPolicyErrorType forName(java.lang.String name)
Retrieves the password policy error type with the specified name.- Parameters:
name
- The name of the password policy error type to retrieve. It must not benull
.- Returns:
- The requested password policy error type, or
null
if no such type is defined.
-
toString
public java.lang.String toString()
Retrieves a string representation for this password policy error type.- Overrides:
toString
in classjava.lang.Enum<PasswordPolicyErrorType>
- Returns:
- A string representation for this password policy error type.
-
-