WebSessionManager (Web API 2021)

All Superinterfaces:

EnumWebPersistableState, Persistable, RequestPersistable

All Known Subinterfaces:

WebAppSessionManager

All Known Implementing Classes:

ServerAdminSessionManager, WebAppSessionManagerImpl, WebSessionManagerImpl
```
public interface WebSessionManager
extends RequestPersistable
```
This is the interface for the MicroStrategy Web session manager. This interface contains methods for all session management related functionality. It maintains a WebIServerSessionList of WebIServerSession objects. It has an active session, which is the session that all requests will be directed to.

Field Summary
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`WebIServerSession`	`getActiveSession()`	Returns the `WebIServerSession` in the list currently considered to be active.
`WebIServerSessionList`	`getSessionList()`	Returns the underlying `WebIServerSessionList` object.
`WebIServerSession`	`initActiveSessionFromRequestKeys(RequestKeys rk, AbstractConfigurableContainerServices acs)`
`WebIServerSession`	`setActiveSession(java.lang.String key)`	Sets the active session to be the session with the given key in the collection.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest

- Method Detail
  - getSessionList
```
WebIServerSessionList getSessionList()
```
    Returns the underlying WebIServerSessionList object. This object represents a list of sessions that are being managed by the session manager.
    
    Returns:
    
    The WebIServerSessionList object representing the list of sessions being managed by the session manager.
  - getActiveSession
```
WebIServerSession getActiveSession()
```
    Returns the WebIServerSession in the list currently considered to be active.
    
    Returns:
    
    The current active session.
  - setActiveSession
```
WebIServerSession setActiveSession(java.lang.String key)
```
    Sets the active session to be the session with the given key in the collection. The newly set active session will be returned. If there exists no session with the given key in the collection, then this method will return null.
    
    Parameters:
    
    key - The key to look for in the session list.
    
    Returns:
    
    The session set as active, or null if the active session has not changed.
  - initActiveSessionFromRequestKeys
```
WebIServerSession initActiveSessionFromRequestKeys(RequestKeys rk,
                                                   AbstractConfigurableContainerServices acs)
```