Package org.forgerock.opendj.ldap.controls

Enum Class PasswordPolicyWarningType

java.lang.Object

java.lang.Enum<PasswordPolicyWarningType>

org.forgerock.opendj.ldap.controls.PasswordPolicyWarningType

All Implemented Interfaces:

Serializable, Comparable<PasswordPolicyWarningType>, java.lang.constant.Constable

public enum PasswordPolicyWarningType
extends Enum<PasswordPolicyWarningType>

A password policy warning type as defined in draft-behera-ldap-password-policy is used to indicate the current state of a user's password. More specifically, the number of seconds before a password will expire, or the remaining number of times a user will be allowed to authenticate with an expired password.

See Also:

• PasswordPolicyRequestControl
• PasswordPolicyResponseControl
• PasswordPolicyErrorType
• draft-behera-ldap-password-policy - Password Policy for LDAP Directories

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GRACE_LOGINS_REMAINING	Indicates the remaining number of times a user will be allowed to authenticate with an expired password.
TIME_BEFORE_EXPIRATION	Indicates the number of seconds before a password will expire.

Method Summary

Modifier and Type	Method	Description
String	toString()
static PasswordPolicyWarningType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PasswordPolicyWarningType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TIME_BEFORE_EXPIRATION

public static final PasswordPolicyWarningType TIME_BEFORE_EXPIRATION

Indicates the number of seconds before a password will expire.

GRACE_LOGINS_REMAINING

public static final PasswordPolicyWarningType GRACE_LOGINS_REMAINING

Indicates the remaining number of times a user will be allowed to authenticate with an expired password.

Method Details

values

public static PasswordPolicyWarningType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PasswordPolicyWarningType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<PasswordPolicyWarningType>