Package com.unboundid.ldap.sdk.unboundidds.extensions

Class 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

    • 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.

    • 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​(@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.