Package com.microstrategy.web.app

Class CookieBrowserSettings

java.lang.Object

com.microstrategy.web.app.GenericBrowserSettings

com.microstrategy.web.app.AbstractBrowserSettings

com.microstrategy.web.app.CookieBrowserSettings

All Implemented Interfaces:

BrowserSettings, EnumBrowserType

public class CookieBrowserSettings
extends AbstractBrowserSettings

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.

Since:

MicroStrategy Web 8.0.2

Field Summary

Fields inherited from class com.microstrategy.web.app.AbstractBrowserSettings

_bSet, _bSetHttpSession, _bSetSession

Fields inherited from class com.microstrategy.web.app.GenericBrowserSettings

_containerServices, _session, GENERIC_HTTP_SESSION_KEY, GENERIC_KEY, GENERIC_PROJECT_KEY_PREFIX

Fields inherited from interface com.microstrategy.web.objects.EnumBrowserType

BROWSER_TYPE_ANDROID, BROWSER_TYPE_CHROME, BROWSER_TYPE_EDGE, BROWSER_TYPE_FIREFOX, BROWSER_TYPE_FIREFOX_2, BROWSER_TYPE_FIREFOX_3, BROWSER_TYPE_FIREFOX_3_5, BROWSER_TYPE_IE, BROWSER_TYPE_IE_W3C, BROWSER_TYPE_IE10, BROWSER_TYPE_IE11, BROWSER_TYPE_IE6, BROWSER_TYPE_IE7, BROWSER_TYPE_IE8, BROWSER_TYPE_IE9, BROWSER_TYPE_NETSCAPE, BROWSER_TYPE_OTHER, BROWSER_TYPE_SAFARI, BROWSER_TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor	Description
CookieBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices, boolean storeTemporarySettingInCookie)	Class Constructor.

Method Summary

Modifier and Type	Method	Description
void	clearHttpSessionValues()	Clears temporary browser settings
void	clearSessionBrowserSettings()	Clear the session browser settings for current Intelligence Server session.
void	clearSessionValues(WebIServerSession session)	Clears session browser settings
java.lang.String	getSessionValue(java.lang.String keyName)	Returns the value of the key sent as parameter, related with the setting corresponding to the default session
protected com.microstrategy.web.app.BrowserSettingElement	loadHttpSessionValues()	Load temporary browser settings
protected com.microstrategy.web.app.BrowserSettingElement	loadSessionValues()	Loads project browser settings.
protected com.microstrategy.web.app.BrowserSettingElement	loadValues()	Loads permanent browser settings
protected void	storeHttpSessionValues(com.microstrategy.web.app.BrowserSettingElement bSetHttpSession)	Stores temporary settings to Web session.
protected void	storeSessionValues(com.microstrategy.web.app.BrowserSettingElement bSetSession)	Store project browser setting windows to web session.
protected void	storeValues(com.microstrategy.web.app.BrowserSettingElement bSet)	Stores permanent browser settings in permanent cookies

Methods inherited from class com.microstrategy.web.app.AbstractBrowserSettings

canStore, clearSessionValues, flush, getHttpSessionValue, getProjectKey, getSessionValue, getValue, getValue, hasValueSet, setHttpSessionValue, setSession, setSessionValue, setSessionValue, setValue

Methods inherited from class com.microstrategy.web.app.GenericBrowserSettings

addCacheValue, addCacheValue, getBrowserCompatName, getBrowserName, getBrowserType, getBrowserTypeAndVersion, getBrowserVersion, getCacheNames, getCacheValue, getCacheValue, getDebugOut, getDefaultValue, getDefinitionList, getLocale, getPreferences, getSession, getUserAgent, getValueFromQueryString, isCacheValueModified, isCacheValuePersistable, isCSS2Supported, isDHTMLSupported, isEdgeModeEnabled, isValueCached, isValueSafeForXSS, setCacheValuePersistable, setDefinitionList, setIframeVisibility, setPreferences, updateCacheValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CookieBrowserSettings

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.

Method Detail

clearSessionValues

public void clearSessionValues(WebIServerSession session)

Clears session browser settings

Specified by:

clearSessionValues in interface BrowserSettings

Overrides:

clearSessionValues in class AbstractBrowserSettings

clearHttpSessionValues

public void clearHttpSessionValues()

Clears temporary browser settings

Specified by:

clearHttpSessionValues in interface BrowserSettings

Overrides:

clearHttpSessionValues in class AbstractBrowserSettings

storeSessionValues

protected void storeSessionValues(com.microstrategy.web.app.BrowserSettingElement bSetSession)

Store project browser setting windows to web session.

Overrides:

storeSessionValues in class AbstractBrowserSettings

storeHttpSessionValues

protected void storeHttpSessionValues(com.microstrategy.web.app.BrowserSettingElement bSetHttpSession)

Stores temporary settings to Web session.

Overrides:

storeHttpSessionValues in class AbstractBrowserSettings

storeValues

protected void storeValues(com.microstrategy.web.app.BrowserSettingElement bSet)

Stores permanent browser settings in permanent cookies

Specified by:

storeValues in class AbstractBrowserSettings

loadSessionValues

protected com.microstrategy.web.app.BrowserSettingElement loadSessionValues()

Loads project browser settings.

Overrides:

loadSessionValues in class AbstractBrowserSettings

getSessionValue

public java.lang.String getSessionValue(java.lang.String keyName)

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

Specified by:

getSessionValue in interface BrowserSettings

Overrides:

getSessionValue in class AbstractBrowserSettings

Parameters:

keyName - the name associated with the value to return

Returns:

the value found under the specified key

loadHttpSessionValues

protected com.microstrategy.web.app.BrowserSettingElement loadHttpSessionValues()

Load temporary browser settings

Overrides:

loadHttpSessionValues in class AbstractBrowserSettings

loadValues

protected com.microstrategy.web.app.BrowserSettingElement loadValues()

Loads permanent browser settings

Specified by:

loadValues in class AbstractBrowserSettings

clearSessionBrowserSettings

public void clearSessionBrowserSettings()

Description copied from interface: BrowserSettings

Clear the session browser settings for current Intelligence Server session.