com.unboundid.ldap.sdk.unboundidds

Class UnboundIDDeliveredOTPBindRequest

java.lang.Object

com.unboundid.ldap.sdk.LDAPRequest

com.unboundid.ldap.sdk.BindRequest

com.unboundid.ldap.sdk.SASLBindRequest

com.unboundid.ldap.sdk.unboundidds.UnboundIDDeliveredOTPBindRequest

All Implemented Interfaces:

ReadOnlyLDAPRequest, java.io.Serializable

@NotMutable
 @ThreadSafety(level=NOT_THREADSAFE)
public final class UnboundIDDeliveredOTPBindRequest
extends SASLBindRequest

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

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 name for this SASL mechanism is "UNBOUNDID-DELIVERED-OTP". An UNBOUNDID-DELIVERED-OTP SASL bind request MUST include SASL credentials with the following ASN.1 encoding:

   UnboundIDDeliveredOTPCredentials ::= SEQUENCE {
        authenticationID     [0] OCTET STRING,
        authorizationID      [1] OCTET STRING OPTIONAL.
        oneTimePassword      [2] OCTET STRING,
        ... }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
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	toCode(java.util.List<java.lang.String> lineList, java.lang.String requestID, int indentSpaces, boolean includeProcessing) Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.
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, getReferralConnector, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNBOUNDID_DELIVERED_OTP_MECHANISM_NAME

@NotNull
public static final java.lang.String UNBOUNDID_DELIVERED_OTP_MECHANISM_NAME

The name for the UnboundID delivered OTP SASL mechanism.

See Also:

Constant Field Values

Constructor Detail

UnboundIDDeliveredOTPBindRequest

public UnboundIDDeliveredOTPBindRequest(@NotNull
                                        java.lang.String authenticationID,
                                        @Nullable
                                        java.lang.String authorizationID,
                                        @NotNull
                                        java.lang.String oneTimePassword,
                                        @Nullable
                                        Control... controls)

Creates a new delivered one-time password bind request with the provided information.

Parameters:

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

decodeSASLCredentials

@NotNull
public static UnboundIDDeliveredOTPBindRequest decodeSASLCredentials(@NotNull
                                                                              ASN1OctetString saslCredentials,
                                                                              @Nullable
                                                                              Control... controls)
                                                                       throws LDAPException

Creates a new delivered one-time password bind request from the information contained in the provided encoded SASL credentials.

Parameters:

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.

Returns:

The delivered one-time password bind request decoded from the provided credentials.

Throws:

LDAPException - If the provided credentials are not valid for an UNBOUNDID-DELIVERED-OTP bind request.

getAuthenticationID

@NotNull
public java.lang.String getAuthenticationID()

Retrieves the authentication identity for the bind request.

Returns:

The authentication identity for the bind request.

getAuthorizationID

@Nullable
public java.lang.String getAuthorizationID()

Retrieves the authorization identity for the bind request, if available.

Returns:

The authorization identity for the bind request, or null if the authorization identity should be the same as the authentication identity.

getOneTimePassword

@NotNull
public java.lang.String getOneTimePassword()

Retrieves the one-time password for the bind request.

Returns:

The one-time password for the bind request.

process

@NotNull
protected BindResult process(@NotNull
                                      LDAPConnection connection,
                                      int depth)
                               throws LDAPException

Sends this bind request to the target server over the provided connection and returns the corresponding response.

Specified by:

process in class BindRequest

Parameters:

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.

Returns:

The bind response read from the server.

Throws:

LDAPException - If a problem occurs while sending the request or reading the response.

encodeCredentials

@NotNull
public static ASN1OctetString encodeCredentials(@NotNull
                                                         java.lang.String authenticationID,
                                                         @Nullable
                                                         java.lang.String authorizationID,
                                                         @NotNull
                                                         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.

Parameters:

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.

Returns:

An ASN.1 octet string that may be used as the SASL credentials for an UnboundID delivered one-time password bind request.

duplicate

@NotNull
public UnboundIDDeliveredOTPBindRequest duplicate()

Creates a new instance of this LDAP request that may be modified without impacting this request.

Specified by:

duplicate in interface ReadOnlyLDAPRequest

Specified by:

duplicate in class BindRequest

Returns:

A new instance of this LDAP request that may be modified without impacting this request.

duplicate

@NotNull
public UnboundIDDeliveredOTPBindRequest 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.

Specified by:

duplicate in interface ReadOnlyLDAPRequest

Specified by:

duplicate in class BindRequest

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.

getSASLMechanismName

@NotNull
public java.lang.String getSASLMechanismName()

Retrieves the name of the SASL mechanism used in this SASL bind request.

Specified by:

getSASLMechanismName in class SASLBindRequest

Returns:

The name of the SASL mechanism used in this SASL bind request.

getLastMessageID

public int getLastMessageID()

Retrieves the message ID for the last LDAP message sent using this request.

Overrides:

getLastMessageID in class SASLBindRequest

Returns:

The message ID for the last LDAP message sent using this request, or -1 if it no LDAP messages have yet been sent using this request.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this request to the provided buffer.

Specified by:

toString in interface ReadOnlyLDAPRequest

Specified by:

toString in class LDAPRequest

Parameters:

buffer - The buffer to which to append a string representation of this request.

toCode

public void toCode(@NotNull
                   java.util.List<java.lang.String> lineList,
                   @NotNull
                   java.lang.String requestID,
                   int indentSpaces,
                   boolean includeProcessing)

Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.

Specified by:

toCode in interface ReadOnlyLDAPRequest

Overrides:

toCode in class SASLBindRequest

Parameters:

lineList - The list to which the source code lines should be added.

requestID - The name that should be used as an identifier for the request. If this is null or empty, then a generic ID will be used.

indentSpaces - The number of spaces that should be used to indent the generated code. It must not be negative.

includeProcessing - Indicates whether the generated code should include code required to actually process the request and handle the result (if true), or just to generate the request (if false).