public class

WebSessionManagerImpl

extends AbstractPersistable
implements WebSessionManager
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.beans.WebSessionManagerImpl
Known Direct Subclasses
Known Indirect Subclasses

Summary

Constants
String WebSessionManagerState
String WebUserSessionManagerState
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Fields
protected WebIServerSessionList _sessionList
Public Constructors
WebSessionManagerImpl()
Public Methods
WebIServerSession getActiveSession()
Returns the WebIServerSession in the list currently considered to be active.
String getKey()
Returns the key of the Session Manager.
WebIServerSessionList getSessionList()
Returns the underlying WebIServerSessionList object.
boolean restoreState(String state)
Restores a component based on its saved state.
boolean restoreStateFromRequest(RequestKeys rk, String keyName)
Restores a WebComponent based on the RequestKeys instance.
boolean restoreStateFromRequest(RequestKeys rk)
Restores a WebComponent based on the RequestKeys instance.
WebIServerSession setActiveSession(String key)
Sets the active session to be the session with the given key in the collection.
Protected Methods
void init()
boolean restoreSessionListState(WebIServerSessionList list, String state)
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.WebSessionManager

Constants

public static final String WebSessionManagerState

Constant Value: "mstrSmgr"

public static final String WebUserSessionManagerState

Constant Value: "usrSmgr"

Fields

protected WebIServerSessionList _sessionList

Public Constructors

public WebSessionManagerImpl ()

Public Methods

public WebIServerSession getActiveSession ()

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

Returns
  • The current active session.

public String getKey ()

Returns the key of the Session Manager. This value is used to store and retrieve the state of the Session Manager.

public 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 boolean restoreState (String state)

Restores a component based on its saved state.

Parameters
state the state of a component
Returns
  • true if restoration succeeds.

public boolean restoreStateFromRequest (RequestKeys rk, String keyName)

Restores a WebComponent based on the RequestKeys instance. This method retrieves the saved state of a component based on the parameter keyName.

Parameters
rk a RequestKeys instance.
keyName the key to the state of a component.
Returns
  • true if restoration succeeds.

public boolean restoreStateFromRequest (RequestKeys rk)

Restores a WebComponent based on the RequestKeys instance. This method retrieves the saved state of a component based on the component's name.

Parameters
rk a RequestKeys instance.
Returns
  • true if restoration succeeds.

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

Protected Methods

protected void init ()

protected boolean restoreSessionListState (WebIServerSessionList list, String state)