Package org.opends.server.extensions
Class PasswordPolicyStateExtendedOperation
- java.lang.Object
-
- org.opends.server.api.ExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>
-
- org.opends.server.extensions.PasswordPolicyStateExtendedOperation
-
public 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), 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
Fields Modifier and Type Field Description static intOP_ADD_AUTHENTICATION_FAILURE_TIMEThe enumerated value for the addAuthenticationFailureTime operation.static intOP_ADD_GRACE_LOGIN_USE_TIMEThe enumerated value for the addGraceLoginUseTime operation.static intOP_CLEAR_ACCOUNT_DISABLED_STATEThe enumerated value for the clearAccountDisabledState operation.static intOP_CLEAR_ACCOUNT_EXPIRATION_TIMEThe enumerated value for the clearAccountExpirationTime operation.static intOP_CLEAR_AUTHENTICATION_FAILURE_TIMESThe enumerated value for the clearAuthenticationFailureTimes operation.static intOP_CLEAR_GRACE_LOGIN_USE_TIMESThe enumerated value for the clearGraceLoginUseTimes operation.static intOP_CLEAR_LAST_LOGIN_TIMEThe enumerated value for the clearLastLoginTime operation.static intOP_CLEAR_PASSWORD_CHANGED_BY_REQUIRED_TIMEThe enumerated value for the clearPasswordChangedByRequiredTime operation.static intOP_CLEAR_PASSWORD_CHANGED_TIMEThe enumerated value for the clearPasswordChangedTime operation.static intOP_CLEAR_PASSWORD_EXPIRATION_WARNED_TIMEThe enumerated value for the clearPasswordExpirationWarnedTime operation.static intOP_CLEAR_PASSWORD_HISTORYThe enumerated value for the clearPasswordHistory operation.static intOP_CLEAR_PASSWORD_RESET_STATEThe enumerated value for the clearPasswordResetState operation.static intOP_GET_ACCOUNT_DISABLED_STATEThe enumerated value for the getAccountDisabledState operation.static intOP_GET_ACCOUNT_EXPIRATION_TIMEThe enumerated value for the getAccountExpirationTime operation.static intOP_GET_AUTHENTICATION_FAILURE_TIMESThe enumerated value for the getAuthenticationFailureTimes operation.static intOP_GET_GRACE_LOGIN_USE_TIMESThe enumerated value for the getGraceLoginUseTimes operation.static intOP_GET_LAST_LOGIN_TIMEThe enumerated value for the getLastLoginTime operation.static intOP_GET_PASSWORD_CHANGED_BY_REQUIRED_TIMEThe enumerated value for the getPasswordChangedByRequiredTime operation.static intOP_GET_PASSWORD_CHANGED_TIMEThe enumerated value for the getPasswordChangedTime operation.static intOP_GET_PASSWORD_EXPIRATION_WARNED_TIMEThe enumerated value for the getPasswordExpirationWarnedTime operation.static intOP_GET_PASSWORD_HISTORYThe enumerated value for the getPasswordHistory operation.static intOP_GET_PASSWORD_POLICY_DNThe enumerated value for the getPasswordPolicyDN operation.static intOP_GET_PASSWORD_RESET_STATEThe enumerated value for the getPasswordResetState operation.static intOP_GET_REMAINING_AUTHENTICATION_FAILURE_COUNTThe enumerated value for the getRemainingAuthenticationFailureCount operation.static intOP_GET_REMAINING_GRACE_LOGIN_COUNTThe enumerated value for the getRemainingGraceLoginCount operation.static intOP_GET_SECONDS_UNTIL_ACCOUNT_EXPIRATIONThe enumerated value for the getSecondsUntilAccountExpiration operation.static intOP_GET_SECONDS_UNTIL_AUTHENTICATION_FAILURE_UNLOCKThe enumerated value for the getSecondsUntilAuthenticationFailureUnlock operation.static intOP_GET_SECONDS_UNTIL_IDLE_LOCKOUTThe enumerated value for the getSecondsUntilIdleLockout operation.static intOP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATIONThe enumerated value for the getSecondsUntilPasswordExpiration operation.static intOP_GET_SECONDS_UNTIL_PASSWORD_EXPIRATION_WARNINGThe enumerated value for the getSecondsUntilPasswordExpirationWarning operation.static intOP_GET_SECONDS_UNTIL_PASSWORD_RESET_LOCKOUTThe enumerated value for the getSecondsUntilPasswordResetLockout operation.static intOP_GET_SECONDS_UNTIL_REQUIRED_CHANGE_TIMEThe enumerated value for the getSecondsUntilRequiredChangeTime operation.static intOP_SET_ACCOUNT_DISABLED_STATEThe enumerated value for the setAccountDisabledState operation.static intOP_SET_ACCOUNT_EXPIRATION_TIMEThe enumerated value for the setAccountExpirationTime operation.static intOP_SET_AUTHENTICATION_FAILURE_TIMESThe enumerated value for the setAuthenticationFailureTimes operation.static intOP_SET_GRACE_LOGIN_USE_TIMESThe enumerated value for the setGraceLoginUseTimes operation.static intOP_SET_LAST_LOGIN_TIMEThe enumerated value for the setLastLoginTime operation.static intOP_SET_PASSWORD_CHANGED_BY_REQUIRED_TIMEThe enumerated value for the setPasswordChangedByRequiredTime operation.static intOP_SET_PASSWORD_CHANGED_TIMEThe enumerated value for the setPasswordChangedTime operation.static intOP_SET_PASSWORD_EXPIRATION_WARNED_TIMEThe enumerated value for the setPasswordExpirationWarnedTime operation.static intOP_SET_PASSWORD_RESET_STATEThe enumerated value for the setPasswordResetState operation.
-
Constructor Summary
Constructors Constructor Description PasswordPolicyStateExtendedOperation()Create an instance of this password policy state extended operation.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static voidencode(ASN1Writer writer, int opType, String value)Encodes the provided information in a form suitable for including in the response value.static voidencode(ASN1Writer writer, int opType, String[] values)Encodes the provided information in a form suitable for including in the response value.static voidencode(ASN1Writer writer, int opType, List<Long> values)Encodes the provided information in a form suitable for including in the response value.StringgetExtendedOperationName()Retrieves the name associated with this extended operation.StringgetExtendedOperationOID()Retrieves the object OID associated with this extended operation.voidinitializeExtendedOperationHandler(PasswordPolicyStateExtendedOperationHandlerCfg config)Initializes this extended operation handler based on the information in the provided configuration entry.voidprocessExtendedOperation(ExtendedOperation operation)Processes the provided extended operation.-
Methods inherited from class org.opends.server.api.ExtendedOperationHandler
finalizeExtendedOperationHandler, getSupportedControls, getSupportedFeatures, isConfigurationAcceptable, supportsControl, supportsFeature
-
-
-
-
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
public static final int OP_GET_PASSWORD_HISTORY
The enumerated value for the getPasswordHistory operation.- 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
-
-
Method Detail
-
initializeExtendedOperationHandler
public void initializeExtendedOperationHandler(PasswordPolicyStateExtendedOperationHandlerCfg config) throws ConfigException, InitializationException
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:
initializeExtendedOperationHandlerin classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>- Parameters:
config- The configuration that contains the information to use to initialize this extended operation handler.- Throws:
ConfigException- If an unrecoverable problem arises in the process of performing the initialization.InitializationException- If a problem occurs during initialization that is not related to the server configuration.
-
processExtendedOperation
public void processExtendedOperation(ExtendedOperation operation)
Processes the provided extended operation.- Specified by:
processExtendedOperationin classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>- Parameters:
operation- The extended operation to be processed.
-
encode
public static void encode(ASN1Writer writer, int opType, String value) throws IOException
Encodes the provided information in a form suitable for including in the response value.- Parameters:
writer- The ASN1Writer to use to encode.opType- The operation type to use for the value.value- The single value to include in the response.- Throws:
IOException- if an error occurs while encoding.
-
encode
public static void encode(ASN1Writer writer, int opType, String[] values) throws IOException
Encodes the provided information in a form suitable for including in the response value.- Parameters:
writer- The ASN1Writer to use to encode.opType- The operation type to use for the value.values- The set of string values to include in the response.- Throws:
IOException- if an error occurs while encoding.
-
encode
public static void encode(ASN1Writer writer, int opType, List<Long> values) throws IOException
Encodes the provided information in a form suitable for including in the response value.- Parameters:
writer- The ASN1Writer to use to encode.opType- The operation type to use for the value.values- The set of timestamp values to include in the response.- Throws:
IOException- if an error occurs while encoding.
-
getExtendedOperationOID
public String getExtendedOperationOID()
Description copied from class:ExtendedOperationHandlerRetrieves the object OID associated with this extended operation.- Overrides:
getExtendedOperationOIDin classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>- Returns:
- the oid associated with this extended operation, if any, or
nullif there is none.
-
getExtendedOperationName
public String getExtendedOperationName()
Description copied from class:ExtendedOperationHandlerRetrieves the name associated with this extended operation.- Overrides:
getExtendedOperationNamein classExtendedOperationHandler<PasswordPolicyStateExtendedOperationHandlerCfg>- Returns:
- The name associated with this extended operation,
if any, or
nullif there is none.
-
-