public interface BindRequest extends SingleReplyRequest, AbandonableRequest
Modifier and Type | Method and Description |
---|---|
BindRequest |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
BindRequest |
addControl(Control control)
Adds a control to this Message.
|
byte[] |
getCredentials()
Gets the simple credentials associated with a simple authentication
attempt or null if this request uses SASL authentication mechanisms.
|
Dn |
getDn()
Gets the DN of the subject in this authentication
request.
|
String |
getName()
Gets the name of the subject in this authentication
request.
|
String |
getSaslMechanism()
Gets the SASL mechanism String associated with this BindRequest if the
bind operation is using SASL.
|
boolean |
getSimple()
Checks to see if the authentication mechanism is simple and not SASL
based.
|
boolean |
getVersion3()
Gets whether or not the Ldap v3 protocol is used.
|
boolean |
isSimple()
Checks to see if the authentication mechanism is simple and not SASL
based.
|
boolean |
isVersion3()
Checks to see if the Ldap v3 protocol is used.
|
BindRequest |
removeControl(Control control)
Deletes a control removing it from this Message.
|
BindRequest |
setCredentials(byte[] credentials)
Sets the simple credentials associated with a simple authentication
attempt.
|
BindRequest |
setCredentials(String credentials)
Sets the simple credentials associated with a simple authentication
attempt.
|
BindRequest |
setDn(Dn name)
Sets the DN of the subject in this authentication
request.
|
BindRequest |
setMessageId(int messageId)
Sets the Message ID for this request
|
BindRequest |
setName(String name)
Sets the name of the subject in this authentication
request.
|
BindRequest |
setSaslMechanism(String saslMechanism)
Sets the SASL mechanism String associated with this BindRequest if the
bind operation is using SASL.
|
BindRequest |
setSimple(boolean isSimple)
Sets the authentication mechanism to simple or to SASL based
authentication.
|
BindRequest |
setVersion3(boolean isVersion3)
Sets whether or not the LDAP v3 or v2 protocol is used.
|
getResponseType
getResultResponse
hasResponse
get, getControl, getControls, getMessageId, getType, hasControl, put
abandon, addAbandonListener, isAbandoned
boolean isSimple()
boolean getSimple()
BindRequest setSimple(boolean isSimple)
isSimple
- true if authentication is simple, false otherwise.byte[] getCredentials()
BindRequest setCredentials(String credentials)
credentials
- the credentials if authentication is simpleBindRequest setCredentials(byte[] credentials)
credentials
- the credentials if authentication is simpleString getName()
BindRequest setName(String name)
name
- the name of the authenticating user - leave null for anonymous user.Dn getDn()
BindRequest setDn(Dn name)
name
- the DN of the authenticating user - leave null for anonymous user.boolean isVersion3()
boolean getVersion3()
BindRequest setVersion3(boolean isVersion3)
isVersion3
- if true the client will be exhibiting version 3 bind behavior,
If false is used version 2 behavior will be exhibited.String getSaslMechanism()
BindRequest setSaslMechanism(String saslMechanism)
saslMechanism
- the SASL mechanismBindRequest setMessageId(int messageId)
setMessageId
in interface Message
messageId
- The message IdBindRequest addControl(Control control)
addControl
in interface Message
control
- the control to add.BindRequest addAllControls(Control[] controls)
addAllControls
in interface Message
controls
- the controls to add.BindRequest removeControl(Control control)
removeControl
in interface Message
control
- the control to remove.Copyright © 2003–2018 The Apache Software Foundation. All rights reserved.