com.unboundid.ldap.sdk.unboundidds.extensions

Class DeliverOneTimePasswordExtendedResult

java.lang.Object

com.unboundid.ldap.sdk.LDAPResult

com.unboundid.ldap.sdk.ExtendedResult

com.unboundid.ldap.sdk.unboundidds.extensions.DeliverOneTimePasswordExtendedResult

All Implemented Interfaces:

LDAPResponse, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class DeliverOneTimePasswordExtendedResult
extends ExtendedResult

This class provides an implementation of an extended result that may be used to provide information about the result of processing for a deliver one-time password extended request. If the one-time password was delivered successfully, then this result will include information about the mechanism through which that message was delivered.

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 Nokia/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.

If the request was processed successfully, then the extended result will have an OID of 1.3.6.1.4.1.30221.2.6.25 and a value with the following encoding:

   DeliverOTPResult ::= SEQUENCE {
        deliveryMechanism     [0] OCTET STRING,
        recipientDN           [1] LDAPDN,
        recipientID           [2] OCTET STRING OPTIONAL,
        message               [3] OCTET STRING OPTIONAL,
        ... }
 

See Also:

UnboundIDDeliveredOTPBindRequest, DeliverOneTimePasswordExtendedRequest, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELIVER_OTP_RESULT_OID The OID (1.3.6.1.4.1.30221.2.6.25) for the deliver one-time password extended result.

Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse

NO_CONTROLS

Constructor Summary

Constructors

Constructor and Description
DeliverOneTimePasswordExtendedResult(ExtendedResult extendedResult) Creates a new deliver one-time password extended result from the provided generic extended result.
DeliverOneTimePasswordExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String deliveryMechanism, java.lang.String recipientDN, java.lang.String recipientID, java.lang.String deliveryMessage, Control... responseControls) Creates a new deliver one-time password extended result with the provided information.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeliveryMechanism() Retrieves the name of the mechanism by which the one-time password was delivered to the end user, if available.
java.lang.String	getDeliveryMessage() Retrieves a message providing additional information about the one-time password delivery, if available.
java.lang.String	getExtendedResultName() Retrieves the user-friendly name for the extended result, if available.
java.lang.String	getRecipientDN() Retrieves the DN of the user to whom the one-time password was delivered, if available.
java.lang.String	getRecipientID() Retrieves an identifier for the user to whom the one-time password 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, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DELIVER_OTP_RESULT_OID

@NotNull
public static final java.lang.String DELIVER_OTP_RESULT_OID

The OID (1.3.6.1.4.1.30221.2.6.25) for the deliver one-time password extended result.

See Also:

Constant Field Values

Constructor Detail

DeliverOneTimePasswordExtendedResult

public DeliverOneTimePasswordExtendedResult(@NotNull
                                            ExtendedResult extendedResult)
                                     throws LDAPException

Creates a new deliver one-time password extended result from the provided generic extended result.

Parameters:

extendedResult - The generic extended result to be parsed as a deliver one-time password result.

Throws:

LDAPException - If the provided extended result cannot be parsed as a deliver one-time password result.

DeliverOneTimePasswordExtendedResult

public DeliverOneTimePasswordExtendedResult(int messageID,
                                            @NotNull
                                            ResultCode resultCode,
                                            @Nullable
                                            java.lang.String diagnosticMessage,
                                            @Nullable
                                            java.lang.String matchedDN,
                                            @Nullable
                                            java.lang.String[] referralURLs,
                                            @Nullable
                                            java.lang.String deliveryMechanism,
                                            @Nullable
                                            java.lang.String recipientDN,
                                            @Nullable
                                            java.lang.String recipientID,
                                            @Nullable
                                            java.lang.String deliveryMessage,
                                            @Nullable
                                            Control... responseControls)

Creates a new deliver one-time password extended result with the provided information.

Parameters:

messageID - The message ID for the LDAP message that is associated with this LDAP result.

resultCode - The result code from the response.

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 one-time password was delivered, if available. This should be non-null for a success result.

recipientDN - The DN of the user to whom the one-time password was sent. This should be non-null for a success result.

recipientID - An identifier for the user to whom the one-time password was delivered. It may be null if no password 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 - A message providing additional information about the one-time password delivery, if available. If this is non-null, then the delivery mechanism must also be non-null.

responseControls - The set of controls from the response, if available.

Method Detail

getDeliveryMechanism

@Nullable
public java.lang.String getDeliveryMechanism()

Retrieves the name of the mechanism by which the one-time password was delivered to the end user, if available.

Returns:

The name of the mechanism by which the one-time password was delivered to the end user, or null if this is not available.

getRecipientDN

@Nullable
public java.lang.String getRecipientDN()

Retrieves the DN of the user to whom the one-time password was delivered, if available.

Returns:

The DN of the user to whom the one-time password was delivered, or null if this is not available.

getRecipientID

@Nullable
public java.lang.String getRecipientID()

Retrieves an identifier for the user to whom the one-time password was delivered, if available. If a recipient ID is provided, then it should be in a form appropriate to the delivery mechanism (e.g., an e-mail address if the password was delivered by e-mail, a phone number if it was delivered by SMS or a voice call, etc.).

Returns:

An identifier for the user to whom the one-time password was delivered, or null if this is not available.

getDeliveryMessage

@Nullable
public java.lang.String getDeliveryMessage()

Retrieves a message providing additional information about the one-time password delivery, if available.

Returns:

A message providing additional information about the one-time password delivery, or null if this is not available.

getExtendedResultName

@NotNull
public java.lang.String getExtendedResultName()

Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.

Overrides:

getExtendedResultName in class ExtendedResult

Returns:

The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this extended result to the provided buffer.

Specified by:

toString in interface LDAPResponse

Overrides:

toString in class ExtendedResult

Parameters:

buffer - The buffer to which a string representation of this extended result will be appended.