Package org.opends.server.extensions

Class PasswordPolicyStateExtendedOperation

  • public final class PasswordPolicyStateExtendedOperation
extends ExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>
    This class implements an LDAP extended operation that can be used to query and update elements of the Directory Server password policy state for a given user. The ASN.1 definition for the value of the extended request is: 
     PasswordPolicyStateValue ::= SEQUENCE {
      targetUser     LDAPDN
      operations     SEQUENCE OF PasswordPolicyStateOperation OPTIONAL }

 PasswordPolicyStateOperation ::= SEQUENCE {
      opType       ENUMERATED {
           getPasswordPolicyDN                          (0),
           getAccountDisabledState                      (1),
           setAccountDisabledState                      (2),
           clearAccountDisabledState                    (3),
           getAccountExpirationTime                     (4),
           setAccountExpirationTime                     (5),
           clearAccountExpirationTime                   (6),
           getSecondsUntilAccountExpiration             (7),
           getPasswordChangedTime                       (8),
           setPasswordChangedTime                       (9),
           clearPasswordChangedTime                     (10),
           getPasswordExpirationWarnedTime              (11),
           setPasswordExpirationWarnedTime              (12),
           clearPasswordExpirationWarnedTime            (13),
           getSecondsUntilPasswordExpiration            (14),
           getSecondsUntilPasswordExpirationWarning     (15),
           getAuthenticationFailureTimes                (16),
           addAuthenticationFailureTime                 (17),
           setAuthenticationFailureTimes                (18),
           clearAuthenticationFailureTimes              (19),
           getSecondsUntilAuthenticationFailureUnlock   (20),
           getRemainingAuthenticationFailureCount       (21),
           getLastLoginTime                             (22),
           setLastLoginTime                             (23),
           clearLastLoginTime                           (24),
           getSecondsUntilIdleLockout                   (25),
           getPasswordResetState                        (26),
           setPasswordResetState                        (27),
           clearPasswordResetState                      (28),
           getSecondsUntilPasswordResetLockout          (29),
           getGraceLoginUseTimes                        (30),
           addGraceLoginUseTime                         (31),
           setGraceLoginUseTimes                        (32),
           clearGraceLoginUseTimes                      (33),
           getRemainingGraceLoginCount                  (34),
           getPasswordChangedByRequiredTime             (35),
           setPasswordChangedByRequiredTime             (36),
           clearPasswordChangedByRequiredTime           (37),
           getSecondsUntilRequiredChangeTime            (38),
           getPasswordHistory                           (39), --deprecated
           clearPasswordHistory                         (40),
           ... },
      opValues     SEQUENCE OF OCTET STRING OPTIONAL }

    Both the request and response values use the same encoded form, and they both use the same OID of "1.3.6.1.4.1.26027.1.6.1". The response value will only include get* elements. If the request did not include any operations, then the response will include all get* elements; otherwise, the response will only include the get* elements that correspond to the state fields referenced in the request (regardless of whether that operation was included in a get*, set*, add*, remove*, or clear* operation).

    • Field Detail

      • OP_GET_PASSWORD_POLICY_DN

        public static final int OP_GET_PASSWORD_POLICY_DN
        The enumerated value for the getPasswordPolicyDN operation.
        See Also:
        Constant Field Values

      • OP_GET_ACCOUNT_DISABLED_STATE

        public static final int OP_GET_ACCOUNT_DISABLED_STATE
        The enumerated value for the getAccountDisabledState operation.
        See Also:
        Constant Field Values

      • OP_SET_ACCOUNT_DISABLED_STATE

        public static final int OP_SET_ACCOUNT_DISABLED_STATE
        The enumerated value for the setAccountDisabledState operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_ACCOUNT_DISABLED_STATE

        public static final int OP_CLEAR_ACCOUNT_DISABLED_STATE
        The enumerated value for the clearAccountDisabledState operation.
        See Also:
        Constant Field Values

      • OP_GET_ACCOUNT_EXPIRATION_TIME

        public static final int OP_GET_ACCOUNT_EXPIRATION_TIME
        The enumerated value for the getAccountExpirationTime operation.
        See Also:
        Constant Field Values

      • OP_SET_ACCOUNT_EXPIRATION_TIME

        public static final int OP_SET_ACCOUNT_EXPIRATION_TIME
        The enumerated value for the setAccountExpirationTime operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_ACCOUNT_EXPIRATION_TIME

        public static final int OP_CLEAR_ACCOUNT_EXPIRATION_TIME
        The enumerated value for the clearAccountExpirationTime operation.
        See Also:
        Constant Field Values

      • OP_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATION

        public static final int OP_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATION
        The enumerated value for the getSecondsUntilAccountExpiration operation.
        See Also:
        Constant Field Values

      • OP_GET_PASSWORD_CHANGED_TIME

        public static final int OP_GET_PASSWORD_CHANGED_TIME
        The enumerated value for the getPasswordChangedTime operation.
        See Also:
        Constant Field Values

      • OP_SET_PASSWORD_CHANGED_TIME

        public static final int OP_SET_PASSWORD_CHANGED_TIME
        The enumerated value for the setPasswordChangedTime operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_PASSWORD_CHANGED_TIME

        public static final int OP_CLEAR_PASSWORD_CHANGED_TIME
        The enumerated value for the clearPasswordChangedTime operation.
        See Also:
        Constant Field Values

      • OP_GET_PASSWORD_EXPIRATION_WARNED_TIME

        public static final int OP_GET_PASSWORD_EXPIRATION_WARNED_TIME
        The enumerated value for the getPasswordExpirationWarnedTime operation.
        See Also:
        Constant Field Values

      • OP_SET_PASSWORD_EXPIRATION_WARNED_TIME

        public static final int OP_SET_PASSWORD_EXPIRATION_WARNED_TIME
        The enumerated value for the setPasswordExpirationWarnedTime operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_PASSWORD_EXPIRATION_WARNED_TIME

        public static final int OP_CLEAR_PASSWORD_EXPIRATION_WARNED_TIME
        The enumerated value for the clearPasswordExpirationWarnedTime operation.
        See Also:
        Constant Field Values

      • OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION

        public static final int OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION
        The enumerated value for the getSecondsUntilPasswordExpiration operation.
        See Also:
        Constant Field Values

      • OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION_WARNING

        public static final int OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION_WARNING
        The enumerated value for the getSecondsUntilPasswordExpirationWarning operation.
        See Also:
        Constant Field Values

      • OP_GET_AUTHENTICATION_FAILURE_TIMES

        public static final int OP_GET_AUTHENTICATION_FAILURE_TIMES
        The enumerated value for the getAuthenticationFailureTimes operation.
        See Also:
        Constant Field Values

      • OP_ADD_AUTHENTICATION_FAILURE_TIME

        public static final int OP_ADD_AUTHENTICATION_FAILURE_TIME
        The enumerated value for the addAuthenticationFailureTime operation.
        See Also:
        Constant Field Values

      • OP_SET_AUTHENTICATION_FAILURE_TIMES

        public static final int OP_SET_AUTHENTICATION_FAILURE_TIMES
        The enumerated value for the setAuthenticationFailureTimes operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_AUTHENTICATION_FAILURE_TIMES

        public static final int OP_CLEAR_AUTHENTICATION_FAILURE_TIMES
        The enumerated value for the clearAuthenticationFailureTimes operation.
        See Also:
        Constant Field Values

      • OP_GET_SECONDS_UNTIL_AUTHENTICATION_FAILURE_UNLOCK

        public static final int OP_GET_SECONDS_UNTIL_AUTHENTICATION_FAILURE_UNLOCK
        The enumerated value for the getSecondsUntilAuthenticationFailureUnlock operation.
        See Also:
        Constant Field Values

      • OP_GET_REMAINING_AUTHENTICATION_FAILURE_COUNT

        public static final int OP_GET_REMAINING_AUTHENTICATION_FAILURE_COUNT
        The enumerated value for the getRemainingAuthenticationFailureCount operation.
        See Also:
        Constant Field Values

      • OP_GET_LAST_LOGIN_TIME

        public static final int OP_GET_LAST_LOGIN_TIME
        The enumerated value for the getLastLoginTime operation.
        See Also:
        Constant Field Values

      • OP_SET_LAST_LOGIN_TIME

        public static final int OP_SET_LAST_LOGIN_TIME
        The enumerated value for the setLastLoginTime operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_LAST_LOGIN_TIME

        public static final int OP_CLEAR_LAST_LOGIN_TIME
        The enumerated value for the clearLastLoginTime operation.
        See Also:
        Constant Field Values

      • OP_GET_SECONDS_UNTIL_IDLE_LOCKOUT

        public static final int OP_GET_SECONDS_UNTIL_IDLE_LOCKOUT
        The enumerated value for the getSecondsUntilIdleLockout operation.
        See Also:
        Constant Field Values

      • OP_GET_PASSWORD_RESET_STATE

        public static final int OP_GET_PASSWORD_RESET_STATE
        The enumerated value for the getPasswordResetState operation.
        See Also:
        Constant Field Values

      • OP_SET_PASSWORD_RESET_STATE

        public static final int OP_SET_PASSWORD_RESET_STATE
        The enumerated value for the setPasswordResetState operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_PASSWORD_RESET_STATE

        public static final int OP_CLEAR_PASSWORD_RESET_STATE
        The enumerated value for the clearPasswordResetState operation.
        See Also:
        Constant Field Values

      • OP_GET_SECONDS_UNTIL_PASSWORD_RESET_LOCKOUT

        public static final int OP_GET_SECONDS_UNTIL_PASSWORD_RESET_LOCKOUT
        The enumerated value for the getSecondsUntilPasswordResetLockout operation.
        See Also:
        Constant Field Values

      • OP_GET_GRACE_LOGIN_USE_TIMES

        public static final int OP_GET_GRACE_LOGIN_USE_TIMES
        The enumerated value for the getGraceLoginUseTimes operation.
        See Also:
        Constant Field Values

      • OP_ADD_GRACE_LOGIN_USE_TIME

        public static final int OP_ADD_GRACE_LOGIN_USE_TIME
        The enumerated value for the addGraceLoginUseTime operation.
        See Also:
        Constant Field Values

      • OP_SET_GRACE_LOGIN_USE_TIMES

        public static final int OP_SET_GRACE_LOGIN_USE_TIMES
        The enumerated value for the setGraceLoginUseTimes operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_GRACE_LOGIN_USE_TIMES

        public static final int OP_CLEAR_GRACE_LOGIN_USE_TIMES
        The enumerated value for the clearGraceLoginUseTimes operation.
        See Also:
        Constant Field Values

      • OP_GET_REMAINING_GRACE_LOGIN_COUNT

        public static final int OP_GET_REMAINING_GRACE_LOGIN_COUNT
        The enumerated value for the getRemainingGraceLoginCount operation.
        See Also:
        Constant Field Values

      • OP_GET_PASSWORD_CHANGED_BY_REQUIRED_TIME

        public static final int OP_GET_PASSWORD_CHANGED_BY_REQUIRED_TIME
        The enumerated value for the getPasswordChangedByRequiredTime operation.
        See Also:
        Constant Field Values

      • OP_SET_PASSWORD_CHANGED_BY_REQUIRED_TIME

        public static final int OP_SET_PASSWORD_CHANGED_BY_REQUIRED_TIME
        The enumerated value for the setPasswordChangedByRequiredTime operation.
        See Also:
        Constant Field Values

      • OP_CLEAR_PASSWORD_CHANGED_BY_REQUIRED_TIME

        public static final int OP_CLEAR_PASSWORD_CHANGED_BY_REQUIRED_TIME
        The enumerated value for the clearPasswordChangedByRequiredTime operation.
        See Also:
        Constant Field Values

      • OP_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIME

        public static final int OP_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIME
        The enumerated value for the getSecondsUntilRequiredChangeTime operation.
        See Also:
        Constant Field Values

      • OP_GET_PASSWORD_HISTORY

        @Deprecated
public static final int OP_GET_PASSWORD_HISTORY
        Deprecated.
        The enumerated value for the getPasswordHistory operation. Now deprecated as it is insecure.
        See Also:
        Constant Field Values

      • OP_CLEAR_PASSWORD_HISTORY

        public static final int OP_CLEAR_PASSWORD_HISTORY
        The enumerated value for the clearPasswordHistory operation.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PasswordPolicyStateExtendedOperation

        public PasswordPolicyStateExtendedOperation()
        Create an instance of this password policy state extended operation. All initialization should be performed in the initializeExtendedOperationHandler method.