LdapSession

java.lang.Object
- org.apache.directory.server.ldap.LdapSession

```
public class LdapSession
extends java.lang.Object
```
An object representing an LdapSession. Any connection established with the LDAP server forms a session.

Field Summary

Fields
Modifier and Type	Field and Description
`private org.apache.directory.api.ldap.model.message.BindStatus`	`bindStatus` The current Bind status
`private CoreSession`	`coreSession` The CoreSession
`private java.lang.String`	`currentMechanism` The current mechanism used to authenticate the user
`private static org.apache.directory.api.ldap.model.message.AbandonableRequest[]`	`EMPTY_ABANDONABLES` The list of requests we can abandon
`private org.apache.mina.core.session.IoSession`	`ioSession` The associated IoSession.
`private static boolean`	`IS_DEBUG` A speedup for logs
`private LdapServer`	`ldapServer` A reference on the LdapServer instance
`private static org.slf4j.Logger`	`LOG` The logger
`private java.lang.String`	`outstandingLock` A lock to protect the abandonableRequests against concurrent access
`private java.util.Map<java.lang.Integer,org.apache.directory.api.ldap.model.message.AbandonableRequest>`	`outstandingRequests` A map of all the running requests
`private java.util.Map<java.lang.Integer,PagedSearchContext>`	`pagedSearchContexts` A map containing all the paged search context
`private java.util.Map<java.lang.String,java.lang.Object>`	`saslProperties` A Map containing Objects used during the SASL negotiation
`private java.util.Map<java.lang.Integer,SearchRequestContainer>`	`searchRequests` A map of all the pending search requests

Constructor Summary

Constructors
Constructor and Description
`LdapSession(org.apache.mina.core.session.IoSession ioSession)` Creates a new instance of LdapSession associated with the underlying connection (MINA IoSession) to the server.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abandonAllOutstandingRequests()` Abandons all outstanding requests associated with this session.
`org.apache.directory.api.ldap.model.message.AbandonableRequest`	`abandonOutstandingRequest(int messageId)` Abandons a specific request by messageId.
`void`	`addPagedSearchContext(PagedSearchContext context)` Add a new Paged Search context into the stored context.
`void`	`clearSaslProperties()` Clear all the Sasl values stored into the Map
`void`	`closeAllPagedSearches()` Close all the pending cursors for all the pending PagedSearches
`org.apache.directory.api.ldap.model.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.core.session.IoSession`	`getIoSession()` Gets the MINA IoSession associated with this LdapSession.
`LdapServer`	`getLdapServer()`
`java.util.Map<java.lang.Integer,org.apache.directory.api.ldap.model.message.AbandonableRequest>`	`getOutstandingRequests()`
`PagedSearchContext`	`getPagedSearchContext(int contextId)` Get paged search context associated with an ID
`java.lang.Object`	`getSaslProperty(java.lang.String property)` Get a Sasl property's value
`SearchRequestContainer`	`getSearchRequest(int messageId)` Find the searchRequestContainer associated with a MessageID
`boolean`	`isAnonymous()` Check if the session is authenticated.
`boolean`	`isAuthenticated()` Check if the session is authenticated.
`boolean`	`isAuthPending()` Check if the session is processing a BindRequest, either Simple or SASL
`boolean`	`isSaslAuthPending()` Check if the session is processing a SASL BindRequest
`boolean`	`isSimpleAuthPending()` Check if the session is processing a Simple BindRequest
`void`	`putSaslProperty(java.lang.String property, java.lang.Object value)` Add a Sasl property and value
`void`	`registerOutstandingRequest(org.apache.directory.api.ldap.model.message.AbandonableRequest request)` Registers an outstanding request which can be abandoned later.
`void`	`registerSearchRequest(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor)` Registers a new searchRequest
`PagedSearchContext`	`removePagedSearchContext(int contextId)` Remove a Paged Search context from the map storing all of them.
`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`	`setCoreSession(CoreSession coreSession)` Sets the logical core DirectoryService session.
`void`	`setLdapServer(LdapServer ldapServer)` Store a reference on the LdapServer intance
`void`	`setSaslAuthPending()` Set the current BindStatus to SASL authentication pending
`void`	`setSimpleAuthPending()` Set the current BindStatus to Simple authentication pending
`java.lang.String`	`toString()` The principal and remote address associated with this session.
`void`	`unregisterOutstandingRequest(org.apache.directory.api.ldap.model.message.AbandonableRequest request)` Unregisters an outstanding request.
`void`	`unregisterSearchRequest(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)` Unregisters a completed search request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
private static final org.slf4j.Logger LOG
```
    The logger
  - IS_DEBUG
```
private static final boolean IS_DEBUG
```
    A speedup for logs
  - EMPTY_ABANDONABLES
```
private static final org.apache.directory.api.ldap.model.message.AbandonableRequest[] EMPTY_ABANDONABLES
```
    The list of requests we can abandon
  - outstandingLock
```
private final java.lang.String outstandingLock
```
    A lock to protect the abandonableRequests against concurrent access
  - ioSession
```
private final org.apache.mina.core.session.IoSession ioSession
```
    The associated IoSession. Usually, a LdapSession is established at the user request, which means we have a IoSession.
  - coreSession
```
private CoreSession coreSession
```
    The CoreSession
  - ldapServer
```
private LdapServer ldapServer
```
    A reference on the LdapServer instance
  - outstandingRequests
```
private java.util.Map<java.lang.Integer,org.apache.directory.api.ldap.model.message.AbandonableRequest> outstandingRequests
```
    A map of all the running requests
  - searchRequests
```
private java.util.Map<java.lang.Integer,SearchRequestContainer> searchRequests
```
    A map of all the pending search requests
  - bindStatus
```
private org.apache.directory.api.ldap.model.message.BindStatus bindStatus
```
    The current Bind status
  - currentMechanism
```
private java.lang.String currentMechanism
```
    The current mechanism used to authenticate the user
  - saslProperties
```
private java.util.Map<java.lang.String,java.lang.Object> saslProperties
```
    A Map containing Objects used during the SASL negotiation
  - pagedSearchContexts
```
private java.util.Map<java.lang.Integer,PagedSearchContext> pagedSearchContexts
```
    A map containing all the paged search context
- Constructor Detail
  - LdapSession
```
public LdapSession(org.apache.mina.core.session.IoSession ioSession)
```
    Creates a new instance of LdapSession associated with the underlying connection (MINA IoSession) to the server.
    
    Parameters:
    
    ioSession - the MINA session associated this LdapSession
- Method Detail
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Check if the session is authenticated. There are two conditions for a session to be authenticated :
    - the coreSession must not be null
    - and the state should be Authenticated.
    
    Returns:
    
    true if the session is not anonymous
  - isAnonymous
```
public boolean isAnonymous()
```
    Check if the session is authenticated. There are two conditions for a session to be authenticated :
    - it has to exist
    - and the session should not be anonymous.
    
    Returns:
    
    true if the session is not anonymous
  - isAuthPending
```
public boolean isAuthPending()
```
    Check if the session is processing a BindRequest, either Simple or SASL
    
    Returns:
    
    true if the session is in AuthPending state
  - isSimpleAuthPending
```
public boolean isSimpleAuthPending()
```
    Check if the session is processing a Simple BindRequest
    
    Returns:
    
    true if the session is in AuthPending state
  - isSaslAuthPending
```
public boolean isSaslAuthPending()
```
    Check if the session is processing a SASL BindRequest
    
    Returns:
    
    true if the session is in AuthPending state
  - getIoSession
```
public org.apache.mina.core.session.IoSession getIoSession()
```
    Gets the MINA IoSession associated with this LdapSession.
    
    Returns:
    
    the MINA IoSession
  - getCoreSession
```
public CoreSession getCoreSession()
```
    Gets the logical core DirectoryService session associated with this LdapSession.
    
    Returns:
    
    the logical core DirectoryService session
  - setCoreSession
```
public void setCoreSession(CoreSession coreSession)
```
    Sets the logical core DirectoryService session.
    
    Parameters:
    
    coreSession - the logical core DirectoryService session
  - abandonAllOutstandingRequests
```
public void abandonAllOutstandingRequests()
```
    Abandons all outstanding requests associated with this session.
  - abandonOutstandingRequest
```
public org.apache.directory.api.ldap.model.message.AbandonableRequest abandonOutstandingRequest(int messageId)
```
    Abandons a specific request by messageId.
    
    Parameters:
    
    messageId - The request ID to abandon
  - registerOutstandingRequest
```
public void registerOutstandingRequest(org.apache.directory.api.ldap.model.message.AbandonableRequest request)
```
    Registers an outstanding request which can be abandoned later.
    
    Parameters:
    
    request - an outstanding request that can be abandoned
  - unregisterOutstandingRequest
```
public void unregisterOutstandingRequest(org.apache.directory.api.ldap.model.message.AbandonableRequest request)
```
    Unregisters an outstanding request.
    
    Parameters:
    
    request - the request to unregister
  - getOutstandingRequests
```
public java.util.Map<java.lang.Integer,org.apache.directory.api.ldap.model.message.AbandonableRequest> getOutstandingRequests()
```
    Returns:
    
    A list of all the abandonable requests for this session.
  - registerSearchRequest
```
public void registerSearchRequest(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest,
                                  org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry> cursor)
```
    Registers a new searchRequest
    
    Parameters:
    
    searchRequest - a new searchRequest
  - unregisterSearchRequest
```
public void unregisterSearchRequest(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)
```
    Unregisters a completed search request.
    
    Parameters:
    
    searchRequest - the searchRequest to unregister
  - getSearchRequest
```
public SearchRequestContainer getSearchRequest(int messageId)
```
    Find the searchRequestContainer associated with a MessageID
    
    Parameters:
    
    messageId - the SearchRequestContainer MessageID we are looking for
  - getBindStatus
```
public org.apache.directory.api.ldap.model.message.BindStatus getBindStatus()
```
    Returns:
    
    the current bind status for this session
  - setSimpleAuthPending
```
public void setSimpleAuthPending()
```
    Set the current BindStatus to Simple authentication pending
  - setSaslAuthPending
```
public void setSaslAuthPending()
```
    Set the current BindStatus to SASL authentication pending
  - setAnonymous
```
public void setAnonymous()
```
    Set the current BindStatus to Anonymous
  - setAuthenticated
```
public void setAuthenticated()
```
    Set the current BindStatus to authenticated
  - getCurrentMechanism
```
public java.lang.String getCurrentMechanism()
```
    Get the mechanism selected by a user during a SASL Bind negotiation.
    
    Returns:
    
    The used mechanism, if any
  - putSaslProperty
```
public void putSaslProperty(java.lang.String property,
                            java.lang.Object value)
```
    Add a Sasl property and value
    
    Parameters:
    
    property - the property to add
    
    value - the value for this property
  - getSaslProperty
```
public java.lang.Object getSaslProperty(java.lang.String property)
```
    Get a Sasl property's value
    
    Parameters:
    
    property - the property to get
    
    Returns:
    
    the associated value, or null if we don't have such a property
  - clearSaslProperties
```
public void clearSaslProperties()
```
    Clear all the Sasl values stored into the Map
  - removeSaslProperty
```
public void removeSaslProperty(java.lang.String property)
```
    Remove a property from the SaslProperty map
    
    Parameters:
    
    property - the property to remove
  - getLdapServer
```
public LdapServer getLdapServer()
```
    Returns:
    
    The LdapServer reference
  - setLdapServer
```
public void setLdapServer(LdapServer ldapServer)
```
    Store a reference on the LdapServer intance
    
    Parameters:
    
    ldapServer - the LdapServer instance
  - addPagedSearchContext
```
public void addPagedSearchContext(PagedSearchContext context)
                           throws java.lang.Exception
```
    Add a new Paged Search context into the stored context. If some context with the same id already exists, it will be closed and removed.
    
    Parameters:
    
    context - The context to add
    
    Throws:
    
    java.lang.Exception
  - removePagedSearchContext
```
public PagedSearchContext removePagedSearchContext(int contextId)
```
    Remove a Paged Search context from the map storing all of them.
    
    Parameters:
    
    contextId - The context ID to remove
    
    Returns:
    
    The removed context if any found
  - closeAllPagedSearches
```
public void closeAllPagedSearches()
                           throws java.lang.Exception
```
    Close all the pending cursors for all the pending PagedSearches
    
    Throws:
    
    java.lang.Exception - If we've got an exception.
  - getPagedSearchContext
```
public PagedSearchContext getPagedSearchContext(int contextId)
```
    Get paged search context associated with an ID
    
    Parameters:
    
    contextId - The id for teh context we want to get
    
    Returns:
    
    The associated context, if any
  - toString
```
public java.lang.String toString()
```
    The principal and remote address associated with this session.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()

Class LdapSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

IS_DEBUG

EMPTY_ABANDONABLES

outstandingLock

ioSession

coreSession

ldapServer

outstandingRequests

searchRequests

bindStatus

currentMechanism

saslProperties

pagedSearchContexts

Constructor Detail

LdapSession

Method Detail

isAuthenticated

isAnonymous

isAuthPending

isSimpleAuthPending

isSaslAuthPending

getIoSession

getCoreSession

setCoreSession

abandonAllOutstandingRequests

abandonOutstandingRequest

registerOutstandingRequest

unregisterOutstandingRequest

getOutstandingRequests

registerSearchRequest

unregisterSearchRequest

getSearchRequest

getBindStatus

setSimpleAuthPending

setSaslAuthPending

setAnonymous

setAuthenticated

getCurrentMechanism

putSaslProperty

getSaslProperty

clearSaslProperties

removeSaslProperty

getLdapServer

setLdapServer

addPagedSearchContext

removePagedSearchContext

closeAllPagedSearches

getPagedSearchContext

toString