|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.extensions.SupportedOTPDeliveryMechanismInfo
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SupportedOTPDeliveryMechanismInfo
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.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.
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
---|
public SupportedOTPDeliveryMechanismInfo(java.lang.String deliveryMechanism, java.lang.Boolean isSupported, java.lang.String recipientID)
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 |
---|
public java.lang.String getDeliveryMechanism()
public java.lang.Boolean isSupported()
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.public java.lang.String getRecipientID()
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.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.
true
if the provided object is an equivalent supported OTP
delivery mechanism info object, or false
if not.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information should be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |