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

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPRequest
      extended by com.unboundid.ldap.sdk.ExtendedRequest
          extended by com.unboundid.ldap.sdk.unboundidds.extensions.PasswordPolicyStateExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@NotMutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class PasswordPolicyStateExtendedRequest
extends ExtendedRequest

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 provides an implementation of the password policy state extended request as used in the UnboundID Directory Server. It may be used to retrieve and/or alter password policy properties for a user account. See the documentation in the PasswordPolicyStateOperation class for information about the types of operations that can be performed.

Example

The following example demonstrates the use of the password policy state extended operation to administratively disable a user's account:
 PasswordPolicyStateOperation disableOp =
      PasswordPolicyStateOperation.createSetAccountDisabledStateOperation(
           true);
 PasswordPolicyStateExtendedRequest pwpStateRequest =
      new PasswordPolicyStateExtendedRequest(
               "uid=john.doe,ou=People,dc=example,dc=com", disableOp);
 PasswordPolicyStateExtendedResult pwpStateResult =
      (PasswordPolicyStateExtendedResult)
      connection.processExtendedOperation(pwpStateRequest);

 // NOTE:  The processExtendedOperation method will generally only throw an
 // exception if a problem occurs while trying to send the request or read
 // the response.  It will not throw an exception because of a non-success
 // response.

 if (pwpStateResult.getResultCode() == ResultCode.SUCCESS)
 {
   boolean isDisabled = pwpStateResult.getBooleanValue(
        PasswordPolicyStateOperation.OP_TYPE_GET_ACCOUNT_DISABLED_STATE);
   if (isDisabled)
   {
     // The user account has been disabled.
   }
   else
   {
     // The user account is not disabled.
   }
 }
 

See Also:
Serialized Form

Field Summary
static java.lang.String PASSWORD_POLICY_STATE_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.1.6.1) for the password policy state extended request.
 
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
 
Constructor Summary
PasswordPolicyStateExtendedRequest(ExtendedRequest extendedRequest)
          Creates a new password policy state extended request from the provided generic extended request.
PasswordPolicyStateExtendedRequest(java.lang.String userDN, Control[] controls, PasswordPolicyStateOperation... operations)
          Creates a new password policy state extended request with the provided user DN, optional set of operations, and optional set of controls.
PasswordPolicyStateExtendedRequest(java.lang.String userDN, PasswordPolicyStateOperation... operations)
          Creates a new password policy state extended request with the provided user DN and optional set of operations.
 
Method Summary
 PasswordPolicyStateExtendedRequest duplicate()
          Creates a new instance of this LDAP request that may be modified without impacting this request.
 PasswordPolicyStateExtendedRequest duplicate(Control[] controls)
          Creates a new instance of this LDAP request that may be modified without impacting this request.
 java.lang.String getExtendedRequestName()
          Retrieves the user-friendly name for the extended request, if available.
 PasswordPolicyStateOperation[] getOperations()
          Retrieves the set of password policy state operations to be processed.
 java.lang.String getUserDN()
          Retrieves the DN of the user account on which to operate.
 PasswordPolicyStateExtendedResult process(LDAPConnection connection, int depth)
          Sends this extended request to the directory server over the provided connection and returns the associated response.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this request to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, writeTo
 
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PASSWORD_POLICY_STATE_REQUEST_OID

public static final java.lang.String PASSWORD_POLICY_STATE_REQUEST_OID
The OID (1.3.6.1.4.1.30221.1.6.1) for the password policy state extended request.

See Also:
Constant Field Values
Constructor Detail

PasswordPolicyStateExtendedRequest

public PasswordPolicyStateExtendedRequest(java.lang.String userDN,
                                          PasswordPolicyStateOperation... operations)
Creates a new password policy state extended request with the provided user DN and optional set of operations.

Parameters:
userDN - The DN of the user account on which to operate.
operations - The set of password policy state operations to process. If no operations are provided, then the effect will be to retrieve the values of all available password policy state properties.

PasswordPolicyStateExtendedRequest

public PasswordPolicyStateExtendedRequest(java.lang.String userDN,
                                          Control[] controls,
                                          PasswordPolicyStateOperation... operations)
Creates a new password policy state extended request with the provided user DN, optional set of operations, and optional set of controls.

Parameters:
userDN - The DN of the user account on which to operate.
controls - The set of controls to include in the request.
operations - The set of password policy state operations to process. If no operations are provided, then the effect will be to retrieve the values of all available password policy state properties.

PasswordPolicyStateExtendedRequest

public PasswordPolicyStateExtendedRequest(ExtendedRequest extendedRequest)
                                   throws LDAPException
Creates a new password policy state extended request from the provided generic extended request.

Parameters:
extendedRequest - The generic extended request to use to create this password policy state extended request.
Throws:
LDAPException - If a problem occurs while decoding the request.
Method Detail

getUserDN

public java.lang.String getUserDN()
Retrieves the DN of the user account on which to operate.

Returns:
The DN of the user account on which to operate.

getOperations

public PasswordPolicyStateOperation[] getOperations()
Retrieves the set of password policy state operations to be processed.

Returns:
The set of password policy state operations to be processed, or an empty list if the values of all password policy state properties should be retrieved.

process

public PasswordPolicyStateExtendedResult process(LDAPConnection connection,
                                                 int depth)
                                          throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.

Overrides:
process in class ExtendedRequest
Parameters:
connection - The connection to use to communicate with the directory server.
depth - The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.
Returns:
An LDAP result object that provides information about the result of the extended operation processing.
Throws:
LDAPException - If a problem occurs while sending the request or reading the response.

duplicate

public PasswordPolicyStateExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.

Specified by:
duplicate in interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

duplicate

public PasswordPolicyStateExtendedRequest duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.

Specified by:
duplicate in interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Parameters:
controls - The set of controls to include in the duplicate request.
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

getExtendedRequestName

public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getExtendedRequestName in class ExtendedRequest
Returns:
The user-friendly name for this extended request, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.

Specified by:
toString in interface ProtocolOp
Specified by:
toString in interface ReadOnlyLDAPRequest
Overrides:
toString in class ExtendedRequest
Parameters:
buffer - The buffer to which to append a string representation of this request.