Package org.opends.server.extensions
Class PasswordPolicyStateExtendedOperation
java.lang.Object
org.opends.server.api.ExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>
org.opends.server.extensions.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:
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).
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 Summary
Modifier and TypeFieldDescriptionstatic final int
The enumerated value for the addAuthenticationFailureTime operation.static final int
The enumerated value for the addGraceLoginUseTime operation.static final int
The enumerated value for the clearAccountDisabledState operation.static final int
The enumerated value for the clearAccountExpirationTime operation.static final int
The enumerated value for the clearAuthenticationFailureTimes operation.static final int
The enumerated value for the clearGraceLoginUseTimes operation.static final int
The enumerated value for the clearLastLoginTime operation.static final int
The enumerated value for the clearPasswordChangedByRequiredTime operation.static final int
The enumerated value for the clearPasswordChangedTime operation.static final int
The enumerated value for the clearPasswordExpirationWarnedTime operation.static final int
The enumerated value for the clearPasswordHistory operation.static final int
The enumerated value for the clearPasswordResetState operation.static final int
The enumerated value for the getAccountDisabledState operation.static final int
The enumerated value for the getAccountExpirationTime operation.static final int
The enumerated value for the getAuthenticationFailureTimes operation.static final int
The enumerated value for the getGraceLoginUseTimes operation.static final int
The enumerated value for the getLastLoginTime operation.static final int
The enumerated value for the getPasswordChangedByRequiredTime operation.static final int
The enumerated value for the getPasswordChangedTime operation.static final int
The enumerated value for the getPasswordExpirationWarnedTime operation.static final int
Deprecated.static final int
The enumerated value for the getPasswordPolicyDN operation.static final int
The enumerated value for the getPasswordResetState operation.static final int
The enumerated value for the getRemainingAuthenticationFailureCount operation.static final int
The enumerated value for the getRemainingGraceLoginCount operation.static final int
The enumerated value for the getSecondsUntilAccountExpiration operation.static final int
The enumerated value for the getSecondsUntilAuthenticationFailureUnlock operation.static final int
The enumerated value for the getSecondsUntilIdleLockout operation.static final int
The enumerated value for the getSecondsUntilPasswordExpiration operation.static final int
The enumerated value for the getSecondsUntilPasswordExpirationWarning operation.static final int
The enumerated value for the getSecondsUntilPasswordResetLockout operation.static final int
The enumerated value for the getSecondsUntilRequiredChangeTime operation.static final int
The enumerated value for the setAccountDisabledState operation.static final int
The enumerated value for the setAccountExpirationTime operation.static final int
The enumerated value for the setAuthenticationFailureTimes operation.static final int
The enumerated value for the setGraceLoginUseTimes operation.static final int
The enumerated value for the setLastLoginTime operation.static final int
The enumerated value for the setPasswordChangedByRequiredTime operation.static final int
The enumerated value for the setPasswordChangedTime operation.static final int
The enumerated value for the setPasswordExpirationWarnedTime operation.static final int
The enumerated value for the setPasswordResetState operation. -
Constructor Summary
ConstructorDescriptionCreate an instance of this password policy state extended operation. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Performs any finalization that may be necessary for this extended operation handler.Retrieves the name associated with this extended operation.Retrieves the object OID associated with this extended operation.void
Initializes this extended operation handler based on the information in the provided configuration entry.void
processExtendedOperation
(ExtendedOperation operation) Processes the provided extended operation.Methods inherited from class org.opends.server.api.ExtendedOperationHandler
getServerContext, getSupportedControls, getSupportedFeatures, isConfigurationAcceptable, supportsControl
-
Field Details
-
OP_GET_PASSWORD_POLICY_DN
public static final int OP_GET_PASSWORD_POLICY_DNThe enumerated value for the getPasswordPolicyDN operation.- See Also:
-
OP_GET_ACCOUNT_DISABLED_STATE
public static final int OP_GET_ACCOUNT_DISABLED_STATEThe enumerated value for the getAccountDisabledState operation.- See Also:
-
OP_SET_ACCOUNT_DISABLED_STATE
public static final int OP_SET_ACCOUNT_DISABLED_STATEThe enumerated value for the setAccountDisabledState operation.- See Also:
-
OP_CLEAR_ACCOUNT_DISABLED_STATE
public static final int OP_CLEAR_ACCOUNT_DISABLED_STATEThe enumerated value for the clearAccountDisabledState operation.- See Also:
-
OP_GET_ACCOUNT_EXPIRATION_TIME
public static final int OP_GET_ACCOUNT_EXPIRATION_TIMEThe enumerated value for the getAccountExpirationTime operation.- See Also:
-
OP_SET_ACCOUNT_EXPIRATION_TIME
public static final int OP_SET_ACCOUNT_EXPIRATION_TIMEThe enumerated value for the setAccountExpirationTime operation.- See Also:
-
OP_CLEAR_ACCOUNT_EXPIRATION_TIME
public static final int OP_CLEAR_ACCOUNT_EXPIRATION_TIMEThe enumerated value for the clearAccountExpirationTime operation.- See Also:
-
OP_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATION
public static final int OP_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATIONThe enumerated value for the getSecondsUntilAccountExpiration operation.- See Also:
-
OP_GET_PASSWORD_CHANGED_TIME
public static final int OP_GET_PASSWORD_CHANGED_TIMEThe enumerated value for the getPasswordChangedTime operation.- See Also:
-
OP_SET_PASSWORD_CHANGED_TIME
public static final int OP_SET_PASSWORD_CHANGED_TIMEThe enumerated value for the setPasswordChangedTime operation.- See Also:
-
OP_CLEAR_PASSWORD_CHANGED_TIME
public static final int OP_CLEAR_PASSWORD_CHANGED_TIMEThe enumerated value for the clearPasswordChangedTime operation.- See Also:
-
OP_GET_PASSWORD_EXPIRATION_WARNED_TIME
public static final int OP_GET_PASSWORD_EXPIRATION_WARNED_TIMEThe enumerated value for the getPasswordExpirationWarnedTime operation.- See Also:
-
OP_SET_PASSWORD_EXPIRATION_WARNED_TIME
public static final int OP_SET_PASSWORD_EXPIRATION_WARNED_TIMEThe enumerated value for the setPasswordExpirationWarnedTime operation.- See Also:
-
OP_CLEAR_PASSWORD_EXPIRATION_WARNED_TIME
public static final int OP_CLEAR_PASSWORD_EXPIRATION_WARNED_TIMEThe enumerated value for the clearPasswordExpirationWarnedTime operation.- See Also:
-
OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION
public static final int OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATIONThe enumerated value for the getSecondsUntilPasswordExpiration operation.- See Also:
-
OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION_WARNING
public static final int OP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION_WARNINGThe enumerated value for the getSecondsUntilPasswordExpirationWarning operation.- See Also:
-
OP_GET_AUTHENTICATION_FAILURE_TIMES
public static final int OP_GET_AUTHENTICATION_FAILURE_TIMESThe enumerated value for the getAuthenticationFailureTimes operation.- See Also:
-
OP_ADD_AUTHENTICATION_FAILURE_TIME
public static final int OP_ADD_AUTHENTICATION_FAILURE_TIMEThe enumerated value for the addAuthenticationFailureTime operation.- See Also:
-
OP_SET_AUTHENTICATION_FAILURE_TIMES
public static final int OP_SET_AUTHENTICATION_FAILURE_TIMESThe enumerated value for the setAuthenticationFailureTimes operation.- See Also:
-
OP_CLEAR_AUTHENTICATION_FAILURE_TIMES
public static final int OP_CLEAR_AUTHENTICATION_FAILURE_TIMESThe enumerated value for the clearAuthenticationFailureTimes operation.- See Also:
-
OP_GET_SECONDS_UNTIL_AUTHENTICATION_FAILURE_UNLOCK
public static final int OP_GET_SECONDS_UNTIL_AUTHENTICATION_FAILURE_UNLOCKThe enumerated value for the getSecondsUntilAuthenticationFailureUnlock operation.- See Also:
-
OP_GET_REMAINING_AUTHENTICATION_FAILURE_COUNT
public static final int OP_GET_REMAINING_AUTHENTICATION_FAILURE_COUNTThe enumerated value for the getRemainingAuthenticationFailureCount operation.- See Also:
-
OP_GET_LAST_LOGIN_TIME
public static final int OP_GET_LAST_LOGIN_TIMEThe enumerated value for the getLastLoginTime operation.- See Also:
-
OP_SET_LAST_LOGIN_TIME
public static final int OP_SET_LAST_LOGIN_TIMEThe enumerated value for the setLastLoginTime operation.- See Also:
-
OP_CLEAR_LAST_LOGIN_TIME
public static final int OP_CLEAR_LAST_LOGIN_TIMEThe enumerated value for the clearLastLoginTime operation.- See Also:
-
OP_GET_SECONDS_UNTIL_IDLE_LOCKOUT
public static final int OP_GET_SECONDS_UNTIL_IDLE_LOCKOUTThe enumerated value for the getSecondsUntilIdleLockout operation.- See Also:
-
OP_GET_PASSWORD_RESET_STATE
public static final int OP_GET_PASSWORD_RESET_STATEThe enumerated value for the getPasswordResetState operation.- See Also:
-
OP_SET_PASSWORD_RESET_STATE
public static final int OP_SET_PASSWORD_RESET_STATEThe enumerated value for the setPasswordResetState operation.- See Also:
-
OP_CLEAR_PASSWORD_RESET_STATE
public static final int OP_CLEAR_PASSWORD_RESET_STATEThe enumerated value for the clearPasswordResetState operation.- See Also:
-
OP_GET_SECONDS_UNTIL_PASSWORD_RESET_LOCKOUT
public static final int OP_GET_SECONDS_UNTIL_PASSWORD_RESET_LOCKOUTThe enumerated value for the getSecondsUntilPasswordResetLockout operation.- See Also:
-
OP_GET_GRACE_LOGIN_USE_TIMES
public static final int OP_GET_GRACE_LOGIN_USE_TIMESThe enumerated value for the getGraceLoginUseTimes operation.- See Also:
-
OP_ADD_GRACE_LOGIN_USE_TIME
public static final int OP_ADD_GRACE_LOGIN_USE_TIMEThe enumerated value for the addGraceLoginUseTime operation.- See Also:
-
OP_SET_GRACE_LOGIN_USE_TIMES
public static final int OP_SET_GRACE_LOGIN_USE_TIMESThe enumerated value for the setGraceLoginUseTimes operation.- See Also:
-
OP_CLEAR_GRACE_LOGIN_USE_TIMES
public static final int OP_CLEAR_GRACE_LOGIN_USE_TIMESThe enumerated value for the clearGraceLoginUseTimes operation.- See Also:
-
OP_GET_REMAINING_GRACE_LOGIN_COUNT
public static final int OP_GET_REMAINING_GRACE_LOGIN_COUNTThe enumerated value for the getRemainingGraceLoginCount operation.- See Also:
-
OP_GET_PASSWORD_CHANGED_BY_REQUIRED_TIME
public static final int OP_GET_PASSWORD_CHANGED_BY_REQUIRED_TIMEThe enumerated value for the getPasswordChangedByRequiredTime operation.- See Also:
-
OP_SET_PASSWORD_CHANGED_BY_REQUIRED_TIME
public static final int OP_SET_PASSWORD_CHANGED_BY_REQUIRED_TIMEThe enumerated value for the setPasswordChangedByRequiredTime operation.- See Also:
-
OP_CLEAR_PASSWORD_CHANGED_BY_REQUIRED_TIME
public static final int OP_CLEAR_PASSWORD_CHANGED_BY_REQUIRED_TIMEThe enumerated value for the clearPasswordChangedByRequiredTime operation.- See Also:
-
OP_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIME
public static final int OP_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIMEThe enumerated value for the getSecondsUntilRequiredChangeTime operation.- See Also:
-
OP_GET_PASSWORD_HISTORY
Deprecated.The enumerated value for the getPasswordHistory operation. Now deprecated as it is insecure.- See Also:
-
OP_CLEAR_PASSWORD_HISTORY
public static final int OP_CLEAR_PASSWORD_HISTORYThe enumerated value for the clearPasswordHistory operation.- See Also:
-
-
Constructor Details
-
PasswordPolicyStateExtendedOperation
public PasswordPolicyStateExtendedOperation()Create an instance of this password policy state extended operation. All initialization should be performed in theinitializeExtendedOperationHandler
method.
-
-
Method Details
-
initializeExtendedOperationHandler
public void initializeExtendedOperationHandler(PasswordPolicyStateExtendedOperationHandlerCfg config) Description copied from class:ExtendedOperationHandler
Initializes this extended operation handler based on the information in the provided configuration entry. It should also register itself with the Directory Server for the particular kinds of extended operations that it will process.- Overrides:
initializeExtendedOperationHandler
in classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>
- Parameters:
config
- The extended operation handler configuration that contains the information to use to initialize this extended operation handler.
-
finalizeExtendedOperationHandler
public void finalizeExtendedOperationHandler()Description copied from class:ExtendedOperationHandler
Performs any finalization that may be necessary for this extended operation handler. By default, no finalization is performed. -
processExtendedOperation
Description copied from class:ExtendedOperationHandler
Processes the provided extended operation.- Specified by:
processExtendedOperation
in classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>
- Parameters:
operation
- The extended operation to be processed.- Throws:
LdapException
- If the extended operation failed. The exception's result will be returned to the client.
-
getExtendedOperationOID
Description copied from class:ExtendedOperationHandler
Retrieves the object OID associated with this extended operation.- Specified by:
getExtendedOperationOID
in classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>
- Returns:
- the oid associated with this extended operation, if any, or
null
if there is none.
-
getExtendedOperationName
Description copied from class:ExtendedOperationHandler
Retrieves the name associated with this extended operation.- Specified by:
getExtendedOperationName
in classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>
- Returns:
- The name associated with this extended operation, if any, or
null
if there is none.
-