Class PasswordPolicyStateAccountUsabilityNotice

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class PasswordPolicyStateAccountUsabilityNotice
    extends java.lang.Object
    implements java.io.Serializable
    This class defines a data structure that will provide information about notices pertaining to a user's password policy state (items that might be of interest, but do not necessarily represent a current or imminent problem with the account). It includes a number of predefined notice types, but also allows for the possibility of additional notice 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:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NOTICE_NAME_IN_MINIMUM_PASSWORD_AGE
      The name for the notice type that indicates the user is not currently allowed to change his/her password because they are within the minimum password age.
      static java.lang.String NOTICE_NAME_NO_STATIC_PASSWORD
      The name for the notice type that indicates that the user does not have a static password.
      static java.lang.String NOTICE_NAME_OUTSTANDING_ONE_TIME_PASSWORD
      The name for the notice type that indicates the user has a valid outstanding one-time password.
      static java.lang.String NOTICE_NAME_OUTSTANDING_PASSWORD_RESET_TOKEN
      The name for the notice type that indicates the user has a valid outstanding password reset token that will expire in the near future.
      static java.lang.String NOTICE_NAME_OUTSTANDING_RETIRED_PASSWORD
      The name for the notice type that indicates the user user has a valid outstanding retired password.
      static java.lang.String NOTICE_NAME_TOO_MANY_OUTSTANDING_BIND_FAILURES
      The name for the warning type that indicates that although the user's account should be locked as a result of too many outstanding failed authentication attempts, their password policy is configured with a failure lockout action that will not prevent them from authenticating, and should not otherwise have an effect on the usability of their account.
      static int NOTICE_TYPE_IN_MINIMUM_PASSWORD_AGE
      The numeric value for the notice type that indicates the user is not currently allowed to change his/her password because they are within the minimum password age.
      static int NOTICE_TYPE_NO_STATIC_PASSWORD
      The numeric value for the notice type that indicates that the user does not have a static password.
      static int NOTICE_TYPE_OUTSTANDING_ONE_TIME_PASSWORD
      The numeric value for the notice type that indicates the user has a valid outstanding one-time password.
      static int NOTICE_TYPE_OUTSTANDING_PASSWORD_RESET_TOKEN
      The numeric value for the notice type that indicates the user has a valid outstanding password reset token.
      static int NOTICE_TYPE_OUTSTANDING_RETIRED_PASSWORD
      The numeric value for the notice type that indicates the user has a valid outstanding retired password.
      static int NOTICE_TYPE_TOO_MANY_OUTSTANDING_BIND_FAILURES
      The numeric value for the notice type that indicates that although the user's account should be locked as a result of too many outstanding failed authentication attempts, their password policy is configured with a failure lockout action that will not prevent them from authenticating, and should not otherwise have an effect on the usability of their account.
    • Constructor Summary

      Constructors 
      Constructor Description
      PasswordPolicyStateAccountUsabilityNotice​(int intValue, java.lang.String name, java.lang.String message)
      Creates a new account usability notice with the provided information.
      PasswordPolicyStateAccountUsabilityNotice​(java.lang.String stringRepresentation)
      Creates a new account usability notice that is decoded from the provided string representation.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getIntValue()
      Retrieves the integer value for this account usability notice.
      java.lang.String getMessage()
      Retrieves a human-readable message that provides specific details about this account usability notice.
      java.lang.String getName()
      Retrieves the name for this account usability notice.
      java.lang.String toString()
      Retrieves a string representation of this account usability notice.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PasswordPolicyStateAccountUsabilityNotice

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

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

      • getIntValue

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

        @NotNull
        public java.lang.String getName()
        Retrieves the name for this account usability notice.
        Returns:
        The name for this account usability notice.
      • getMessage

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

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