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

Class SupportedOTPDeliveryMechanismInfo

  • All Implemented Interfaces:
    java.io.Serializable
    @NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SupportedOTPDeliveryMechanismInfo
extends java.lang.Object
implements java.io.Serializable
    This class provides a data structure with information about a one-time password delivery mechanism that is supported by the Directory Server and may or may not be supported for a particular 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.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      SupportedOTPDeliveryMechanismInfo​(java.lang.String deliveryMechanism, java.lang.Boolean isSupported, java.lang.String recipientID)
      Creates a new supported OTP delivery mechanism info object with the provided information.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)
      Indicates whether the provided object is considered equal to this supported OTP delivery mechanism info object.
      java.lang.String getDeliveryMechanism()
      Retrieves the name of the one-time password delivery mechanism to which this object corresponds.
      java.lang.String getRecipientID()
      Retrieves the recipient ID, if any, that may be used for the target user in conjunction with the associated delivery mechanism.
      int hashCode()
      Retrieves a hash code for this supported OTP delivery mechanism info object.
      java.lang.Boolean isSupported()
      Retrieves information about whether the one-time password delivery mechanism is supported for the target user.
      java.lang.String toString()
      Retrieves a string representation of this supported OTP delivery mechanism info object.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of this supported OTP delivery mechanism info object to the provided buffer.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SupportedOTPDeliveryMechanismInfo

        public SupportedOTPDeliveryMechanismInfo​(@NotNull
                                         java.lang.String deliveryMechanism,
                                         @Nullable
                                         java.lang.Boolean isSupported,
                                         @Nullable
                                         java.lang.String recipientID)
        Creates a new supported OTP delivery mechanism info object with the provided information.
        Parameters:
        deliveryMechanism - The name of the one-time password delivery mechanism to which this object corresponds.
        isSupported - Indicates whether the specified delivery mechanism is expected to be supported for the target user. This may be true (to indicate that the delivery mechanism is expected to be supported for the target user, false if the delivery mechanism is not supported for the target user, or null if it cannot be determined whether the delivery mechanism is supported for the target user.
        recipientID - An optional recipient ID that can be used in conjunction with the delivery mechanism if it is supported for the user (e.g., it may be an email address for an email-based delivery mechanism or a mobile phone number for an SMS-based delivery mechanism). This may be null if the delivery mechanism is not supported or if no recipient ID is applicable.

    • Method Detail

      • getDeliveryMechanism

        @NotNull
public java.lang.String getDeliveryMechanism()
        Retrieves the name of the one-time password delivery mechanism to which this object corresponds.
        Returns:
        The name of the one-time password delivery mechanism to which this object corresponds.

      • isSupported

        @Nullable
public java.lang.Boolean isSupported()
        Retrieves information about whether the one-time password delivery mechanism is supported for the target user.
        Returns:
        true if the delivery mechanism is expected to be supported for the user, false if the delivery mechanism is not supported for the user, or null if it cannot be determined whether the delivery mechanism is supported for the target user.

      • getRecipientID

        @Nullable
public java.lang.String getRecipientID()
        Retrieves the recipient ID, if any, that may be used for the target user in conjunction with the associated delivery mechanism. If a recipient ID is available, then its format may vary based on the type of delivery mechanism.
        Returns:
        The recipient ID that may be used for the target user in conjunction with the associated delivery mechanism, or null if there is no recipient ID associated with the delivery mechanism, or if the delivery mechanism is not expected to be supported for the target user.

      • hashCode

        public int hashCode()
        Retrieves a hash code for this supported OTP delivery mechanism info object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code for this supported OTP delivery mechanism info object.

      • equals

        public boolean equals​(@Nullable
                      java.lang.Object o)
        Indicates whether the provided object is considered equal to this supported OTP delivery mechanism info object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - The object for which to make the determination.
        Returns:
        true if the provided object is an equivalent supported OTP delivery mechanism info object, or false if not.

      • toString

        @NotNull
public java.lang.String toString()
        Retrieves a string representation of this supported OTP delivery mechanism info object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this supported OTP delivery mechanism object.

      • toString

        public void toString​(@NotNull
                     java.lang.StringBuilder buffer)
        Appends a string representation of this supported OTP delivery mechanism info object to the provided buffer.
        Parameters:
        buffer - The buffer to which the information should be appended.