|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Bind protocol operation request which authenticates and begins a client session. Does not yet contain interfaces for SASL authentication mechanisms.
Field Summary | |
static MessageTypeEnum |
RESP_TYPE
Bind response message type enumeration value |
static MessageTypeEnum |
TYPE
Bind request message type enumeration value |
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. |
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. |
void |
setCredentials(byte[] credentials)
Sets the simple credentials associated with a simple authentication attempt ignored if this request uses SASL authentication mechanisms. |
void |
setName(java.lang.String name)
Sets the distinguished name of the subject in this authentication request. |
void |
setSaslMechanism(java.lang.String saslMechanism)
Sets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL. |
void |
setSimple(boolean isSimple)
Sets the authentication mechanism to simple or to SASL based authentication. |
void |
setVersion3(boolean isVersion3)
Sets whether or not the LDAP v3 or v2 protocol is used. |
Methods inherited from interface org.apache.directory.shared.ldap.message.SingleReplyRequest |
getResponseType |
Methods inherited from interface org.apache.directory.shared.ldap.message.ResultResponseRequest |
getResultResponse |
Methods inherited from interface org.apache.directory.shared.ldap.message.Request |
hasResponse |
Methods inherited from interface org.apache.directory.shared.ldap.message.Message |
add, get, getControls, getMessageId, getType, put, remove |
Field Detail |
public static final MessageTypeEnum TYPE
public static final MessageTypeEnum RESP_TYPE
Method Detail |
public boolean isSimple()
public boolean getSimple()
public void setSimple(boolean isSimple)
isSimple
- true if authentication is simple, false otherwise.public byte[] getCredentials()
public void setCredentials(byte[] credentials)
credentials
- the credentials if authentication is simple, null otherwisepublic java.lang.String getName()
public void setName(java.lang.String name)
name
- the DN of the authenticating user - leave null for annonymous
user.public boolean isVersion3()
public boolean getVersion3()
public void setVersion3(boolean isVersion3)
isVersion3
- if true the client will be exhibiting version 3 bind behavoir,
if false is used version 2 behavoir will be exhibited.public java.lang.String getSaslMechanism()
public void setSaslMechanism(java.lang.String saslMechanism)
saslMechanism
- the SASL mechanism
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |