com.unboundid.ldap.sdk.unboundidds.extensions
Class PasswordPolicyStateOperation

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.extensions.PasswordPolicyStateOperation
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class PasswordPolicyStateOperation
extends java.lang.Object
implements java.io.Serializable

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 class defines an operation that may be used in conjunction with the password policy state extended operation. A password policy state operation can be used to get or set various properties of the password policy state for a user. Operations that are available for use with the password policy state operation include: Note that many of these methods are dependent upon the password policy configuration for the target user and therefore some of them may not be applicable for some users. For example, if password expiration is not enabled in the password policy associated with the target user, then operations that involve password expiration will have no effect and/or will have a return value that indicates that password expiration is not in effect.

See Also:
Serialized Form

Field Summary
static int OP_TYPE_ADD_AUTH_FAILURE_TIME
          The operation type that may be used to add a new authentication failure time to the user's account.
static int OP_TYPE_ADD_GRACE_LOGIN_USE_TIME
          The operation type that may be used add a value to the set of times that the user has authenticated using a grace login after his/her password has expired.
static int OP_TYPE_CLEAR_ACCOUNT_DISABLED_STATE
          The operation type that may be used to clear the account disabled flag in the user's entry.
static int OP_TYPE_CLEAR_ACCOUNT_EXPIRATION_TIME
          The operation type that may be used to clear the user's account expiration time.
static int OP_TYPE_CLEAR_AUTH_FAILURE_TIMES
          The operation type that may be used to clear the authentication failure times in the user account.
static int OP_TYPE_CLEAR_GRACE_LOGIN_USE_TIMES
          The operation type that may be used to clear the set of times that the user has authenticated using a grace login after his/her password has expired.
static int OP_TYPE_CLEAR_LAST_LOGIN_TIME
          The operation type that may be used to clear the last login time in the user's entry.
static int OP_TYPE_CLEAR_PW_CHANGED_BY_REQUIRED_TIME
          The operation type that may be used to clear the last time that the user's password was changed during a required change period.
static int OP_TYPE_CLEAR_PW_CHANGED_TIME
          The operation type that may be used to clear the password changed time in the user's account.
static int OP_TYPE_CLEAR_PW_EXPIRATION_WARNED_TIME
          The operation type that may be used to clear the password expiration warned time from the user's entry.
static int OP_TYPE_CLEAR_PW_HISTORY
          The operation type that may be used to clear the stored password history values for a user.
static int OP_TYPE_CLEAR_PW_RESET_STATE
          The operation type that may be used to clear the password reset flag in the user's entry.
static int OP_TYPE_GET_ACCOUNT_DISABLED_STATE
          The operation type that may be used to determine whether the user account is disabled.
static int OP_TYPE_GET_ACCOUNT_EXPIRATION_TIME
          The operation type that may be used to get the time that the user's account will expire.
static int OP_TYPE_GET_AUTH_FAILURE_TIMES
          The operation type that may be used to get the set of times that the user has unsuccessfully tried to authenticate since the last successful attempt.
static int OP_TYPE_GET_GRACE_LOGIN_USE_TIMES
          The operation type that may be used to retrieve the times that the user has authenticated using a grace login after his/her password has expired.
static int OP_TYPE_GET_LAST_LOGIN_TIME
          The operation type that may be used to retrieve the time that the user last authenticated to the server.
static int OP_TYPE_GET_PASSWORD_RETIRED_TIME
          The operation type that may be used to retrieve the time that the user's former password was retired.
static int OP_TYPE_GET_PW_CHANGED_BY_REQUIRED_TIME
          The operation type that may be used to retrieve the last time that the user's password was changed during a required change period.
static int OP_TYPE_GET_PW_CHANGED_TIME
          The operation type that may be used to get the time that the user's password was last changed.
static int OP_TYPE_GET_PW_EXPIRATION_WARNED_TIME
          The operation type that may be used to get the time that the user was first sent a password expiration warning.
static int OP_TYPE_GET_PW_HISTORY
          The operation type that may be used to retrieve the stored password history values for a user.
static int OP_TYPE_GET_PW_POLICY_DN
          The operation type that may be used to retrieve the DN of the password policy to which the user is subject.
static int OP_TYPE_GET_PW_RESET_STATE
          The operation type that may be used to determine whether a user's password has been reset by an administrator and must be changed.
static int OP_TYPE_GET_REMAINING_AUTH_FAILURE_COUNT
          The operation type that may be used to retrieve the number of failed authentication attempts that the user has before the account is locked.
static int OP_TYPE_GET_REMAINING_GRACE_LOGIN_COUNT
          The operation type that may be used to retrieve the number of grace logins available for the user.
static int OP_TYPE_GET_RETIRED_PASSWORD_EXPIRATION_TIME
          The operation type that may be used to retrieve the time that the user's retired password will expire.
static int OP_TYPE_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATION
          The operation type that may be used to retrieve the length of time in seconds until the user's account expires.
static int OP_TYPE_GET_SECONDS_UNTIL_AUTH_FAILURE_UNLOCK
          The operation type that may be used to retrieve the length of time in seconds until the user's account is unlocked.
static int OP_TYPE_GET_SECONDS_UNTIL_IDLE_LOCKOUT
          The operation type that may be used to get the length of time in seconds until the user account is locked due to inactivity.
static int OP_TYPE_GET_SECONDS_UNTIL_PW_EXPIRATION
          The operation type that may be used to get the length of time in seconds until the user's password expires.
static int OP_TYPE_GET_SECONDS_UNTIL_PW_EXPIRATION_WARNING
          The operation type that may be used to get the length of time in seconds until the user will be eligible to receive a password expiration warning.
static int OP_TYPE_GET_SECONDS_UNTIL_PW_RESET_LOCKOUT
          The operation type that may be used to get the length of time in seconds until the user's account is locked due to failure to change the password after an administrative reset.
static int OP_TYPE_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIME
          The operation type that may be used to get the length of time in seconds until the user's account will be locked due to a failure to change the password by a required time.
static int OP_TYPE_HAS_RETIRED_PASSWORD
          The operation type that may be used to determine whether a user has a valid retired password.
static int OP_TYPE_PURGE_RETIRED_PASSWORD
          The operation type that may be used to purge any retired password from the user's entry.
static int OP_TYPE_SET_ACCOUNT_DISABLED_STATE
          The operation type that may be used to specify whether the user account is disabled.
static int OP_TYPE_SET_ACCOUNT_EXPIRATION_TIME
          The operation type that may be used to set the time that the user's account will expire.
static int OP_TYPE_SET_AUTH_FAILURE_TIMES
          The operation type that may be used to set the set of times that the user has unsuccessfully tried to authenticate since the last successful attempt.
static int OP_TYPE_SET_GRACE_LOGIN_USE_TIMES
          The operation type that may be used to set the times that the user has authenticated using a grace login after his/her password has expired.
static int OP_TYPE_SET_LAST_LOGIN_TIME
          The operation type that may be used to set the time that the user last authenticated to the server.
static int OP_TYPE_SET_PW_CHANGED_BY_REQUIRED_TIME
          The operation type that may be used to set the last time that the user's password was changed during a required change period.
static int OP_TYPE_SET_PW_CHANGED_TIME
          The operation type that may be used to set the time that the user's password was last changed.
static int OP_TYPE_SET_PW_EXPIRATION_WARNED_TIME
          The operation type that may be used to set the time that the user was first sent a password expiration warning.
static int OP_TYPE_SET_PW_RESET_STATE
          The operation type that may be used to set the flag to indicate whether a user's password has been reset by an administrator and must be changed.
 
Constructor Summary
PasswordPolicyStateOperation(int opType)
          Creates a new password policy state operation with the specified operation type and no values.
PasswordPolicyStateOperation(int opType, ASN1OctetString[] values)
          Creates a new password policy state operation with the specified operation type and set of values.
 
Method Summary
static PasswordPolicyStateOperation createAddAuthenticationFailureTimeOperation()
          Creates a new password policy state operation that may be used to add the current time to the set of times that the user has unsuccessfully tried to authenticate since the last successful authentication.
static PasswordPolicyStateOperation createAddGraceLoginUseTimeOperation()
          Creates a new password policy state operation that may be used to add the current time to the set of times that the user has authenticated using grace logins since his/her password expired.
static PasswordPolicyStateOperation createClearAccountDisabledStateOperation()
          Creates a new password policy state operation that may be used to clear the user account disabled state in the user's entry.
static PasswordPolicyStateOperation createClearAccountExpirationTimeOperation()
          Creates a new password policy state operation that may be used to clear the account expiration time in the user's entry.
static PasswordPolicyStateOperation createClearAuthenticationFailureTimesOperation()
          Creates a new password policy state operation that may be used to clear the set of times that the user has unsuccessfully tried to authenticate since the last successful authentication.
static PasswordPolicyStateOperation createClearGraceLoginUseTimesOperation()
          Creates a new password policy state operation that may be used to clear the set of times that the user has authenticated using grace logins since his/her password expired.
static PasswordPolicyStateOperation createClearLastLoginTimeOperation()
          Creates a new password policy state operation that may be used to clear the last login time time from the user's entry.
static PasswordPolicyStateOperation createClearPasswordChangedByRequiredTimeOperation()
          Creates a new password policy state operation that may be used to clear the last required password change time from the user's entry.
static PasswordPolicyStateOperation createClearPasswordExpirationWarnedTimeOperation()
          Creates a new password policy state operation that may be used to clear the password expiration warned time from the user's entry.
static PasswordPolicyStateOperation createClearPasswordHistoryOperation()
          Creates a new password policy state operation that may be used to clear the password history values stored in the user's entry.
static PasswordPolicyStateOperation createClearPasswordResetStateOperation()
          Creates a new password policy state operation that may be used to clear the password reset state information in the user's entry.
static PasswordPolicyStateOperation createGetAccountDisabledStateOperation()
          Creates a new password policy state operation that may be used to determine whether the user account is disabled.
static PasswordPolicyStateOperation createGetAccountExpirationTimeOperation()
          Creates a new password policy state operation that may be used to retrieve the time that the user's account expires.
static PasswordPolicyStateOperation createGetAuthenticationFailureTimesOperation()
          Creates a new password policy state operation that may be used to retrieve the times that the user has unsuccessfully tried to authenticate since the last successful authentication.
static PasswordPolicyStateOperation createGetGraceLoginUseTimesOperation()
          Creates a new password policy state operation that may be used to retrieve the set of times that the user has authenticated using grace logins since his/her password expired.
static PasswordPolicyStateOperation createGetLastLoginTimeOperation()
          Creates a new password policy state operation that may be used to determine the time that the user last successfully authenticated to the server.
static PasswordPolicyStateOperation createGetPasswordChangedByRequiredTimeOperation()
          Creates a new password policy state operation that may be used to retrieve the last required password change time that with which the user has complied.
static PasswordPolicyStateOperation createGetPasswordChangedTimeOperation()
          Creates a new password policy state operation that may be used to determine when the user's password was last changed.
static PasswordPolicyStateOperation createGetPasswordExpirationWarnedTimeOperation()
          Creates a new password policy state operation that may be used to determine when the user first received a password expiration warning.
static PasswordPolicyStateOperation createGetPasswordHistoryOperation()
          Creates a new password policy state operation that may be used to retrieve the password history values stored in the user's entry.
static PasswordPolicyStateOperation createGetPasswordPolicyDNOperation()
          Creates a new password policy state operation that may be used to request the DN of the password policy configuration entry for the user.
static PasswordPolicyStateOperation createGetPasswordResetStateOperation()
          Creates a new password policy state operation that may be used to determine whether the user's password has been reset by an administrator and must be changed before performing any other operations.
static PasswordPolicyStateOperation createGetPasswordRetiredTimeOperation()
          Creates a new password policy state operation that may be used to determine the time that the user's former password was retired.
static PasswordPolicyStateOperation createGetRemainingAuthenticationFailureCountOperation()
          Creates a new password policy state operation that may be used to determine the number of authentication failures required to lock the user's account.
static PasswordPolicyStateOperation createGetRemainingGraceLoginCountOperation()
          Creates a new password policy state operation that may be used to retrieve the number of remaining grace logins available to the user.
static PasswordPolicyStateOperation createGetRetiredPasswordExpirationTimeOperation()
          Creates a new password policy state operation that may be used to determine the length of time until the user's retired password expires.
static PasswordPolicyStateOperation createGetSecondsUntilAccountExpirationOperation()
          Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's account is expired.
static PasswordPolicyStateOperation createGetSecondsUntilAuthenticationFailureUnlockOperation()
          Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's account is automatically unlocked after too many failed authentication attempts.
static PasswordPolicyStateOperation createGetSecondsUntilIdleLockoutOperation()
          Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's account is locked due to inactivity.
static PasswordPolicyStateOperation createGetSecondsUntilPasswordExpirationOperation()
          Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's password expires.
static PasswordPolicyStateOperation createGetSecondsUntilPasswordExpirationWarningOperation()
          Creates a new password policy state operation that may be used to determine the length of time in seconds until the user is eligible to start receiving password expiration warnings.
static PasswordPolicyStateOperation createGetSecondsUntilPasswordResetLockoutOperation()
          Creates a new password policy state operation that may be used to determine the length of time in seconds that the user has left to change his/her password after an administrative reset before the account is locked.
static PasswordPolicyStateOperation createGetSecondsUntilRequiredChangeTimeOperation()
          Creates a new password policy state operation that may be used to retrieve the length of time in seconds until the required password change time arrives.
static PasswordPolicyStateOperation createHasRetiredPasswordOperation()
          Creates a new password policy state operation that may be used to determine whether the user has a valid retired password.
static PasswordPolicyStateOperation createPurgeRetiredPasswordOperation()
          Creates a new password policy state operation that may be used to purge any retired password from the user's entry.
static PasswordPolicyStateOperation createSetAccountDisabledStateOperation(boolean isDisabled)
          Creates a new password policy state operation that may be used to specify whether the user account is disabled.
static PasswordPolicyStateOperation createSetAccountExpirationTimeOperation(java.util.Date expirationTime)
          Creates a new password policy state operation that may be used to set the time that the user's account expires.
static PasswordPolicyStateOperation createSetAuthenticationFailureTimesOperation(java.util.Date[] authFailureTimes)
          Creates a new password policy state operation that may be used to specify the set of times that the user has unsuccessfully tried to authenticate since the last successful authentication.
static PasswordPolicyStateOperation createSetGraceLoginUseTimesOperation(java.util.Date[] graceLoginUseTimes)
          Creates a new password policy state operation that may be used to specify the set of times that the user has authenticated using grace logins since his/her password expired.
static PasswordPolicyStateOperation createSetLastLoginTimeOperation(java.util.Date lastLoginTime)
          Creates a new password policy state operation that may be used to set the time that the user last successfully authenticated to the server.
static PasswordPolicyStateOperation createSetPasswordChangedByRequiredTimeOperation()
          Creates a new password policy state operation that may be used to update the user's entry to indicate that he/she has complied with the required password change time.
static PasswordPolicyStateOperation createSetPasswordResetStateOperation(boolean isReset)
          Creates a new password policy state operation that may be used to specify whether the user's password has been reset by an administrator and must be changed before performing any other operations.
static PasswordPolicyStateOperation decode(ASN1Element element)
          Decodes the provided ASN.1 element as a password policy state operation.
 ASN1Element encode()
          Encodes this password policy state operation for use in the extended request or response.
 boolean getBooleanValue()
          Retrieves the boolean representation of the value for this password policy state operation.
 java.util.Date getGeneralizedTimeValue()
          Retrieves the Date object represented by the value for this password policy state operation treated as a timestamp in generalized time form.
 java.util.Date[] getGeneralizedTimeValues()
          Retrieves the Date objects represented by the values for this password policy state operation treated as timestamps in generalized time form.
 int getIntValue()
          Retrieves the integer representation of the value for this password policy state operation.
 int getOperationType()
          Retrieves the operation type for this password policy state operation.
 ASN1OctetString[] getRawValues()
          Retrieves the set of raw values for this password policy state operation.
 java.lang.String getStringValue()
          Retrieves the string representation of the value for this password policy state operation.
 java.lang.String[] getStringValues()
          Retrieves the string representations of the values for this password policy state operation.
 java.lang.String toString()
          Retrieves a string representation of this password policy state operation.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this password policy state operation to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OP_TYPE_GET_PW_POLICY_DN

public static final int OP_TYPE_GET_PW_POLICY_DN
The operation type that may be used to retrieve the DN of the password policy to which the user is subject.

See Also:
Constant Field Values

OP_TYPE_GET_ACCOUNT_DISABLED_STATE

public static final int OP_TYPE_GET_ACCOUNT_DISABLED_STATE
The operation type that may be used to determine whether the user account is disabled.

See Also:
Constant Field Values

OP_TYPE_SET_ACCOUNT_DISABLED_STATE

public static final int OP_TYPE_SET_ACCOUNT_DISABLED_STATE
The operation type that may be used to specify whether the user account is disabled.

See Also:
Constant Field Values

OP_TYPE_CLEAR_ACCOUNT_DISABLED_STATE

public static final int OP_TYPE_CLEAR_ACCOUNT_DISABLED_STATE
The operation type that may be used to clear the account disabled flag in the user's entry.

See Also:
Constant Field Values

OP_TYPE_GET_ACCOUNT_EXPIRATION_TIME

public static final int OP_TYPE_GET_ACCOUNT_EXPIRATION_TIME
The operation type that may be used to get the time that the user's account will expire.

See Also:
Constant Field Values

OP_TYPE_SET_ACCOUNT_EXPIRATION_TIME

public static final int OP_TYPE_SET_ACCOUNT_EXPIRATION_TIME
The operation type that may be used to set the time that the user's account will expire.

See Also:
Constant Field Values

OP_TYPE_CLEAR_ACCOUNT_EXPIRATION_TIME

public static final int OP_TYPE_CLEAR_ACCOUNT_EXPIRATION_TIME
The operation type that may be used to clear the user's account expiration time.

See Also:
Constant Field Values

OP_TYPE_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATION

public static final int OP_TYPE_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATION
The operation type that may be used to retrieve the length of time in seconds until the user's account expires.

See Also:
Constant Field Values

OP_TYPE_GET_PW_CHANGED_TIME

public static final int OP_TYPE_GET_PW_CHANGED_TIME
The operation type that may be used to get the time that the user's password was last changed.

See Also:
Constant Field Values

OP_TYPE_SET_PW_CHANGED_TIME

public static final int OP_TYPE_SET_PW_CHANGED_TIME
The operation type that may be used to set the time that the user's password was last changed.

See Also:
Constant Field Values

OP_TYPE_CLEAR_PW_CHANGED_TIME

public static final int OP_TYPE_CLEAR_PW_CHANGED_TIME
The operation type that may be used to clear the password changed time in the user's account.

See Also:
Constant Field Values

OP_TYPE_GET_PW_EXPIRATION_WARNED_TIME

public static final int OP_TYPE_GET_PW_EXPIRATION_WARNED_TIME
The operation type that may be used to get the time that the user was first sent a password expiration warning.

See Also:
Constant Field Values

OP_TYPE_SET_PW_EXPIRATION_WARNED_TIME

public static final int OP_TYPE_SET_PW_EXPIRATION_WARNED_TIME
The operation type that may be used to set the time that the user was first sent a password expiration warning.

See Also:
Constant Field Values

OP_TYPE_CLEAR_PW_EXPIRATION_WARNED_TIME

public static final int OP_TYPE_CLEAR_PW_EXPIRATION_WARNED_TIME
The operation type that may be used to clear the password expiration warned time from the user's entry.

See Also:
Constant Field Values

OP_TYPE_GET_SECONDS_UNTIL_PW_EXPIRATION

public static final int OP_TYPE_GET_SECONDS_UNTIL_PW_EXPIRATION
The operation type that may be used to get the length of time in seconds until the user's password expires.

See Also:
Constant Field Values

OP_TYPE_GET_SECONDS_UNTIL_PW_EXPIRATION_WARNING

public static final int OP_TYPE_GET_SECONDS_UNTIL_PW_EXPIRATION_WARNING
The operation type that may be used to get the length of time in seconds until the user will be eligible to receive a password expiration warning.

See Also:
Constant Field Values

OP_TYPE_GET_AUTH_FAILURE_TIMES

public static final int OP_TYPE_GET_AUTH_FAILURE_TIMES
The operation type that may be used to get the set of times that the user has unsuccessfully tried to authenticate since the last successful attempt.

See Also:
Constant Field Values

OP_TYPE_ADD_AUTH_FAILURE_TIME

public static final int OP_TYPE_ADD_AUTH_FAILURE_TIME
The operation type that may be used to add a new authentication failure time to the user's account.

See Also:
Constant Field Values

OP_TYPE_SET_AUTH_FAILURE_TIMES

public static final int OP_TYPE_SET_AUTH_FAILURE_TIMES
The operation type that may be used to set the set of times that the user has unsuccessfully tried to authenticate since the last successful attempt.

See Also:
Constant Field Values

OP_TYPE_CLEAR_AUTH_FAILURE_TIMES

public static final int OP_TYPE_CLEAR_AUTH_FAILURE_TIMES
The operation type that may be used to clear the authentication failure times in the user account.

See Also:
Constant Field Values

OP_TYPE_GET_SECONDS_UNTIL_AUTH_FAILURE_UNLOCK

public static final int OP_TYPE_GET_SECONDS_UNTIL_AUTH_FAILURE_UNLOCK
The operation type that may be used to retrieve the length of time in seconds until the user's account is unlocked.

See Also:
Constant Field Values

OP_TYPE_GET_REMAINING_AUTH_FAILURE_COUNT

public static final int OP_TYPE_GET_REMAINING_AUTH_FAILURE_COUNT
The operation type that may be used to retrieve the number of failed authentication attempts that the user has before the account is locked.

See Also:
Constant Field Values

OP_TYPE_GET_LAST_LOGIN_TIME

public static final int OP_TYPE_GET_LAST_LOGIN_TIME
The operation type that may be used to retrieve the time that the user last authenticated to the server.

See Also:
Constant Field Values

OP_TYPE_SET_LAST_LOGIN_TIME

public static final int OP_TYPE_SET_LAST_LOGIN_TIME
The operation type that may be used to set the time that the user last authenticated to the server.

See Also:
Constant Field Values

OP_TYPE_CLEAR_LAST_LOGIN_TIME

public static final int OP_TYPE_CLEAR_LAST_LOGIN_TIME
The operation type that may be used to clear the last login time in the user's entry.

See Also:
Constant Field Values

OP_TYPE_GET_SECONDS_UNTIL_IDLE_LOCKOUT

public static final int OP_TYPE_GET_SECONDS_UNTIL_IDLE_LOCKOUT
The operation type that may be used to get the length of time in seconds until the user account is locked due to inactivity.

See Also:
Constant Field Values

OP_TYPE_GET_PW_RESET_STATE

public static final int OP_TYPE_GET_PW_RESET_STATE
The operation type that may be used to determine whether a user's password has been reset by an administrator and must be changed.

See Also:
Constant Field Values

OP_TYPE_SET_PW_RESET_STATE

public static final int OP_TYPE_SET_PW_RESET_STATE
The operation type that may be used to set the flag to indicate whether a user's password has been reset by an administrator and must be changed.

See Also:
Constant Field Values

OP_TYPE_CLEAR_PW_RESET_STATE

public static final int OP_TYPE_CLEAR_PW_RESET_STATE
The operation type that may be used to clear the password reset flag in the user's entry.

See Also:
Constant Field Values

OP_TYPE_GET_SECONDS_UNTIL_PW_RESET_LOCKOUT

public static final int OP_TYPE_GET_SECONDS_UNTIL_PW_RESET_LOCKOUT
The operation type that may be used to get the length of time in seconds until the user's account is locked due to failure to change the password after an administrative reset.

See Also:
Constant Field Values

OP_TYPE_GET_GRACE_LOGIN_USE_TIMES

public static final int OP_TYPE_GET_GRACE_LOGIN_USE_TIMES
The operation type that may be used to retrieve the times that the user has authenticated using a grace login after his/her password has expired.

See Also:
Constant Field Values

OP_TYPE_ADD_GRACE_LOGIN_USE_TIME

public static final int OP_TYPE_ADD_GRACE_LOGIN_USE_TIME
The operation type that may be used add a value to the set of times that the user has authenticated using a grace login after his/her password has expired.

See Also:
Constant Field Values

OP_TYPE_SET_GRACE_LOGIN_USE_TIMES

public static final int OP_TYPE_SET_GRACE_LOGIN_USE_TIMES
The operation type that may be used to set the times that the user has authenticated using a grace login after his/her password has expired.

See Also:
Constant Field Values

OP_TYPE_CLEAR_GRACE_LOGIN_USE_TIMES

public static final int OP_TYPE_CLEAR_GRACE_LOGIN_USE_TIMES
The operation type that may be used to clear the set of times that the user has authenticated using a grace login after his/her password has expired.

See Also:
Constant Field Values

OP_TYPE_GET_REMAINING_GRACE_LOGIN_COUNT

public static final int OP_TYPE_GET_REMAINING_GRACE_LOGIN_COUNT
The operation type that may be used to retrieve the number of grace logins available for the user.

See Also:
Constant Field Values

OP_TYPE_GET_PW_CHANGED_BY_REQUIRED_TIME

public static final int OP_TYPE_GET_PW_CHANGED_BY_REQUIRED_TIME
The operation type that may be used to retrieve the last time that the user's password was changed during a required change period.

See Also:
Constant Field Values

OP_TYPE_SET_PW_CHANGED_BY_REQUIRED_TIME

public static final int OP_TYPE_SET_PW_CHANGED_BY_REQUIRED_TIME
The operation type that may be used to set the last time that the user's password was changed during a required change period.

See Also:
Constant Field Values

OP_TYPE_CLEAR_PW_CHANGED_BY_REQUIRED_TIME

public static final int OP_TYPE_CLEAR_PW_CHANGED_BY_REQUIRED_TIME
The operation type that may be used to clear the last time that the user's password was changed during a required change period.

See Also:
Constant Field Values

OP_TYPE_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIME

public static final int OP_TYPE_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIME
The operation type that may be used to get the length of time in seconds until the user's account will be locked due to a failure to change the password by a required time.

See Also:
Constant Field Values

OP_TYPE_GET_PW_HISTORY

public static final int OP_TYPE_GET_PW_HISTORY
The operation type that may be used to retrieve the stored password history values for a user.

See Also:
Constant Field Values

OP_TYPE_CLEAR_PW_HISTORY

public static final int OP_TYPE_CLEAR_PW_HISTORY
The operation type that may be used to clear the stored password history values for a user.

See Also:
Constant Field Values

OP_TYPE_HAS_RETIRED_PASSWORD

public static final int OP_TYPE_HAS_RETIRED_PASSWORD
The operation type that may be used to determine whether a user has a valid retired password.

See Also:
Constant Field Values

OP_TYPE_GET_PASSWORD_RETIRED_TIME

public static final int OP_TYPE_GET_PASSWORD_RETIRED_TIME
The operation type that may be used to retrieve the time that the user's former password was retired.

See Also:
Constant Field Values

OP_TYPE_GET_RETIRED_PASSWORD_EXPIRATION_TIME

public static final int OP_TYPE_GET_RETIRED_PASSWORD_EXPIRATION_TIME
The operation type that may be used to retrieve the time that the user's retired password will expire.

See Also:
Constant Field Values

OP_TYPE_PURGE_RETIRED_PASSWORD

public static final int OP_TYPE_PURGE_RETIRED_PASSWORD
The operation type that may be used to purge any retired password from the user's entry.

See Also:
Constant Field Values
Constructor Detail

PasswordPolicyStateOperation

public PasswordPolicyStateOperation(int opType)
Creates a new password policy state operation with the specified operation type and no values.

Parameters:
opType - The operation type for this password policy state operation.

PasswordPolicyStateOperation

public PasswordPolicyStateOperation(int opType,
                                    ASN1OctetString[] values)
Creates a new password policy state operation with the specified operation type and set of values.

Parameters:
opType - The operation type for this password policy state operation.
values - The set of values for this password policy state operation.
Method Detail

createGetPasswordPolicyDNOperation

public static PasswordPolicyStateOperation createGetPasswordPolicyDNOperation()
Creates a new password policy state operation that may be used to request the DN of the password policy configuration entry for the user.

Returns:
The created password policy state operation.

createGetAccountDisabledStateOperation

public static PasswordPolicyStateOperation createGetAccountDisabledStateOperation()
Creates a new password policy state operation that may be used to determine whether the user account is disabled.

Returns:
The created password policy state operation.

createSetAccountDisabledStateOperation

public static PasswordPolicyStateOperation createSetAccountDisabledStateOperation(boolean isDisabled)
Creates a new password policy state operation that may be used to specify whether the user account is disabled.

Parameters:
isDisabled - Indicates whether the user account should be disabled.
Returns:
The created password policy state operation.

createClearAccountDisabledStateOperation

public static PasswordPolicyStateOperation createClearAccountDisabledStateOperation()
Creates a new password policy state operation that may be used to clear the user account disabled state in the user's entry.

Returns:
The created password policy state operation.

createGetAccountExpirationTimeOperation

public static PasswordPolicyStateOperation createGetAccountExpirationTimeOperation()
Creates a new password policy state operation that may be used to retrieve the time that the user's account expires.

Returns:
The created password policy state operation.

createSetAccountExpirationTimeOperation

public static PasswordPolicyStateOperation createSetAccountExpirationTimeOperation(java.util.Date expirationTime)
Creates a new password policy state operation that may be used to set the time that the user's account expires.

Parameters:
expirationTime - The time that the user's account should expire.
Returns:
The created password policy state operation.

createClearAccountExpirationTimeOperation

public static PasswordPolicyStateOperation createClearAccountExpirationTimeOperation()
Creates a new password policy state operation that may be used to clear the account expiration time in the user's entry.

Returns:
The created password policy state operation.

createGetSecondsUntilAccountExpirationOperation

public static PasswordPolicyStateOperation createGetSecondsUntilAccountExpirationOperation()
Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's account is expired.

Returns:
The created password policy state operation.

createGetPasswordChangedTimeOperation

public static PasswordPolicyStateOperation createGetPasswordChangedTimeOperation()
Creates a new password policy state operation that may be used to determine when the user's password was last changed.

Returns:
The created password policy state operation.

createGetPasswordExpirationWarnedTimeOperation

public static PasswordPolicyStateOperation createGetPasswordExpirationWarnedTimeOperation()
Creates a new password policy state operation that may be used to determine when the user first received a password expiration warning.

Returns:
The created password policy state operation.

createClearPasswordExpirationWarnedTimeOperation

public static PasswordPolicyStateOperation createClearPasswordExpirationWarnedTimeOperation()
Creates a new password policy state operation that may be used to clear the password expiration warned time from the user's entry.

Returns:
The created password policy state operation.

createGetSecondsUntilPasswordExpirationOperation

public static PasswordPolicyStateOperation createGetSecondsUntilPasswordExpirationOperation()
Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's password expires.

Returns:
The created password policy state operation.

createGetSecondsUntilPasswordExpirationWarningOperation

public static PasswordPolicyStateOperation createGetSecondsUntilPasswordExpirationWarningOperation()
Creates a new password policy state operation that may be used to determine the length of time in seconds until the user is eligible to start receiving password expiration warnings.

Returns:
The created password policy state operation.

createGetAuthenticationFailureTimesOperation

public static PasswordPolicyStateOperation createGetAuthenticationFailureTimesOperation()
Creates a new password policy state operation that may be used to retrieve the times that the user has unsuccessfully tried to authenticate since the last successful authentication.

Returns:
The created password policy state operation.

createAddAuthenticationFailureTimeOperation

public static PasswordPolicyStateOperation createAddAuthenticationFailureTimeOperation()
Creates a new password policy state operation that may be used to add the current time to the set of times that the user has unsuccessfully tried to authenticate since the last successful authentication.

Returns:
The created password policy state operation.

createSetAuthenticationFailureTimesOperation

public static PasswordPolicyStateOperation createSetAuthenticationFailureTimesOperation(java.util.Date[] authFailureTimes)
Creates a new password policy state operation that may be used to specify the set of times that the user has unsuccessfully tried to authenticate since the last successful authentication.

Parameters:
authFailureTimes - The set of times that the user has unsuccessfully tried to authenticate since the last successful authentication.
Returns:
The created password policy state operation.

createClearAuthenticationFailureTimesOperation

public static PasswordPolicyStateOperation createClearAuthenticationFailureTimesOperation()
Creates a new password policy state operation that may be used to clear the set of times that the user has unsuccessfully tried to authenticate since the last successful authentication.

Returns:
The created password policy state operation.

createGetSecondsUntilAuthenticationFailureUnlockOperation

public static PasswordPolicyStateOperation createGetSecondsUntilAuthenticationFailureUnlockOperation()
Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's account is automatically unlocked after too many failed authentication attempts.

Returns:
The created password policy state operation.

createGetRemainingAuthenticationFailureCountOperation

public static PasswordPolicyStateOperation createGetRemainingAuthenticationFailureCountOperation()
Creates a new password policy state operation that may be used to determine the number of authentication failures required to lock the user's account.

Returns:
The created password policy state operation.

createGetLastLoginTimeOperation

public static PasswordPolicyStateOperation createGetLastLoginTimeOperation()
Creates a new password policy state operation that may be used to determine the time that the user last successfully authenticated to the server.

Returns:
The created password policy state operation.

createSetLastLoginTimeOperation

public static PasswordPolicyStateOperation createSetLastLoginTimeOperation(java.util.Date lastLoginTime)
Creates a new password policy state operation that may be used to set the time that the user last successfully authenticated to the server.

Parameters:
lastLoginTime - The last login time to set in the user's entry.
Returns:
The created password policy state operation.

createClearLastLoginTimeOperation

public static PasswordPolicyStateOperation createClearLastLoginTimeOperation()
Creates a new password policy state operation that may be used to clear the last login time time from the user's entry.

Returns:
The created password policy state operation.

createGetSecondsUntilIdleLockoutOperation

public static PasswordPolicyStateOperation createGetSecondsUntilIdleLockoutOperation()
Creates a new password policy state operation that may be used to determine the length of time in seconds until the user's account is locked due to inactivity.

Returns:
The created password policy state operation.

createGetPasswordResetStateOperation

public static PasswordPolicyStateOperation createGetPasswordResetStateOperation()
Creates a new password policy state operation that may be used to determine whether the user's password has been reset by an administrator and must be changed before performing any other operations.

Returns:
The created password policy state operation.

createSetPasswordResetStateOperation

public static PasswordPolicyStateOperation createSetPasswordResetStateOperation(boolean isReset)
Creates a new password policy state operation that may be used to specify whether the user's password has been reset by an administrator and must be changed before performing any other operations.

Parameters:
isReset - Specifies whether the user's password must be changed before performing any other operations.
Returns:
The created password policy state operation.

createClearPasswordResetStateOperation

public static PasswordPolicyStateOperation createClearPasswordResetStateOperation()
Creates a new password policy state operation that may be used to clear the password reset state information in the user's entry.

Returns:
The created password policy state operation.

createGetSecondsUntilPasswordResetLockoutOperation

public static PasswordPolicyStateOperation createGetSecondsUntilPasswordResetLockoutOperation()
Creates a new password policy state operation that may be used to determine the length of time in seconds that the user has left to change his/her password after an administrative reset before the account is locked.

Returns:
The created password policy state operation.

createGetGraceLoginUseTimesOperation

public static PasswordPolicyStateOperation createGetGraceLoginUseTimesOperation()
Creates a new password policy state operation that may be used to retrieve the set of times that the user has authenticated using grace logins since his/her password expired.

Returns:
The created password policy state operation.

createAddGraceLoginUseTimeOperation

public static PasswordPolicyStateOperation createAddGraceLoginUseTimeOperation()
Creates a new password policy state operation that may be used to add the current time to the set of times that the user has authenticated using grace logins since his/her password expired.

Returns:
The created password policy state operation.

createSetGraceLoginUseTimesOperation

public static PasswordPolicyStateOperation createSetGraceLoginUseTimesOperation(java.util.Date[] graceLoginUseTimes)
Creates a new password policy state operation that may be used to specify the set of times that the user has authenticated using grace logins since his/her password expired.

Parameters:
graceLoginUseTimes - The set of times that the user has authenticated using grace logins since his/her password expired.
Returns:
The created password policy state operation.

createClearGraceLoginUseTimesOperation

public static PasswordPolicyStateOperation createClearGraceLoginUseTimesOperation()
Creates a new password policy state operation that may be used to clear the set of times that the user has authenticated using grace logins since his/her password expired.

Returns:
The created password policy state operation.

createGetRemainingGraceLoginCountOperation

public static PasswordPolicyStateOperation createGetRemainingGraceLoginCountOperation()
Creates a new password policy state operation that may be used to retrieve the number of remaining grace logins available to the user.

Returns:
The created password policy state operation.

createGetPasswordChangedByRequiredTimeOperation

public static PasswordPolicyStateOperation createGetPasswordChangedByRequiredTimeOperation()
Creates a new password policy state operation that may be used to retrieve the last required password change time that with which the user has complied.

Returns:
The created password policy state operation.

createSetPasswordChangedByRequiredTimeOperation

public static PasswordPolicyStateOperation createSetPasswordChangedByRequiredTimeOperation()
Creates a new password policy state operation that may be used to update the user's entry to indicate that he/she has complied with the required password change time.

Returns:
The created password policy state operation.

createClearPasswordChangedByRequiredTimeOperation

public static PasswordPolicyStateOperation createClearPasswordChangedByRequiredTimeOperation()
Creates a new password policy state operation that may be used to clear the last required password change time from the user's entry.

Returns:
The created password policy state operation.

createGetSecondsUntilRequiredChangeTimeOperation

public static PasswordPolicyStateOperation createGetSecondsUntilRequiredChangeTimeOperation()
Creates a new password policy state operation that may be used to retrieve the length of time in seconds until the required password change time arrives.

Returns:
The created password policy state operation.

createGetPasswordHistoryOperation

public static PasswordPolicyStateOperation createGetPasswordHistoryOperation()
Creates a new password policy state operation that may be used to retrieve the password history values stored in the user's entry.

Returns:
The created password policy state operation.

createClearPasswordHistoryOperation

public static PasswordPolicyStateOperation createClearPasswordHistoryOperation()
Creates a new password policy state operation that may be used to clear the password history values stored in the user's entry.

Returns:
The created password policy state operation.

createHasRetiredPasswordOperation

public static PasswordPolicyStateOperation createHasRetiredPasswordOperation()
Creates a new password policy state operation that may be used to determine whether the user has a valid retired password.

Returns:
The created password policy state operation.

createGetPasswordRetiredTimeOperation

public static PasswordPolicyStateOperation createGetPasswordRetiredTimeOperation()
Creates a new password policy state operation that may be used to determine the time that the user's former password was retired.

Returns:
The created password policy state operation.

createGetRetiredPasswordExpirationTimeOperation

public static PasswordPolicyStateOperation createGetRetiredPasswordExpirationTimeOperation()
Creates a new password policy state operation that may be used to determine the length of time until the user's retired password expires.

Returns:
The created password policy state operation.

createPurgeRetiredPasswordOperation

public static PasswordPolicyStateOperation createPurgeRetiredPasswordOperation()
Creates a new password policy state operation that may be used to purge any retired password from the user's entry.

Returns:
The created password policy state operation.

getOperationType

public int getOperationType()
Retrieves the operation type for this password policy state operation.

Returns:
The operation type for this password policy state operation.

getRawValues

public ASN1OctetString[] getRawValues()
Retrieves the set of raw values for this password policy state operation.

Returns:
The set of raw values for this password policy state operation.

getStringValue

public java.lang.String getStringValue()
Retrieves the string representation of the value for this password policy state operation. If there are multiple values, then the first will be returned.

Returns:
The string representation of the value for this password policy state operation, or null if there are no values.

getStringValues

public java.lang.String[] getStringValues()
Retrieves the string representations of the values for this password policy state operation.

Returns:
The string representations of the values for this password policy state operation.

getBooleanValue

public boolean getBooleanValue()
                        throws java.lang.IllegalStateException
Retrieves the boolean representation of the value for this password policy state operation.

Returns:
The boolean representation of the value for this password policy state operation.
Throws:
java.lang.IllegalStateException - If this operation does not have exactly one value, or if the value cannot be decoded as a boolean value.

getIntValue

public int getIntValue()
                throws java.lang.IllegalStateException,
                       java.lang.NumberFormatException
Retrieves the integer representation of the value for this password policy state operation. If there are multiple values, then the first will be returned.

Returns:
The integer representation of the value for this password policy operation.
Throws:
java.lang.IllegalStateException - If this operation does not have any values.
java.lang.NumberFormatException - If the value cannot be parsed as an integer.

getGeneralizedTimeValue

public java.util.Date getGeneralizedTimeValue()
                                       throws java.text.ParseException
Retrieves the Date object represented by the value for this password policy state operation treated as a timestamp in generalized time form. If there are multiple values, then the first will be returned.

Returns:
The Date object represented by the value for this password policy state operation treated as a timestamp in generalized time form, or null if this operation does not have any values.
Throws:
java.text.ParseException - If the value cannot be decoded as a timestamp in generalized time form.

getGeneralizedTimeValues

public java.util.Date[] getGeneralizedTimeValues()
                                          throws java.text.ParseException
Retrieves the Date objects represented by the values for this password policy state operation treated as timestamps in generalized time form.

Returns:
The Date objects represented by the values for this password policy state operation treated as timestamps in generalized time form.
Throws:
java.text.ParseException - If any of the values cannot be decoded as a timestamp in generalized time form.

encode

public ASN1Element encode()
Encodes this password policy state operation for use in the extended request or response.

Returns:
An ASN.1 element containing an encoded representation of this password policy state operation.

decode

public static PasswordPolicyStateOperation decode(ASN1Element element)
                                           throws LDAPException
Decodes the provided ASN.1 element as a password policy state operation.

Parameters:
element - The ASN.1 element to be decoded.
Returns:
The decoded password policy state operation.
Throws:
LDAPException - If a problem occurs while attempting to decode the provided ASN.1 element as a password policy state operation.

toString

public java.lang.String toString()
Retrieves a string representation of this password policy state operation.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this password policy state operation.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this password policy state operation to the provided buffer.

Parameters:
buffer - The buffer to which the information should be appended.