com.unboundid.ldap.sdk.unboundidds.controls
Enum PasswordPolicyWarningType

java.lang.Object
  extended by java.lang.Enum<PasswordPolicyWarningType>
      extended by com.unboundid.ldap.sdk.unboundidds.controls.PasswordPolicyWarningType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PasswordPolicyWarningType>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum PasswordPolicyWarningType
extends java.lang.Enum<PasswordPolicyWarningType>

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This enum defines a set of warning types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy.


Enum Constant Summary
GRACE_LOGINS_REMAINING
          The warning type used to indicate that the user's password is expired but that the user may have grace logins remaining, or that a grace login was used in the associated bind.
TIME_BEFORE_EXPIRATION
          The warning type used to indicate that the user's password will expire in the near future and provide the length of time until it does expire.
 
Method Summary
 java.lang.String getName()
          Retrieves the human-readable name for this password policy warning type.
 java.lang.String toString()
          Retrieves a string representation for this password policy warning type.
static PasswordPolicyWarningType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PasswordPolicyWarningType[] 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

TIME_BEFORE_EXPIRATION

public static final PasswordPolicyWarningType TIME_BEFORE_EXPIRATION
The warning type used to indicate that the user's password will expire in the near future and provide the length of time until it does expire.


GRACE_LOGINS_REMAINING

public static final PasswordPolicyWarningType GRACE_LOGINS_REMAINING
The warning type used to indicate that the user's password is expired but that the user may have grace logins remaining, or that a grace login was used in the associated bind.

Method Detail

values

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

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

valueOf

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

getName

public java.lang.String getName()
Retrieves the human-readable name for this password policy warning type.

Returns:
The human-readable name for this password policy warning type.

toString

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

Overrides:
toString in class java.lang.Enum<PasswordPolicyWarningType>
Returns:
A string representation for this password policy warning type.