Package com.unboundid.directory.sdk.common.operation

Interface UpdatableSimpleBindRequest

All Superinterfaces:

BindRequest, Request, SimpleBindRequest, UpdatableBindRequest, UpdatableRequest

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface UpdatableSimpleBindRequest
extends SimpleBindRequest, UpdatableBindRequest

This interface defines a set of methods which may be used to update a simple bind request.

Method Summary

Modifier and Type	Method	Description
UpdatableSASLBindRequest	convertToSASLBindRequest(java.lang.String saslMechanism, ASN1OctetString saslCredentials)	Converts this simple bind request to a SASL bind request.
void	setDN(DN dn)	Specifies the DN of the user attempting to bind.
void	setDN(java.lang.String dn)	Specifies the DN of the user attempting to bind.
void	setPassword(ByteString password)	Specifies the password for the bind request.
void	setPassword(java.lang.String password)	Specifies the password for the bind request.

Methods inherited from interface com.unboundid.directory.sdk.common.operation.Request

getOperationType, getRequestControls

Methods inherited from interface com.unboundid.directory.sdk.common.operation.SimpleBindRequest

getDN, getPassword, toLDAPSDKRequest

Methods inherited from interface com.unboundid.directory.sdk.common.operation.UpdatableRequest

addRequestControl, setRequestControls

Method Detail

setDN

void setDN(java.lang.String dn)

Specifies the DN of the user attempting to bind.

Parameters:

dn - The DN of the user that is trying to authenticate. It must not be null, but it may be an empty string to indicate a zero-length DN.

setDN

void setDN(DN dn)

Specifies the DN of the user attempting to bind.

Parameters:

dn - The DN of the user that is trying to authenticate. It must not be null, but it may be an empty string to indicate a zero-length DN.

setPassword

void setPassword(ByteString password)

Specifies the password for the bind request.

Parameters:

password - The password for the bind request. It must not be null but may be a zero-length byte string for anonymous authentication.

setPassword

void setPassword(java.lang.String password)

Specifies the password for the bind request.

Parameters:

password - The password for the bind request. It must not be null but may be a zero-length byte string for anonymous authentication.

convertToSASLBindRequest

UpdatableSASLBindRequest convertToSASLBindRequest(java.lang.String saslMechanism,
                                                  ASN1OctetString saslCredentials)

Converts this simple bind request to a SASL bind request. After invoking this method, the caller should not make any further attempt to access this simple bind request object, but should only interact with the UpdatableSASLBindRequest object that is returned.

Parameters:

saslMechanism - The name of the SASL mechanism to use for the SASL bind request. This must not be null or empty.

saslCredentials - The encoded SASL credentials to use for the SASL bind request. This may be null if no SASL credentials are needed.

Returns:

The UpdatableSASLBindRequest that was created and will be used for the operation going forward.