|
|||||||||
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.BindRequest
com.unboundid.ldap.sdk.SASLBindRequest
com.unboundid.ldap.sdk.unboundidds.UnboundIDDeliveredOTPBindRequest
@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class UnboundIDDeliveredOTPBindRequest
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 support for an UnboundID-proprietary SASL mechanism that allows for multifactor authentication using a one-time password that has been delivered to the user via some out-of-band mechanism as triggered by the
DeliverOneTimePasswordExtendedRequest
(which requires the user to
provide an authentication ID and a static password).
UnboundIDDeliveredOTPCredentials ::= SEQUENCE { authenticationID [0] OCTET STRING, authorizationID [1] OCTET STRING OPTIONAL. oneTimePassword [2] OCTET STRING, ... }
Field Summary | |
---|---|
static java.lang.String |
UNBOUNDID_DELIVERED_OTP_MECHANISM_NAME
The name for the UnboundID delivered OTP SASL mechanism. |
Fields inherited from class com.unboundid.ldap.sdk.SASLBindRequest |
---|
CRED_TYPE_SASL |
Fields inherited from class com.unboundid.ldap.sdk.BindRequest |
---|
VERSION_ELEMENT |
Constructor Summary | |
---|---|
UnboundIDDeliveredOTPBindRequest(java.lang.String authenticationID,
java.lang.String authorizationID,
java.lang.String oneTimePassword,
Control... controls)
Creates a new delivered one-time password bind request with the provided information. |
Method Summary | |
---|---|
static UnboundIDDeliveredOTPBindRequest |
decodeSASLCredentials(ASN1OctetString saslCredentials,
Control... controls)
Creates a new delivered one-time password bind request from the information contained in the provided encoded SASL credentials. |
UnboundIDDeliveredOTPBindRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
UnboundIDDeliveredOTPBindRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
static ASN1OctetString |
encodeCredentials(java.lang.String authenticationID,
java.lang.String authorizationID,
java.lang.String oneTimePassword)
Encodes the provided information into an ASN.1 octet string that may be used as the SASL credentials for an UnboundID delivered one-time password bind request. |
java.lang.String |
getAuthenticationID()
Retrieves the authentication identity for the bind request. |
java.lang.String |
getAuthorizationID()
Retrieves the authorization identity for the bind request, if available. |
int |
getLastMessageID()
Retrieves the message ID for the last LDAP message sent using this request. |
java.lang.String |
getOneTimePassword()
Retrieves the one-time password for the bind request. |
java.lang.String |
getSASLMechanismName()
Retrieves the name of the SASL mechanism used in this SASL bind request. |
protected BindResult |
process(LDAPConnection connection,
int depth)
Sends this bind request to the target server over the provided connection and returns the corresponding 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.SASLBindRequest |
---|
getBindType, responseReceived, sendBindRequest, sendMessage |
Methods inherited from class com.unboundid.ldap.sdk.BindRequest |
---|
getOperationType, getRebindRequest |
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 UNBOUNDID_DELIVERED_OTP_MECHANISM_NAME
Constructor Detail |
---|
public UnboundIDDeliveredOTPBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String oneTimePassword, Control... controls)
authenticationID
- The authentication identity for the bind request.
It must not be null
and must in the form
"u:" followed by a username, or "dn:" followed
by a DN.authorizationID
- The authorization identity for the bind request.
It may be null
if the authorization
identity should be the same as the authentication
identity. If an authorization identity is
specified, it must be in the form "u:" followed
by a username, or "dn:" followed by a DN. The
value "dn:" may be used to indicate the
authorization identity of the anonymous user.oneTimePassword
- The one-time password that has been delivered to
the user via the deliver one-time password
extended request. It must not be null
.controls
- The set of controls to include in the bind
request. It may be null
or empty if no
controls should be included.Method Detail |
---|
public static UnboundIDDeliveredOTPBindRequest decodeSASLCredentials(ASN1OctetString saslCredentials, Control... controls) throws LDAPException
saslCredentials
- The encoded SASL credentials to be decoded in
order to create this delivered one-time password
bind request. It must not be null
.controls
- The set of controls to include in the bind
request. It may be null
or empty if no
controls should be included.
LDAPException
- If the provided credentials are not valid for an
UNBOUNDID-DELIVERED-OTP bind request.public java.lang.String getAuthenticationID()
public java.lang.String getAuthorizationID()
null
if the authorization identity should be the same as the
authentication identity.public java.lang.String getOneTimePassword()
protected BindResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class BindRequest
connection
- The connection to use to send this bind request to the
server and read the associated response.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 static ASN1OctetString encodeCredentials(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String oneTimePassword)
authenticationID
- The authentication identity for the bind request.
It must not be null
and must in the form
"u:" followed by a username, or "dn:" followed
by a DN.authorizationID
- The authorization identity for the bind request.
It may be null
if the authorization
identity should be the same as the authentication
identity. If an authorization identity is
specified, it must be in the form "u:" followed
by a username, or "dn:" followed by a DN. The
value "dn:" may be used to indicate the
authorization identity of the anonymous user.oneTimePassword
- The one-time password that has been delivered to
the user via the deliver one-time password
extended request. It must not be null
.
public UnboundIDDeliveredOTPBindRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
public UnboundIDDeliveredOTPBindRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getSASLMechanismName()
getSASLMechanismName
in class SASLBindRequest
public int getLastMessageID()
getLastMessageID
in class SASLBindRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ReadOnlyLDAPRequest
toString
in class LDAPRequest
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 |