public interface

WebSessionManager

implements RequestPersistable
com.microstrategy.web.beans.WebSessionManager
Known Indirect Subclasses

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebIServerSession getActiveSession()
Returns the WebIServerSession in the list currently considered to be active.
abstract WebIServerSessionList getSessionList()
Returns the underlying WebIServerSessionList object.
abstract WebIServerSession setActiveSession(String key)
Sets the active session to be the session with the given key in the collection.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.RequestPersistable

Public Methods

public abstract WebIServerSession getActiveSession ()

Returns the WebIServerSession in the list currently considered to be active.

Returns
  • The current active session.

public abstract 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.

public abstract WebIServerSession setActiveSession (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.