|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.GetPasswordQualityRequirementsExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetPasswordQualityRequirementsExtendedRequest
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 an extended request that may be used to retrieve the set of password quality requirements that the Directory Server will impose for a specified operation, which may include adding a new user (including a password), a user changing his/her own password (a self change), or one user changing the password for another user (an administrative reset).
GetPasswordQualityRequirementsRequestValue ::= SEQUENCE { target CHOICE { addWithDefaultPasswordPolicy [0] NULL, addWithSpecifiedPasswordPolicy [1] LDAPDN, selfChangeForAuthorizationIdentity [2] NULL, selfChangeForSpecifiedUser [3] LDAPDN, administrativeResetForUser [4] LDAPDN, ... }, ... }
Field Summary | |
---|---|
static java.lang.String |
OID_GET_PASSWORD_QUALITY_REQUIREMENTS_REQUEST
The OID (1.3.6.1.4.1.30221.2.6.43) for the get password quality requirements extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
GetPasswordQualityRequirementsExtendedRequest(ExtendedRequest r)
Creates a new get password quality requirements extended request decoded from the provided generic extended request. |
Method Summary | |
---|---|
static GetPasswordQualityRequirementsExtendedRequest |
createAddWithDefaultPasswordPolicyRequest(Control... controls)
Creates a new get password quality requirements extended request that will retrieve the password requirements for an add operation governed by the server's default password policy. |
static GetPasswordQualityRequirementsExtendedRequest |
createAddWithSpecifiedPasswordPolicyRequest(java.lang.String policyDN,
Control... controls)
Creates a new get password quality requirements extended request that will retrieve the password requirements for an add operation governed by the specified password policy. |
static GetPasswordQualityRequirementsExtendedRequest |
createAdministrativeResetForSpecifiedUserRequest(java.lang.String userDN,
Control... controls)
Creates a new get password quality requirements extended request that will retrieve the password requirements for an administrative reset targeting the specified user. |
static GetPasswordQualityRequirementsExtendedRequest |
createSelfChangeForSpecifiedUserRequest(java.lang.String userDN,
Control... controls)
Creates a new get password quality requirements extended request that will retrieve the password requirements for a self change requested by the specified user. |
static GetPasswordQualityRequirementsExtendedRequest |
createSelfChangeWithSameAuthorizationIdentityRequest(Control... controls)
Creates a new get password quality requirements extended request that will retrieve the password requirements for a self change requested with the same authorization identity as this extended request. |
GetPasswordQualityRequirementsExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
GetPasswordQualityRequirementsExtendedRequest |
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. |
java.lang.String |
getTargetDN()
Retrieves the target DN for this get password quality requirements request. |
GetPasswordQualityRequirementsTargetType |
getTargetType()
Retrieves the target type for this get password quality requirements request. |
GetPasswordQualityRequirementsExtendedResult |
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 |
---|
public static final java.lang.String OID_GET_PASSWORD_QUALITY_REQUIREMENTS_REQUEST
Constructor Detail |
---|
public GetPasswordQualityRequirementsExtendedRequest(ExtendedRequest r) throws LDAPException
r
- The extended request to decode as a get password quality
requirements request.
LDAPException
- If a problem is encountered while attempting to
decoded the provided extended request as a
get password quality requirements request.Method Detail |
---|
public static GetPasswordQualityRequirementsExtendedRequest createAddWithDefaultPasswordPolicyRequest(Control... controls)
controls
- The set of controls to include in the request. It may be
null
or empty if no controls should be included
in the request.
public static GetPasswordQualityRequirementsExtendedRequest createAddWithSpecifiedPasswordPolicyRequest(java.lang.String policyDN, Control... controls)
policyDN
- The DN of the entry that defines the password policy from
which to determine the password quality requirements.controls
- The set of controls to include in the request. It may be
null
or empty if no controls should be included
in the request.
public static GetPasswordQualityRequirementsExtendedRequest createSelfChangeWithSameAuthorizationIdentityRequest(Control... controls)
controls
- The set of controls to include in the request. It may be
null
or empty if no controls should be included
in the request.
public static GetPasswordQualityRequirementsExtendedRequest createSelfChangeForSpecifiedUserRequest(java.lang.String userDN, Control... controls)
userDN
- The DN of the user for whom to retrieve the self change
password requirements.controls
- The set of controls to include in the request. It may be
null
or empty if no controls should be included
in the request.
public static GetPasswordQualityRequirementsExtendedRequest createAdministrativeResetForSpecifiedUserRequest(java.lang.String userDN, Control... controls)
userDN
- The DN of the user for whom to retrieve the
administrative reset password requirements.controls
- The set of controls to include in the request. It may be
null
or empty if no controls should be included
in the request.
public GetPasswordQualityRequirementsTargetType getTargetType()
public java.lang.String getTargetDN()
ADD_WITH_SPECIFIED_PASSWORD_POLICY
, this will be the DN of the
password policy from which to obtain the password quality requirements.
For a request with a target type of either
SELF_CHANGE_FOR_SPECIFIED_USER
or
ADMINISTRATIVE_RESET_FOR_SPECIFIED_USER
, this will be the DN of the
user for which to obtain the password quality requirements. For a request
with a target type of either ADD_WITH_DEFAULT_PASSWORD_POLICY
or
SELF_CHANGE_FOR_AUTHORIZATION_IDENTITY
, no target DN is required
and the value returned will be null
.
public GetPasswordQualityRequirementsExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class ExtendedRequest
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.
LDAPException
- If a problem occurs while sending the request or
reading the response.public GetPasswordQualityRequirementsExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public GetPasswordQualityRequirementsExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |