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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description UpdatableSimpleBindRequestconvertToSimpleBindRequest(DN dn, ByteString password)Converts this SASL bind request to a simple bind request.voidsetSASLCredentials(java.lang.String saslMechanism, ASN1OctetString saslCredentials)Specifies the SASL credentials for the bind request, if any.-
Methods inherited from interface com.unboundid.directory.sdk.common.operation.Request
getOperationType, getRequestControls
-
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
-
-
-
-
Method Detail
-
setSASLCredentials
void setSASLCredentials(java.lang.String saslMechanism, 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 benull.saslCredentials- The SASL credentials for the bind request. It may benullif no credentials should be used.
-
convertToSimpleBindRequest
UpdatableSimpleBindRequest convertToSimpleBindRequest(DN dn, 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 theUpdatableSimpleBindRequestobject that is returned.- Parameters:
dn- The DN to use for the simple bind request. It must not benullbut 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 benullbut may be empty for anonymous simple authentication (in which case the DN must also be empty).- Returns:
- The
UpdatableSimpleBindRequestthat was created and will be used for the operation going forward.
-
-