|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.ldap.client.api.message.AbstractMessage
org.apache.directory.ldap.client.api.message.AbstractRequest
org.apache.directory.ldap.client.api.message.BindRequest
public class BindRequest
Bind protocol operation request which authenticates and begins a client session.
Constructor Summary | |
---|---|
BindRequest()
Creates a new instance of BindRequest. |
Method Summary | |
---|---|
byte[] |
getCredentials()
Gets the simple credentials associated with a simple authentication attempt or null if this request uses SASL authentication mechanisms. |
java.lang.String |
getName()
Gets the distinguished name of the subject in this authentication request. |
java.lang.String |
getSaslMechanism()
Gets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL. |
int |
getVersion()
Gets the Ldap protocol version 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 |
setCredentials(byte[] credentials)
Sets the simple credentials associated with a simple authentication attempt ignored if this request uses SASL authentication mechanisms. |
BindRequest |
setCredentials(java.lang.String credentials)
Sets the simple credentials associated with a simple authentication attempt ignored if this request uses SASL authentication mechanisms. |
BindRequest |
setName(java.lang.String name)
Sets the distinguished name of the subject in this authentication request. |
BindRequest |
setSasl()
Sets the authentication mechanism to SASL |
BindRequest |
setSaslMechanism(java.lang.String saslMechanism)
Sets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL. |
BindRequest |
setVersion(int version)
Sets whether or not the LDAP v3 or v2 protocol is used. |
java.lang.String |
toString()
Get a String representation of a BindRequest |
Methods inherited from class org.apache.directory.ldap.client.api.message.AbstractRequest |
---|
getTimeout, setTimeout |
Methods inherited from class org.apache.directory.ldap.client.api.message.AbstractMessage |
---|
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.directory.ldap.client.api.message.Request |
---|
getTimeout, setTimeout |
Methods inherited from interface org.apache.directory.ldap.client.api.message.Message |
---|
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId |
Constructor Detail |
---|
public BindRequest()
Method Detail |
---|
public byte[] getCredentials()
public BindRequest setCredentials(byte[] credentials)
credentials
- the credentials if authentication is simple, null otherwise
public BindRequest setCredentials(java.lang.String credentials)
credentials
- the credentials if authentication is simple, null otherwise
public java.lang.String getName()
public BindRequest setName(java.lang.String name)
name
- the DN of the authenticating user - leave null for annonymous
user.
public java.lang.String getSaslMechanism()
public BindRequest setSaslMechanism(java.lang.String saslMechanism)
saslMechanism
- the SASL mechanism
public int getVersion()
public BindRequest setVersion(int version)
version
- The version. Should be 3 or 2
public boolean isSimple()
public boolean isVersion3()
public BindRequest setSasl()
public java.lang.String toString()
toString
in class AbstractMessage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |