Class ModifiablePasswordPolicyStateJSON

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String MODIFIABLE_PASSWORD_POLICY_STATE_JSON_ATTRIBUTE
      The name of the operational attribute that holds a JSON representation of the modifiable elements in a user's password policy state.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ModifiablePasswordPolicyStateJSON get​(Entry userEntry)
      Attempts to retrieve and decode the modifiable password policy state information from the provided user entry.
      static ModifiablePasswordPolicyStateJSON get​(LDAPInterface connection, java.lang.String userDN)
      Attempts to retrieve and decode the modifiable password policy state information for the specified user.
      java.lang.Long getAccountActivationTime()
      Retrieves a timestamp that indicates the time the user's account became (or will become) active.
      java.lang.Long getAccountExpirationTime()
      Retrieves a timestamp that indicates the time the user's account will (or did) expire.
      java.lang.Boolean getAccountIsDisabled()
      Retrieves the value of a flag that indicates whether the user's account has been administratively disabled.
      java.lang.Boolean getAccountIsFailureLocked()
      Retrieves the value of a flag that indicates whether the user account is currently locked as a result of too many failed authentication attempts.
      JSONObject getModifiablePasswordPolicyStateJSONObject()
      Retrieves the JSON object that contains the encoded modifiable password policy state information.
      java.lang.Boolean getMustChangePassword()
      Retrieves the value of a flag that indicates whether the user must change their password before they will be allowed to perform any other operations in the server.
      java.lang.Long getPasswordChangedTime()
      Retrieves a timestamp that indicates the time the user's password was last changed.
      java.lang.Long getPasswordExpirationWarnedTime()
      Retrieves a timestamp that indicates the time the user was first warned about an upcoming password expiration.
      java.lang.String toString()
      Retrieves a string representation of the password policy state information.
      • Methods inherited from class java.lang.Object

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

      • ModifiablePasswordPolicyStateJSON

        public ModifiablePasswordPolicyStateJSON​(@NotNull
                                                 JSONObject modifiablePasswordPolicyStateObject)
        Creates a new instance of this object from the provided JSON object.
        Parameters:
        modifiablePasswordPolicyStateObject - The JSON object containing the encoded modifiable password policy state.
    • Method Detail

      • get

        @Nullable
        public static ModifiablePasswordPolicyStateJSON get​(@NotNull
                                                            LDAPInterface connection,
                                                            @NotNull
                                                            java.lang.String userDN)
                                                     throws LDAPException
        Attempts to retrieve and decode the modifiable password policy state information for the specified user.
        Parameters:
        connection - The connection to use to communicate with the server. It must not be null, and it must be established and authenticated as an account with permission to access the target user's password policy state information.
        userDN - The DN of the user for whom to retrieve the password policy state. It must not be null.
        Returns:
        The modifiable password policy state information for the specified user, or null because no modifiable password policy state information is available for the user.
        Throws:
        LDAPException - If a problem is encountered while trying to retrieve the user's entry or decode the modifiable password policy state JSON object.
      • get

        @Nullable
        public static ModifiablePasswordPolicyStateJSON get​(@NotNull
                                                            Entry userEntry)
                                                     throws LDAPException
        Attempts to retrieve and decode the modifiable password policy state information from the provided user entry.
        Parameters:
        userEntry - The entry for the user for whom to obtain the modifiable password policy state information. It must not be null.
        Returns:
        The modifiable password policy state information from the provided user entry, or null if no modifiable password policy state information is available for the user.
        Throws:
        LDAPException - If a problem is encountered while trying to decode the modifiable password policy state JSON object.
      • getModifiablePasswordPolicyStateJSONObject

        @NotNull
        public JSONObject getModifiablePasswordPolicyStateJSONObject()
        Retrieves the JSON object that contains the encoded modifiable password policy state information.
        Returns:
        The JSON object that contains the encoded modifiable password policy state information.
      • getPasswordChangedTime

        @Nullable
        public java.lang.Long getPasswordChangedTime()
        Retrieves a timestamp that indicates the time the user's password was last changed.
        Returns:
        A non-negative value that represents the password changed time in number of milliseconds since the epoch (the same format used by System.currentTimeMillis), a negative value if the field was present with a JSON null value (indicating that the user doesn't have a password changed time), or null if the field was not included in the JSON object.
      • getAccountIsDisabled

        @Nullable
        public java.lang.Boolean getAccountIsDisabled()
        Retrieves the value of a flag that indicates whether the user's account has been administratively disabled.
        Returns:
        Boolean.TRUE if the account has been administratively disabled, Boolean.FALSE if the account has not been administratively disabled, or null if this flag was not included in the password policy state JSON object.
      • getAccountActivationTime

        @Nullable
        public java.lang.Long getAccountActivationTime()
        Retrieves a timestamp that indicates the time the user's account became (or will become) active.
        Returns:
        A non-negative value that represents the account activation time in number of milliseconds since the epoch (the same format used by System.currentTimeMillis), a negative value if the field was present with a JSON null value (indicating that the user doesn't have an account activation time), or null if the field was not included in the JSON object.
      • getAccountExpirationTime

        @Nullable
        public java.lang.Long getAccountExpirationTime()
        Retrieves a timestamp that indicates the time the user's account will (or did) expire.
        Returns:
        A non-negative value that represents the account expiration time in number of milliseconds since the epoch (the same format used by System.currentTimeMillis), a negative value if the field was present with a JSON null value (indicating that the user doesn't have an account expiration time), or null if the field was not included in the JSON object.
      • getAccountIsFailureLocked

        @Nullable
        public java.lang.Boolean getAccountIsFailureLocked()
        Retrieves the value of a flag that indicates whether the user account is currently locked as a result of too many failed authentication attempts.
        Returns:
        Boolean.TRUE if the user account is locked as a result of too many failed authentication attempts, Boolean.FALSE if the user account is not locked because of too many failed authentication attempts, or null if this flag was not included in the password policy state JSON object.
      • getPasswordExpirationWarnedTime

        @Nullable
        public java.lang.Long getPasswordExpirationWarnedTime()
        Retrieves a timestamp that indicates the time the user was first warned about an upcoming password expiration.
        Returns:
        A non-negative value that represents the password expiration warned time in number of milliseconds since the epoch (the same format used by System.currentTimeMillis), a negative value if the field was present with a JSON null value (indicating that the user doesn't have an password expiration warned time), or null if the field was not included in the JSON object.
      • getMustChangePassword

        @Nullable
        public java.lang.Boolean getMustChangePassword()
        Retrieves the value of a flag that indicates whether the user must change their password before they will be allowed to perform any other operations in the server.
        Returns:
        Boolean.TRUE if the user must change their password before they will be allowed to perform any other operations in the server, Boolean.FALSE if the user is not required to change their password, or null if this flag was not included in the password policy state JSON object.
      • toString

        @NotNull
        public java.lang.String toString()
        Retrieves a string representation of the password policy state information.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of the password policy state information.