|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.GetSupportedOTPDeliveryMechanismsExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetSupportedOTPDeliveryMechanismsExtendedResult
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 result that may be used to provide information about which one-time password delivery mechanisms are supported for a user.
GetSupportedOTPDeliveryMechanismsResult ::= SEQUENCE OF SEQUENCE { deliveryMechanism [0] OCTET STRING, isSupported [1] BOOLEAN OPTIONAL, recipientID [2] OCTET STRING OPTIONAL, ... }
GetSupportedOTPDeliveryMechanismsExtendedRequest
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
GET_SUPPORTED_OTP_DELIVERY_MECHANISMS_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.48) for the get supported one-time password delivery mechanisms extended result. |
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
GetSupportedOTPDeliveryMechanismsExtendedResult(ExtendedResult result)
Decodes the provided extended result as a get supported OTP delivery mechanisms result. |
|
GetSupportedOTPDeliveryMechanismsExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
java.util.Collection<SupportedOTPDeliveryMechanismInfo> deliveryMechanismInfo,
Control... controls)
Creates a new get supported OTP delivery mechanisms extended result object with the provided information. |
Method Summary | |
---|---|
java.util.List<SupportedOTPDeliveryMechanismInfo> |
getDeliveryMechanismInfo()
Retrieves a list containing information about the OTP delivery mechanisms supported by the server and which are available for use by the target user, if available. |
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult |
---|
getOID, getValue, hasValue, toString |
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult |
---|
getDiagnosticMessage, getMatchedDN, getMessageID, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl |
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_RESULT_OID
Constructor Detail |
---|
public GetSupportedOTPDeliveryMechanismsExtendedResult(ExtendedResult result) throws LDAPException
result
- The extended result to decode as a get supported OTP
delivery mechanisms result.
LDAPException
- If the provided extended result cannot be decoded
as a get supported OTP delivery mechanisms result.public GetSupportedOTPDeliveryMechanismsExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.util.Collection<SupportedOTPDeliveryMechanismInfo> deliveryMechanismInfo, Control... controls)
messageID
- The message ID for the LDAP message that is
associated with this LDAP result.resultCode
- The result code from the response. It must
not be null
.diagnosticMessage
- The diagnostic message from the response, if
available.matchedDN
- The matched DN from the response, if
available.referralURLs
- The set of referral URLs from the response,
if available.deliveryMechanismInfo
- The set of supported delivery mechanism info
for the result, if appropriate. It should
be null
or empty for non-success
results.controls
- The set of controls for the response. It
may be null
or empty if no controls
are needed.Method Detail |
---|
public java.util.List<SupportedOTPDeliveryMechanismInfo> getDeliveryMechanismInfo()
public java.lang.String getExtendedResultName()
null
will be returned.
getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended result will be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |