Package com.unboundid.ldap.sdk.unboundidds.extensions

Class PasswordPolicyStateAccountUsabilityError

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.extensions.PasswordPolicyStateAccountUsabilityError
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PasswordPolicyStateAccountUsabilityError extends Object implements Serializable
This class defines a data structure that will provide information about errors that may affect an account's usability. It includes a number of predefined error types, but also allows for the possibility of additional error types that have not been defined.
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.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ERROR_NAME_ACCOUNT_DISABLED
    The name for the error type that indicates the user's account is disabled.
    static final String
    ERROR_NAME_ACCOUNT_EXPIRED
    The name for the error type that indicates the user's account is expired.
    static final String
    ERROR_NAME_ACCOUNT_IDLE_LOCKED
    The name for the error type that indicates the user's account is locked (until the password is reset by an administrator) as a result of remaining idle for too long (i.e., it has been too long since the user last authenticated).
    static final String
    ERROR_NAME_ACCOUNT_NOT_YET_ACTIVE
    The name for the error type that indicates the user's account is not yet valid.
    static final String
    ERROR_NAME_ACCOUNT_PERMANENTLY_LOCKED_DUE_TO_BIND_FAILURES
    The name for the error type that indicates the user's account is permanently locked (until the password is reset by an administrator) as a result of too many failed authentication attempts.
    static final String
    ERROR_NAME_ACCOUNT_RESET_LOCKED
    The name for the error type that indicates the user's account is locked (until the password is reset by an administrator) as a result of failing to change the password in a timely manner after it was reset by an administrator.
    static final String
    ERROR_NAME_ACCOUNT_TEMPORARILY_LOCKED_DUE_TO_BIND_FAILURES
    The name for the error type that indicates the user's account is temporarily locked (until the lockout period elapses or the password is reset by an administrator) as a result of too many failed authentication attempts.
    static final String
    ERROR_NAME_ACCOUNT_VALIDATION_LOCKED
    The name for the error type that indicates the user's account is locked because it contains a password that does not satisfy all of the configured password validators.
    static final String
    ERROR_NAME_MUST_CHANGE_PASSWORD
    The name for the error type that indicates the user must change their password after an administrative reset (or for a newly-created account) before they will be submit any requests.
    static final String
    ERROR_NAME_PASSWORD_EXPIRED
    The name for the error type that indicates the user's password is expired.
    static final String
    ERROR_NAME_PASSWORD_EXPIRED_WITH_GRACE_LOGINS
    The name for the error type that indicates the user's password has expired, but the user has one or more grace logins remaining.
    static final String
    ERROR_NAME_PASSWORD_NOT_CHANGED_BY_REQUIRED_TIME
    The name for the error type that indicates the user's account is locked (until the password is reset by an administrator) as a result of failing to change the password by a required time.
    static final int
    ERROR_TYPE_ACCOUNT_DISABLED
    The numeric value for the error type that indicates the user's account is disabled.
    static final int
    ERROR_TYPE_ACCOUNT_EXPIRED
    The numeric value for the error type that indicates the user's account is expired.
    static final int
    ERROR_TYPE_ACCOUNT_IDLE_LOCKED
    The numeric value for the error type that indicates the user's account is locked (until the password is reset by an administrator) as a result of remaining idle for too long (i.e., it has been too long since the user last authenticated).
    static final int
    ERROR_TYPE_ACCOUNT_NOT_YET_ACTIVE
    The numeric value for the error type that indicates the user's account is not yet active.
    static final int
    ERROR_TYPE_ACCOUNT_PERMANENTLY_LOCKED_DUE_TO_BIND_FAILURES
    The numeric value for the error type that indicates the user's account is permanently locked (until the password is reset by an administrator) as a result of too many failed authentication attempts.
    static final int
    ERROR_TYPE_ACCOUNT_RESET_LOCKED
    The numeric value for the error type that indicates the user's account is locked (until the password is reset by an administrator) as a result of failing to change the password in a timely manner after it was reset by an administrator.
    static final int
    ERROR_TYPE_ACCOUNT_TEMPORARILY_LOCKED_DUE_TO_BIND_FAILURES
    The numeric value for the error type that indicates the user's account is temporarily locked (until the lockout period elapses or the password is reset by an administrator) as a result of too many failed authentication attempts.
    static final int
    ERROR_TYPE_ACCOUNT_VALIDATION_LOCKED
    The numeric value for the error type that indicates the user's account is locked because it contains a password that does not satisfy all of the configured password validators.
    static final int
    ERROR_TYPE_MUST_CHANGE_PASSWORD
    The numeric value for the error type that indicates the user must change their password after an administrative reset (or for a newly-created account) before they will be submit any requests.
    static final int
    ERROR_TYPE_PASSWORD_EXPIRED
    The numeric value for the error type that indicates the user's password is expired.
    static final int
    ERROR_TYPE_PASSWORD_EXPIRED_WITH_GRACE_LOGINS
    The numeric value for the error type that indicates the user's password has expired, but the user has one or more grace logins remaining.
    static final int
    ERROR_TYPE_PASSWORD_NOT_CHANGED_BY_REQUIRED_TIME
    The numeric value for the error type that indicates the user's account is locked (until the password is reset by an administrator) as a result of failing to change the password by a required time.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PasswordPolicyStateAccountUsabilityError(int intValue, String name, String message)
    Creates a new account usability error with the provided information.
    PasswordPolicyStateAccountUsabilityError(String stringRepresentation)
    Creates a new account usability error that is decoded from the provided string representation.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getIntValue()
    Retrieves the integer value for this account usability error.
    String
    getMessage()
    Retrieves a human-readable message that provides specific details about this account usability error.
    String
    getName()
    Retrieves the name for this account usability error.
    String
    toString()
    Retrieves a string representation of this account usability error.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • PasswordPolicyStateAccountUsabilityError

      public PasswordPolicyStateAccountUsabilityError(int intValue, @NotNull String name, @Nullable String message)
      Creates a new account usability error with the provided information.
      Parameters:
      intValue - The integer value for this account usability error.
      name - The name for this account usability error. It must not be null.
      message - A human-readable message that provides specific details about this account usability error. It may be null if no message is available.

    • PasswordPolicyStateAccountUsabilityError

      public PasswordPolicyStateAccountUsabilityError(@NotNull String stringRepresentation) throws LDAPException
      Creates a new account usability error that is decoded from the provided string representation.
      Parameters:
      stringRepresentation - The string representation of the account usability error to decode. It must not be null.
      Throws:
      LDAPException - If the provided string cannot be decoded as a valid account usability error.

  • Method Details

    • getIntValue

      public int getIntValue()
      Retrieves the integer value for this account usability error.
      Returns:
      The integer value for this account usability error.

    • getName

      @NotNull public String getName()
      Retrieves the name for this account usability error.
      Returns:
      The name for this account usability error.

    • getMessage

      @Nullable public String getMessage()
      Retrieves a human-readable message that provides specific details about this account usability error.
      Returns:
      A human-readable message that provides specific details about this account usability error, or null if no message is available.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this account usability error.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this account usability error.