|
|||||||||
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.GetSupportedOTPDeliveryMechanismsExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetSupportedOTPDeliveryMechanismsExtendedRequest
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 can be used to retrieve information about which one-time password delivery mechanisms are supported for a user.
GetSupportedOTPDeliveryMechanismsRequest ::= SEQUENCE { userDN [0] LDAPDN, ... }
GetSupportedOTPDeliveryMechanismsExtendedResult
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
GET_SUPPORTED_OTP_DELIVERY_MECHANISMS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.47) for the get supported one-time password delivery mechanisms extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
GetSupportedOTPDeliveryMechanismsExtendedRequest(ExtendedRequest request)
Decodes the provided extended request as a get supported OTP delivery mechanisms request. |
|
GetSupportedOTPDeliveryMechanismsExtendedRequest(java.lang.String userDN,
Control... controls)
Creates a new instance of this get supported OTP delivery mechanisms extended request with the provided information. |
Method Summary | |
---|---|
GetSupportedOTPDeliveryMechanismsExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
GetSupportedOTPDeliveryMechanismsExtendedRequest |
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 |
getUserDN()
Retrieves the DN of the user for whom to retrieve the list of supported OTP delivery mechanisms. |
GetSupportedOTPDeliveryMechanismsExtendedResult |
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 GET_SUPPORTED_OTP_DELIVERY_MECHANISMS_REQUEST_OID
Constructor Detail |
---|
public GetSupportedOTPDeliveryMechanismsExtendedRequest(java.lang.String userDN, Control... controls)
userDN
- The DN of the user for whom to retrieve the list of
supported OTP delivery mechanisms. It must not be
null
.controls
- The set of controls to include in the request. It may be
null
or empty if no controls should be included.public GetSupportedOTPDeliveryMechanismsExtendedRequest(ExtendedRequest request) throws LDAPException
request
- The extended request to be decoded as a get supported OTP
delivery mechanisms request.
LDAPException
- If the provided request cannot be decoded as a get
supported OTP delivery mechanisms request.Method Detail |
---|
public java.lang.String getUserDN()
public GetSupportedOTPDeliveryMechanismsExtendedResult 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 GetSupportedOTPDeliveryMechanismsExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public GetSupportedOTPDeliveryMechanismsExtendedRequest 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 |