|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.message.AbstractMessage
org.apache.directory.shared.ldap.message.AbstractRequest
org.apache.directory.shared.ldap.message.BindRequestImpl
Bind protocol operation request which authenticates and begins a client session. Does not yet contain interfaces for SASL authentication mechanisms.
Field Summary | |
BindResponse |
response
|
Fields inherited from interface org.apache.directory.shared.ldap.message.BindRequest |
RESP_TYPE, TYPE |
Constructor Summary | |
BindRequestImpl(int id)
Creates an BindRequest implementation to bind to an LDAP server. |
Method Summary | |
void |
abandon()
RFC 2251 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned. |
boolean |
equals(java.lang.Object obj)
Checks to see if two messages are equivalent. |
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. |
MessageTypeEnum |
getResponseType()
Gets the protocol response message type for this request which produces at least one response. |
ResultResponse |
getResultResponse()
The result containing response for this request. |
java.lang.String |
getSaslMechanism()
Gets the mechanism if this request uses SASL authentication mechanisms. |
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 mechanism)
Sets the mechanism associated with a SASL authentication |
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. |
java.lang.String |
toString()
Get a String representation of a BindRequest |
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractRequest |
hasResponse |
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractMessage |
add, get, getControls, getMessageId, getType, put, remove |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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 BindResponse response
Constructor Detail |
public BindRequestImpl(int id)
id
- the sequence identifier of the BindRequest message.Method Detail |
public boolean isSimple()
isSimple
in interface BindRequest
public boolean getSimple()
getSimple
in interface BindRequest
public void setSimple(boolean isSimple)
setSimple
in interface BindRequest
isSimple
- true if authentication is simple, false otherwise.public byte[] getCredentials()
getCredentials
in interface BindRequest
public void setCredentials(byte[] credentials)
setCredentials
in interface BindRequest
credentials
- the credentials if authentication is simple, null otherwisepublic java.lang.String getSaslMechanism()
getSaslMechanism
in interface BindRequest
public void setSaslMechanism(java.lang.String mechanism)
setSaslMechanism
in interface BindRequest
mechanism
- the mechanism otherwisepublic java.lang.String getName()
getName
in interface BindRequest
public void setName(java.lang.String name)
setName
in interface BindRequest
name
- the DN of the authenticating user - leave null for annonymous
user.public boolean isVersion3()
isVersion3
in interface BindRequest
public boolean getVersion3()
getVersion3
in interface BindRequest
public void setVersion3(boolean isVersion3)
setVersion3
in interface BindRequest
isVersion3
- if true the client will be exhibiting version 3 bind behavoir,
if false is used version 2 behavoir will be exhibited.public MessageTypeEnum getResponseType()
getResponseType
in interface SingleReplyRequest
public ResultResponse getResultResponse()
getResultResponse
in interface ResultResponseRequest
public boolean equals(java.lang.Object obj)
AbstractMessage
equals
in class AbstractMessage
obj
- the object to compare this Message to for equalitypublic java.lang.String toString()
public void abandon()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |