|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.DeliverOneTimePasswordExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DeliverOneTimePasswordExtendedRequest
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 an implementation of an extended request that may be used to request that the Directory Server deliver a one-time password to an end user that they may use to authenticate via an
UnboundIDDeliveredOTPBindRequest
.
DeliverOTPRequest ::= SEQUENCE { authenticationID [0] OCTET STRING, staticPassword [1] OCTET STRING OPTIONAL, preferredMechNames [2] SEQUENCE OF OCTET STRING OPTIONAL, preferredMechNamesAndIDs [3] SEQUENCE OF SEQUENCE, mechanismName OCTET STRING, recipientID OCTET STRING OPTIONAL } OPTIONAL, messageSubject [4] OCTET STRING OPTIONAL, fullTextBeforeOTP [5] OCTET STRING OPTIONAL, fullTextAfterOTP [6] OCTET STRING OPTIONAL, compactTextBeforeOTP [7] OCTET STRING OPTIONAL, compactTextAfterOTP [8] OCTET STRING OPTIONAL, ... }
UnboundIDDeliveredOTPBindRequest
,
DeliverOneTimePasswordExtendedResult
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
DELIVER_OTP_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.24) for the deliver one-time password extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
DeliverOneTimePasswordExtendedRequest(ExtendedRequest request)
Creates a new deliver one-time password extended request from the information contained in the provided generic extended request. |
|
DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID,
byte[] staticPassword,
java.util.List<java.lang.String> preferredDeliveryMechanisms,
Control... controls)
Creates a new deliver one-time password extended request with the provided information. |
|
DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID,
byte[] staticPassword,
java.lang.String... preferredDeliveryMechanisms)
Creates a new deliver one-time password extended request with the provided information. |
|
DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID,
byte[] staticPassword,
java.lang.String messageSubject,
java.lang.String fullTextBeforeOTP,
java.lang.String fullTextAfterOTP,
java.lang.String compactTextBeforeOTP,
java.lang.String compactTextAfterOTP,
java.util.List<ObjectPair<java.lang.String,java.lang.String>> preferredDeliveryMechanisms,
Control... controls)
Creates a new deliver one-time password extended request with the provided information. |
|
DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID,
java.lang.String staticPassword,
java.util.List<java.lang.String> preferredDeliveryMechanisms,
Control... controls)
Creates a new deliver one-time password extended request with the provided information. |
|
DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID,
java.lang.String staticPassword,
java.lang.String... preferredDeliveryMechanisms)
Creates a new deliver one-time password extended request with the provided information. |
|
DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID,
java.lang.String staticPassword,
java.lang.String messageSubject,
java.lang.String fullTextBeforeOTP,
java.lang.String fullTextAfterOTP,
java.lang.String compactTextBeforeOTP,
java.lang.String compactTextAfterOTP,
java.util.List<ObjectPair<java.lang.String,java.lang.String>> preferredDeliveryMechanisms,
Control... controls)
Creates a new deliver one-time password extended request with the provided information. |
Method Summary | |
---|---|
DeliverOneTimePasswordExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
DeliverOneTimePasswordExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getAuthenticationID()
Retrieves the authentication ID for the user to whom the one-time password should be delivered. |
java.lang.String |
getCompactTextAfterOTP()
Retrieves the text (if any) that should appear after the one-time password in the message delivered to the user via a mechanism that imposes significant constraints on message size. |
java.lang.String |
getCompactTextBeforeOTP()
Retrieves the text (if any) that should appear before the one-time password in the message delivered to the user via a mechanism that imposes significant constraints on message size. |
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. |
java.lang.String |
getFullTextAfterOTP()
Retrieves the text (if any) that should appear after the one-time password in the message delivered to the user via a mechanism that does not impose significant constraints on message size. |
java.lang.String |
getFullTextBeforeOTP()
Retrieves the text (if any) that should appear before the one-time password in the message delivered to the user via a mechanism that does not impose significant constraints on message size. |
java.lang.String |
getMessageSubject()
Retrieves the text (if any) that should be used as the message subject for delivery mechanisms that can make use of a subject. |
java.util.List<ObjectPair<java.lang.String,java.lang.String>> |
getPreferredDeliveryMechanismNamesAndIDs()
Retrieves an ordered list of the preferred delivery mechanisms that should be used to provide the one-time password to the user, optionally paired with a mechanism-specific recipient ID (e.g., a mobile phone number for SMS delivery, or an email address for email delivery) that can be used in the delivery. |
java.util.List<java.lang.String> |
getPreferredDeliveryMechanisms()
Retrieves an ordered list of the names of the preferred delivery mechanisms for the one-time password, if provided. |
ASN1OctetString |
getStaticPassword()
Retrieves the static password for the user to whom the one-time password should be delivered. |
DeliverOneTimePasswordExtendedResult |
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, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DELIVER_OTP_REQUEST_OID
Constructor Detail |
---|
public DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID, java.lang.String staticPassword, java.lang.String... preferredDeliveryMechanisms)
authenticationID
- The authentication ID for the user to
whom the one-time password should be
delivered. It must not be
null
.staticPassword
- The static password for the user to
whom the one-time password should be
delivered. It may be null
if
this request is intended to be used
to step-up an existing authentication
rather than perform a new
authentication (in which case the
provided authentication ID must match
the operation's authorization ID).preferredDeliveryMechanisms
- The names of the preferred delivery
mechanisms for the one-time password.
It may be null
or empty if the
server should select an appropriate
delivery mechanism. If it is
non-null
and non-empty, then
only the listed mechanisms will be
considered for use, even if the server
supports alternate mechanisms not
included in this list.public DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID, byte[] staticPassword, java.lang.String... preferredDeliveryMechanisms)
authenticationID
- The authentication ID for the user to
whom the one-time password should be
delivered. It must not be
null
.staticPassword
- The static password for the user to
whom the one-time password should be
delivered. It may be null
if
this request is intended to be used
to step-up an existing authentication
rather than perform a new
authentication (in which case the
provided authentication ID must match
the operation's authorization ID).preferredDeliveryMechanisms
- The names of the preferred delivery
mechanisms for the one-time password.
It may be null
or empty if the
server should select an appropriate
delivery mechanism. If it is
non-null
and non-empty, then
only the listed mechanisms will be
considered for use, even if the server
supports alternate mechanisms not
included in this list.public DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID, java.lang.String staticPassword, java.util.List<java.lang.String> preferredDeliveryMechanisms, Control... controls)
authenticationID
- The authentication ID for the user to
whom the one-time password should be
delivered. It must not be
null
.staticPassword
- The static password for the user to
whom the one-time password should be
delivered. It may be null
if
this request is intended to be used
to step-up an existing authentication
rather than perform a new
authentication (in which case the
provided authentication ID must match
the operation's authorization ID).preferredDeliveryMechanisms
- The names of the preferred delivery
mechanisms for the one-time password.
It may be null
or empty if the
server should select an appropriate
delivery mechanism. If it is
non-null
and non-empty, then
only the listed mechanisms will be
considered for use, even if the server
supports alternate mechanisms not
included in this list.controls
- The set of controls to include in the
request. It may be null
or
empty if no controls should be
included.public DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID, byte[] staticPassword, java.util.List<java.lang.String> preferredDeliveryMechanisms, Control... controls)
authenticationID
- The authentication ID for the user to
whom the one-time password should be
delivered. It must not be
null
.staticPassword
- The static password for the user to
whom the one-time password should be
delivered. It may be null
if
this request is intended to be used
to step-up an existing authentication
rather than perform a new
authentication (in which case the
provided authentication ID must match
the operation's authorization ID).preferredDeliveryMechanisms
- The names of the preferred delivery
mechanisms for the one-time password.
It may be null
or empty if the
server should select an appropriate
delivery mechanism. If it is
non-null
and non-empty, then
only the listed mechanisms will be
considered for use, even if the server
supports alternate mechanisms not
included in this list.controls
- The set of controls to include in the
request. It may be null
or
empty if no controls should be
included.public DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID, java.lang.String staticPassword, java.lang.String messageSubject, java.lang.String fullTextBeforeOTP, java.lang.String fullTextAfterOTP, java.lang.String compactTextBeforeOTP, java.lang.String compactTextAfterOTP, java.util.List<ObjectPair<java.lang.String,java.lang.String>> preferredDeliveryMechanisms, Control... controls)
authenticationID
- The authentication ID for the user to
whom the one-time password should be
delivered. It must not be
null
.staticPassword
- The static password for the user to
whom the one-time password should be
delivered. It may be null
if
this request is intended to be used
to step-up an existing authentication
rather than perform a new
authentication (in which case the
provided authentication ID must match
the operation's authorization ID).messageSubject
- The text (if any) that should be used
as the message subject if the delivery
mechanism accepts a subject. This may
be null
if no subject is
required or a subject should be
automatically generated.fullTextBeforeOTP
- The text (if any) that should appear
before the generated one-time password
in the message delivered to the user
via a delivery mechanism that does not
impose significant constraints on
message size. This may be
null
if no text is required
before the one-time password.fullTextAfterOTP
- The text (if any) that should appear
after the one-time password in the
message delivered to the user via a
delivery mechanism that does not
impose significant constraints on
message size. This may be
null
if no text is required
after the one-time password.compactTextBeforeOTP
- The text (if any) that should appear
before the generated one-time password
in the message delivered to the user
via a delivery mechanism that imposes
significant constraints on message
size. This may be null
if no
text is required before the one-time
password.compactTextAfterOTP
- The text (if any) that should appear
after the generated one-time password
in the message delivered to the user
via a delivery mechanism that imposes
significant constraints on message
size. This may be null
if no
text is required after the one-time
password.preferredDeliveryMechanisms
- An optional ordered list of preferred
delivery mechanisms that should be
used to deliver the one-time password
to the user. It may be null
or empty to allow the server to select
an appropriate delivery mechanism. If
it is non-null
and non-empty,
then only the listed mechanisms will
be considered for use, even if the
server supports alternate mechanisms
not included in this list. Each
ObjectPair
item must have
a non-null
value for the first
element, which is the name of the
target delivery mechanism. It may
optionally have a non-null
value for the second element, which is
a recipient ID to use for that
mechanism (e.g., the target mobile
phone number for SMS delivery, an
email address for email delivery,
etc.). If no recipient ID is provided
for a mechanism, then the server will
attempt to select a value for the
user.controls
- The set of controls to include in the
request. It may be null
or
empty if no controls should be
included.public DeliverOneTimePasswordExtendedRequest(java.lang.String authenticationID, byte[] staticPassword, java.lang.String messageSubject, java.lang.String fullTextBeforeOTP, java.lang.String fullTextAfterOTP, java.lang.String compactTextBeforeOTP, java.lang.String compactTextAfterOTP, java.util.List<ObjectPair<java.lang.String,java.lang.String>> preferredDeliveryMechanisms, Control... controls)
authenticationID
- The authentication ID for the user to
whom the one-time password should be
delivered. It must not be
null
.staticPassword
- The static password for the user to
whom the one-time password should be
delivered. It may be null
if
this request is intended to be used
to step-up an existing authentication
rather than perform a new
authentication (in which case the
provided authentication ID must match
the operation's authorization ID).messageSubject
- The text (if any) that should be used
as the message subject if the delivery
mechanism accepts a subject. This may
be null
if no subject is
required or a subject should be
automatically generated.fullTextBeforeOTP
- The text (if any) that should appear
before the generated one-time password
in the message delivered to the user
via a delivery mechanism that does not
impose significant constraints on
message size. This may be
null
if no text is required
before the one-time password.fullTextAfterOTP
- The text (if any) that should appear
after the one-time password in the
message delivered to the user via a
delivery mechanism that does not
impose significant constraints on
message size. This may be
null
if no text is required
after the one-time password.compactTextBeforeOTP
- The text (if any) that should appear
before the generated one-time password
in the message delivered to the user
via a delivery mechanism that imposes
significant constraints on message
size. This may be null
if no
text is required before the one-time
password.compactTextAfterOTP
- The text (if any) that should appear
after the generated one-time password
in the message delivered to the user
via a delivery mechanism that imposes
significant constraints on message
size. This may be null
if no
text is required after the one-time
password.preferredDeliveryMechanisms
- An optional ordered list of preferred
delivery mechanisms that should be
used to deliver the one-time password
to the user. It may be null
or empty to allow the server to select
an appropriate delivery mechanism. If
it is non-null
and non-empty,
then only the listed mechanisms will
be considered for use, even if the
server supports alternate mechanisms
not included in this list. Each
ObjectPair
item must have
a non-null
value for the first
element, which is the name of the
target delivery mechanism. It may
optionally have a non-null
value for the second element, which is
a recipient ID to use for that
mechanism (e.g., the target mobile
phone number for SMS delivery, an
email address for email delivery,
etc.). If no recipient ID is provided
for a mechanism, then the server will
attempt to select a value for the
user.controls
- The set of controls to include in the
request. It may be null
or
empty if no controls should be
included.public DeliverOneTimePasswordExtendedRequest(ExtendedRequest request) throws LDAPException
request
- The generic extended request to be decoded as a deliver
one-time password extended request.
LDAPException
- If a problem is encountered while attempting to
decode the provided generic extended request as a
deliver one-time password extended request.Method Detail |
---|
public java.lang.String getAuthenticationID()
public ASN1OctetString getStaticPassword()
null
if no
null
if no static password should
be included in the request.public java.util.List<java.lang.String> getPreferredDeliveryMechanisms()
null
if this was not
provided.public java.util.List<ObjectPair<java.lang.String,java.lang.String>> getPreferredDeliveryMechanismNamesAndIDs()
public java.lang.String getMessageSubject()
null
if no
subject should be used, or if the delivery mechanism should
attempt to automatically determine a subject.public java.lang.String getFullTextBeforeOTP()
null
if there
should not be any text before the one-time password.public java.lang.String getFullTextAfterOTP()
null
if there
should not be any text after the one-time password.public java.lang.String getCompactTextBeforeOTP()
null
if there
should not be any text before the one-time password.public java.lang.String getCompactTextAfterOTP()
null
if there
should not be any text after the one-time password.public DeliverOneTimePasswordExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class ExtendedRequest
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.
LDAPException
- If a problem occurs while sending the request or
reading the response.public DeliverOneTimePasswordExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public DeliverOneTimePasswordExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |