com.unboundid.ldap.sdk.unboundidds.extensions

Class GetSupportedOTPDeliveryMechanismsExtendedResult

java.lang.Object

com.unboundid.ldap.sdk.LDAPResult

com.unboundid.ldap.sdk.ExtendedResult

com.unboundid.ldap.sdk.unboundidds.extensions.GetSupportedOTPDeliveryMechanismsExtendedResult

All Implemented Interfaces:

LDAPResponse, java.io.Serializable

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

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.

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.48 and a value with the following encoding:

   GetSupportedOTPDeliveryMechanismsResult ::= SEQUENCE OF SEQUENCE {
        deliveryMechanism     [0] OCTET STRING,
        isSupported           [1] BOOLEAN OPTIONAL,
        recipientID           [2] OCTET STRING OPTIONAL,
        ... }
 

See Also:

GetSupportedOTPDeliveryMechanismsExtendedRequest, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
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, 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

GET_SUPPORTED_OTP_DELIVERY_MECHANISMS_RESULT_OID

@NotNull
public static final 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.

See Also:

Constant Field Values

Constructor Detail

GetSupportedOTPDeliveryMechanismsExtendedResult

public GetSupportedOTPDeliveryMechanismsExtendedResult(@NotNull
                                                       ExtendedResult result)
                                                throws LDAPException

Decodes the provided extended result as a get supported OTP delivery mechanisms result.

Parameters:

result - The extended result to decode as a get supported OTP delivery mechanisms result.

Throws:

LDAPException - If the provided extended result cannot be decoded as a get supported OTP delivery mechanisms result.

GetSupportedOTPDeliveryMechanismsExtendedResult

public GetSupportedOTPDeliveryMechanismsExtendedResult(int messageID,
                                                       @NotNull
                                                       ResultCode resultCode,
                                                       @Nullable
                                                       java.lang.String diagnosticMessage,
                                                       @Nullable
                                                       java.lang.String matchedDN,
                                                       @Nullable
                                                       java.lang.String[] referralURLs,
                                                       @Nullable
                                                       java.util.Collection<SupportedOTPDeliveryMechanismInfo> deliveryMechanismInfo,
                                                       @Nullable
                                                       Control... controls)

Creates a new get supported OTP delivery mechanisms extended result object 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. 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

getDeliveryMechanismInfo

@NotNull
public 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. Note that it is possible for the same OTP delivery mechanism to appear in the list multiple times if that mechanism is supported for the user with multiple recipient IDs (e.g., if the server provides an "Email" delivery mechanism and a user has multiple email addresses, then the list may include a separate "Email" delivery mechanism info object for each of the user's email addresses).

Returns:

A list containing information about the OTP delivery mechanisms supported by the server and which are available for the target user, or an empty list if the server doesn't support any OTP delivery mechanisms or if the request was not processed successfully.

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.