public class

CookieBrowserSettings

extends AbstractBrowserSettings
java.lang.Object
   ↳ com.microstrategy.web.app.GenericBrowserSettings
     ↳ com.microstrategy.web.app.AbstractBrowserSettings
       ↳ com.microstrategy.web.app.CookieBrowserSettings

Class Overview

This class provides cookie implementation of BrowserSettings interface. The permanent settings will be stored in permanent cookies. The temporary and project temporary settings will be stored in web session. The implementation relies on ContainerService to provide namespace support.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.GenericBrowserSettings
From interface com.microstrategy.web.objects.EnumBrowserType
[Expand]
Inherited Fields
From class com.microstrategy.web.app.AbstractBrowserSettings
From class com.microstrategy.web.app.GenericBrowserSettings
Public Constructors
CookieBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices, boolean storeTemporarySettingInCookie)
Class Constructor.
Public Methods
void clearHttpSessionValues()
Clears temporary browser settings
void clearSessionBrowserSettings()
void clearSessionValues(WebIServerSession session)
Clears session browser settings
String getSessionValue(String keyName)
Returns the value of the key sent as parameter, related with the setting corresponding to the default session
Protected Methods
BrowserSettingElement loadHttpSessionValues()
Load temporary browser settings
BrowserSettingElement loadSessionValues()
Loads project browser settings.
BrowserSettingElement loadValues()
Loads permanent browser settings
void storeHttpSessionValues(BrowserSettingElement bSetHttpSession)
Stores temporary settings to Web session.
void storeSessionValues(BrowserSettingElement bSetSession)
Store project browser setting windows to web session.
void storeValues(BrowserSettingElement bSet)
Stores permanent browser settings in permanent cookies
[Expand]
Inherited Methods
From class com.microstrategy.web.app.AbstractBrowserSettings
From class com.microstrategy.web.app.GenericBrowserSettings
From class java.lang.Object
From interface com.microstrategy.web.app.BrowserSettings

Public Constructors

public CookieBrowserSettings (BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices, boolean storeTemporarySettingInCookie)

Class Constructor. This requires a non-null Container Services object for this feature.

Parameters
bsDefinitionList an the BrowserSettingDefinitionList object from the PageManager object containing the default values of the spplication's browser settings.
containerServices an initialized instance of ContainerServices
storeTemporarySettingInCookie boolean, indicates whether we store the temporary settings to cookies. The implementation explicitly stores non-namespaced cookie.

Public Methods

public void clearHttpSessionValues ()

Clears temporary browser settings

public void clearSessionBrowserSettings ()

public void clearSessionValues (WebIServerSession session)

Clears session browser settings

public String getSessionValue (String keyName)

Returns the value of the key sent as parameter, related with the setting corresponding to the default session

Parameters
keyName the name associated with the value to return
Returns
  • the value found under the specified key

Protected Methods

protected BrowserSettingElement loadHttpSessionValues ()

Load temporary browser settings

protected BrowserSettingElement loadSessionValues ()

Loads project browser settings.

protected BrowserSettingElement loadValues ()

Loads permanent browser settings

protected void storeHttpSessionValues (BrowserSettingElement bSetHttpSession)

Stores temporary settings to Web session.

protected void storeSessionValues (BrowserSettingElement bSetSession)

Store project browser setting windows to web session.

protected void storeValues (BrowserSettingElement bSet)

Stores permanent browser settings in permanent cookies