|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest
org.apache.directory.shared.ldap.message.AbstractAbandonableRequest
org.apache.directory.shared.ldap.message.BindRequestImpl
public class BindRequestImpl
Bind protocol operation request which authenticates and begins a client session. Does not yet contain interfaces for SASL authentication mechanisms.
Field Summary | |
---|---|
InternalBindResponse |
response
The associated response |
Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalBindRequest |
---|
RESP_TYPE, TYPE |
Constructor Summary | |
---|---|
BindRequestImpl(int id)
Creates an BindRequest implementation to bind to an LDAP server. |
Method Summary | |
---|---|
void |
abandon()
RFC 2251/4511 [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. |
DN |
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. |
InternalResultResponse |
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. |
int |
hashCode()
|
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(DN 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.AbstractAbandonableRequest |
---|
addAbandonListener, isAbandoned |
Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest |
---|
hasResponse |
Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage |
---|
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest |
---|
hasResponse |
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage |
---|
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove |
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalAbandonableRequest |
---|
addAbandonListener, isAbandoned |
Field Detail |
---|
public InternalBindResponse response
Constructor Detail |
---|
public BindRequestImpl(int id)
id
- the sequence identifier of the BindRequest message.Method Detail |
---|
public boolean isSimple()
isSimple
in interface InternalBindRequest
public boolean getSimple()
getSimple
in interface InternalBindRequest
public void setSimple(boolean isSimple)
setSimple
in interface InternalBindRequest
isSimple
- true if authentication is simple, false otherwise.public byte[] getCredentials()
getCredentials
in interface InternalBindRequest
public void setCredentials(byte[] credentials)
setCredentials
in interface InternalBindRequest
credentials
- the credentials if authentication is simple, null otherwisepublic java.lang.String getSaslMechanism()
getSaslMechanism
in interface InternalBindRequest
public void setSaslMechanism(java.lang.String mechanism)
setSaslMechanism
in interface InternalBindRequest
mechanism
- the mechanism otherwisepublic DN getName()
getName
in interface InternalBindRequest
public void setName(DN name)
setName
in interface InternalBindRequest
name
- the DN of the authenticating user - leave null for annonymous
user.public boolean isVersion3()
isVersion3
in interface InternalBindRequest
public boolean getVersion3()
getVersion3
in interface InternalBindRequest
public void setVersion3(boolean isVersion3)
setVersion3
in interface InternalBindRequest
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 InternalResultResponse getResultResponse()
getResultResponse
in interface InternalResultResponseRequest
public void abandon()
abandon
in interface InternalAbandonableRequest
abandon
in class AbstractAbandonableRequest
public boolean equals(java.lang.Object obj)
InternalAbstractMessage
equals
in class InternalAbstractMessage
obj
- the object to compare this Message to for equalityObject.equals(Object)
public int hashCode()
hashCode
in class InternalAbstractRequest
Object.hashCode()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |