com.unboundid.directory.sdk.common.operation

Interface UpdatableSASLBindRequest

All Superinterfaces:

BindRequest, Request, SASLBindRequest, UpdatableBindRequest, UpdatableRequest

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface UpdatableSASLBindRequest
extends SASLBindRequest, UpdatableBindRequest

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

Method Summary

Modifier and Type	Method and Description
UpdatableSimpleBindRequest	convertToSimpleBindRequest(com.unboundid.ldap.sdk.DN dn, com.unboundid.util.ByteString password) Converts this SASL bind request to a simple bind request.
void	setSASLCredentials(java.lang.String saslMechanism, com.unboundid.asn1.ASN1OctetString saslCredentials) Specifies the SASL credentials for the bind request, if any.

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

getSASLCredentials, getSASLMechanism, toLDAPSDKRequest

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

addRequestControl, setRequestControls

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

getOperationType, getRequestControls

Method Detail

setSASLCredentials

void setSASLCredentials(java.lang.String saslMechanism,
                        com.unboundid.asn1.ASN1OctetString saslCredentials)

Specifies the SASL credentials for the bind request, if any.

Parameters:

saslMechanism - The name of the SASL mechanism to use. It must not be null.

saslCredentials - The SASL credentials for the bind request. It may be null if no credentials should be used.

convertToSimpleBindRequest

UpdatableSimpleBindRequest convertToSimpleBindRequest(com.unboundid.ldap.sdk.DN dn,
                                                      com.unboundid.util.ByteString password)

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

Parameters:

dn - The DN to use for the simple bind request. It must not be null but may be empty for anonymous simple authentication (in which case the password must also be empty).

password - The password to use for the simple bind request. It must not be null but may be empty for anonymous simple authentication (in which case the DN must also be empty).

Returns:

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