com.unboundid.ldap.sdk.unboundidds.extensions

Class GetSupportedOTPDeliveryMechanismsExtendedRequest

java.lang.Object

com.unboundid.ldap.sdk.LDAPRequest

com.unboundid.ldap.sdk.ExtendedRequest

com.unboundid.ldap.sdk.unboundidds.extensions.GetSupportedOTPDeliveryMechanismsExtendedRequest

All Implemented Interfaces:

ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetSupportedOTPDeliveryMechanismsExtendedRequest
extends ExtendedRequest

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.

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.

The OID for this extended request is "1.3.6.1.4.1.30221.2.6.47". It must have a value with the following encoding:

   GetSupportedOTPDeliveryMechanismsRequest ::= SEQUENCE {
        userDN     [0] LDAPDN,
        ... }
 

See Also:

GetSupportedOTPDeliveryMechanismsExtendedResult, Serialized Form

Field Summary

Fields

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

Constructors

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

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

Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest

followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString

Methods inherited from class java.lang.Object

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

Field Detail

GET_SUPPORTED_OTP_DELIVERY_MECHANISMS_REQUEST_OID

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

See Also:

Constant Field Values

Constructor Detail

GetSupportedOTPDeliveryMechanismsExtendedRequest

public GetSupportedOTPDeliveryMechanismsExtendedRequest(@NotNull
                                                        java.lang.String userDN,
                                                        @Nullable
                                                        Control... controls)

Creates a new instance of this get supported OTP delivery mechanisms extended request with the provided information.

Parameters:

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.

GetSupportedOTPDeliveryMechanismsExtendedRequest

public GetSupportedOTPDeliveryMechanismsExtendedRequest(@NotNull
                                                        ExtendedRequest request)
                                                 throws LDAPException

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

Parameters:

request - The extended request to be decoded as a get supported OTP delivery mechanisms request.

Throws:

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

Method Detail

getUserDN

@NotNull
public java.lang.String getUserDN()

Retrieves the DN of the user for whom to retrieve the list of supported OTP delivery mechanisms.

Returns:

The DN of the user for whom to retrieve the list of supported OTP delivery mechanisms.

process

@NotNull
public GetSupportedOTPDeliveryMechanismsExtendedResult process(@NotNull
                                                                        LDAPConnection connection,
                                                                        int depth)
                                                                 throws LDAPException

Sends this extended request to the directory server over the provided connection and returns the associated response.

Overrides:

process in class ExtendedRequest

Parameters:

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.

Returns:

An LDAP result object that provides information about the result of the extended operation processing.

Throws:

LDAPException - If a problem occurs while sending the request or reading the response.

duplicate

@NotNull
public GetSupportedOTPDeliveryMechanismsExtendedRequest duplicate()

Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type..

Specified by:

duplicate in interface ReadOnlyLDAPRequest

Overrides:

duplicate in class ExtendedRequest

Returns:

A new instance of this LDAP request that may be modified without impacting this request.

duplicate

@NotNull
public GetSupportedOTPDeliveryMechanismsExtendedRequest duplicate(@Nullable
                                                                           Control[] controls)

Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type..

Specified by:

duplicate in interface ReadOnlyLDAPRequest

Overrides:

duplicate in class ExtendedRequest

Parameters:

controls - The set of controls to include in the duplicate request.

Returns:

A new instance of this LDAP request that may be modified without impacting this request.

getExtendedRequestName

@NotNull
public java.lang.String getExtendedRequestName()

Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:

getExtendedRequestName in class ExtendedRequest

Returns:

The user-friendly name for this extended request, or the OID if no user-friendly name is available.

toString

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

Appends a string representation of this request to the provided buffer.

Specified by:

toString in interface ProtocolOp

Specified by:

toString in interface ReadOnlyLDAPRequest

Overrides:

toString in class ExtendedRequest

Parameters:

buffer - The buffer to which to append a string representation of this request.