|
|||||||||
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.DeliverSingleUseTokenExtendedResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DeliverSingleUseTokenExtendedResult
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 the result of processing for a deliver single-use token extended request. If the token was delivered successfully, then this result will include information about the mechanism through which the token was delivered.
DeliverSingleUseTokenResult ::= SEQUENCE { deliveryMechanism OCTET STRING, recipientID [0] OCTET STRING OPTIONAL, message [1] OCTET STRING OPTIONAL, ... }
DeliverSingleUseTokenExtendedRequest
,
ConsumeSingleUseTokenExtendedRequest
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
DELIVER_SINGLE_USE_TOKEN_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.50) for the deliver single-use token extended result. |
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
DeliverSingleUseTokenExtendedResult(ExtendedResult result)
Creates a new deliver single-use token result from the provided generic extended result. |
|
DeliverSingleUseTokenExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
java.lang.String deliveryMechanism,
java.lang.String recipientID,
java.lang.String deliveryMessage,
Control... responseControls)
Creates a new deliver single-use token extended result with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getDeliveryMechanism()
Retrieves the name of the mechanism by which the single-use token was delivered to the user, if available. |
java.lang.String |
getDeliveryMessage()
Retrieves a message providing additional information about the single-use token delivery, if available. |
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
java.lang.String |
getRecipientID()
Retrieves an identifier for the user to whom the single-use token was delivered, 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 DELIVER_SINGLE_USE_TOKEN_RESULT_OID
Constructor Detail |
---|
public DeliverSingleUseTokenExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String deliveryMechanism, java.lang.String recipientID, java.lang.String deliveryMessage, Control... responseControls)
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.deliveryMechanism
- The name of the mechanism by which the token was
delivered, if available. This should be
non-null
for a success result.recipientID
- An identifier for the user to whom the token was
delivered. It may be null
if no token
was delivered or there is no appropriate
identifier, but if a value is provided then it
should appropriate for the delivery mechanism
(e.g., the user's e-mail address if delivered
via e-mail, a phone number if delivered via SMS
or voice call, etc.).deliveryMessage
- An optional message providing additional
information about the token delivery, if
available. If this is non-null
, then
the delivery mechanism must also be
non-null
.responseControls
- The set of controls for the response, if
available.public DeliverSingleUseTokenExtendedResult(ExtendedResult result) throws LDAPException
result
- The generic extended result to be parsed as a deliver
single-use token result.
LDAPException
- If the provided extended result cannot be parsed as
a deliver single-use token result.Method Detail |
---|
public java.lang.String getDeliveryMechanism()
null
if this is not available.public java.lang.String getRecipientID()
null
if this is not available.public java.lang.String getDeliveryMessage()
null
if this is not available.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 |