@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetPasswordQualityRequirementsExtendedRequest extends ExtendedRequest
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and Alcatel-Lucent 8661
server products. These classes provide support for proprietary
functionality or for external specifications that are not considered stable
or mature enough to be guaranteed to work in an interoperable way with
other types of LDAP servers.
GetPasswordQualityRequirementsRequestValue ::= SEQUENCE { target CHOICE { addWithDefaultPasswordPolicy [0] NULL, addWithSpecifiedPasswordPolicy [1] LDAPDN, selfChangeForAuthorizationIdentity [2] NULL, selfChangeForSpecifiedUser [3] LDAPDN, administrativeResetForUser [4] LDAPDN, ... }, ... }
Modifier and Type | Field and Description |
---|---|
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.
|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
Constructor and Description |
---|
GetPasswordQualityRequirementsExtendedRequest(ExtendedRequest r)
Creates a new get password quality requirements extended request decoded
from the provided generic extended request.
|
Modifier and Type | Method and Description |
---|---|
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.
|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTo
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
public static final java.lang.String OID_GET_PASSWORD_QUALITY_REQUIREMENTS_REQUEST
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.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.