|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.ldap.LdapSession
public class LdapSession
An object representing an LdapSession. Any connection established with the LDAP server forms a session.
Constructor Summary | |
---|---|
LdapSession(org.apache.mina.common.IoSession ioSession)
Creates a new instance of LdapSession associated with the underlying connection (MINA IoSession) to the server. |
Method Summary | |
---|---|
void |
abandonAllOutstandingRequests()
Abandons all outstanding requests associated with this session. |
org.apache.directory.shared.ldap.message.AbandonableRequest |
abandonOutstandingRequest(java.lang.Integer messageId)
Abandons a specific request by messageId. |
void |
clearSaslProperties()
Clear all the Sasl values stored into the Map |
org.apache.directory.shared.ldap.message.BindStatus |
getBindStatus()
|
CoreSession |
getCoreSession()
Gets the logical core DirectoryService session associated with this LdapSession. |
java.lang.String |
getCurrentMechanism()
Get the mechanism selected by a user during a SASL Bind negotiation. |
org.apache.mina.common.IoSession |
getIoSession()
Gets the MINA IoSession associated with this LdapSession. |
LdapService |
getLdapServer()
|
java.util.Map<java.lang.Integer,org.apache.directory.shared.ldap.message.AbandonableRequest> |
getOutstandingRequests()
|
java.lang.Object |
getSaslProperty(java.lang.String property)
Get a Sasl property's value |
boolean |
isAnonymous()
Check if the session is authenticated. |
boolean |
isAuthenticated()
Check if the session is authenticated. |
boolean |
isAuthPending()
Check if the session is in the middle of a SASL negotiation. |
void |
putSaslProperty(java.lang.String property,
java.lang.Object value)
Add a Sasl property and value |
void |
registerOutstandingRequest(org.apache.directory.shared.ldap.message.AbandonableRequest request)
Registers an outstanding request which can be abandoned later. |
void |
removeSaslProperty(java.lang.String property)
Remove a property from the SaslProperty map |
void |
setAnonymous()
Set the current BindStatus to Anonymous |
void |
setAuthenticated()
Set the current BindStatus to authenticated |
void |
setAuthPending()
Set the current BindStatus to authentication pending |
void |
setCoreSession(CoreSession coreSession)
Sets the logical core DirectoryService session. |
void |
setLdapServer(LdapService ldapService)
Store a reference on the LdapService intance |
void |
unregisterOutstandingRequest(org.apache.directory.shared.ldap.message.AbandonableRequest request)
Unregisters an outstanding request. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LdapSession(org.apache.mina.common.IoSession ioSession)
ioSession
- the MINA session associated this LdapSessionMethod Detail |
---|
public boolean isAuthenticated()
true
if the session is not anonymouspublic boolean isAnonymous()
true
if the session is not anonymouspublic boolean isAuthPending()
true
if the session is in AuthPending statepublic org.apache.mina.common.IoSession getIoSession()
public CoreSession getCoreSession()
public void setCoreSession(CoreSession coreSession)
coreSession
- the logical core DirectoryService sessionpublic void abandonAllOutstandingRequests()
public org.apache.directory.shared.ldap.message.AbandonableRequest abandonOutstandingRequest(java.lang.Integer messageId)
public void registerOutstandingRequest(org.apache.directory.shared.ldap.message.AbandonableRequest request)
request
- an outstanding request that can be abandonedpublic void unregisterOutstandingRequest(org.apache.directory.shared.ldap.message.AbandonableRequest request)
request
- the request to unregisterpublic java.util.Map<java.lang.Integer,org.apache.directory.shared.ldap.message.AbandonableRequest> getOutstandingRequests()
public org.apache.directory.shared.ldap.message.BindStatus getBindStatus()
public void setAuthPending()
public void setAnonymous()
public void setAuthenticated()
public java.lang.String getCurrentMechanism()
public void putSaslProperty(java.lang.String property, java.lang.Object value)
property
- the property to addvalue
- the value for this propertypublic java.lang.Object getSaslProperty(java.lang.String property)
property
- the property to get
public void clearSaslProperties()
public void removeSaslProperty(java.lang.String property)
property
- the property to removepublic LdapService getLdapServer()
public void setLdapServer(LdapService ldapService)
ldapService
- the LdapService instance
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |