public abstract class

AbstractBrowserSettings

extends GenericBrowserSettings

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

Known Direct Subclasses

CookieBrowserSettings, PreferenceBrowserSettings

Class Overview

This class provides a common implementation of BrowserSettings interface. The environment-dependend browser settings classes override or implement the load or store methods.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.GenericBrowserSettings

From interface com.microstrategy.web.objects.EnumBrowserType

Fields
protected BrowserSettingElement	_bSet	Container for browser setting values
protected BrowserSettingElement	_bSetHttpSession	Container for HttpSession browser setting values
protected BrowserSettingElement	_bSetSession	Container for Session browser setting values

[Expand]

Inherited Fields

From class com.microstrategy.web.app.GenericBrowserSettings

Protected Constructors
	AbstractBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices)

Public Methods
void	clearHttpSessionValues()
void	clearSessionValues() Clears session browser settings
void	clearSessionValues(WebIServerSession session)
void	flush() Store the browser settings windows to more persistent storage.
String	getHttpSessionValue(String keyName) Returns the http session value of the key sent as parameter
String	getSessionValue(String keyName, WebIServerSession session) Returns the value of the key sent as parameter, related with the setting corresponding to the indicated session.
String	getSessionValue(String keyName) Returns the value of the key sent as parameter, related with the setting corresponding to the default session
String	getValue(String keyName) Returns the value of the key sent as parameter
boolean	hasValueSet(String keyName) Checks whether a value has been set for the given key name or not
void	setHttpSessionValue(String keyName, String value) Persists the specified http session value under the specified key.
void	setSession(WebIServerSession currentSession) Sets the session that will be used as default when accessing session settings and also reloads session browser settings.
void	setSessionValue(String keyName, String value, WebIServerSession session) Persists the specified value under the specified key for the indicated session
void	setSessionValue(String keyName, String value) Persists the specified value under the specified key for the default session
void	setValue(String keyName, String value) Persists the specified value under the specified key.

Protected Methods
boolean	canStore(BrowserSettingElement bSet)
String	getProjectKey(WebIServerSession session) Returns the key to be used for the requested session
String	getValue(BrowserSettingElement browserSettingElement, String keyName, boolean checkForXSS) Get browser setting value.
BrowserSettingElement	loadHttpSessionValues() Load temporary browser setting windows from web session.
BrowserSettingElement	loadSessionValues() Load project browser setting windows from web session.
abstract BrowserSettingElement	loadValues() Store permenant browser setting windows in persistent storage.
void	storeHttpSessionValues(BrowserSettingElement bSetHttpSession) Store temporary browser setting windows to web session.
void	storeSessionValues(BrowserSettingElement bSetSession) Store project browser setting windows to web session.
abstract void	storeValues(BrowserSettingElement bSet) Load permanent browser setting windows from persistent storage.

[Expand]

Inherited Methods

From class com.microstrategy.web.app.GenericBrowserSettings

void	addCacheValue(String key, String value, boolean persistable) This method is deprecated. it is only used by deprecated classes.
void	addCacheValue(String key, String value) This method is deprecated. it is only used by deprecated classes.
String	getBrowserCompatName() Returns the name of the IE browser including its status to indicate whether it is requesitng in Compatibility Mode.
String	getBrowserName() Returns the name of the browser that is being used for performing the request
int	getBrowserType() Returns the type of the browser that is being used for performing the request being handled.
int	getBrowserTypeAndVersion() Returns the type and the version of the browser
String	getBrowserVersion() Returns the numeric version of the browser that is being used.
Enumeration	getCacheNames() This method is deprecated. it is only used by deprecated classes.
String	getCacheValue(String key) This method is deprecated. it is only used by deprecated classes.
String	getCacheValue(String key, String subkey) This method is deprecated. it is only used by deprecated classes.
MarkupOutput	getDebugOut() Get the Debug Information into the output
String	getDefaultValue(String key) Return the default value of a specific setting.
BrowserSettingDefinitionList	getDefinitionList() Return the default definition of the browser setting which will be use to determine the value of the browser settings in case the setting requested is not found for the user.
String	getLocale() Get the locale value saved as browser setting
Preferences	getPreferences() Get the Preferences instance currently assigned to this BrowserSettings
WebIServerSession	getSession() Gets the session that is used as default when accessing session settings.
String	getUserAgent() Retrives the USER-AGENT string from the header of the browser.
String	getValueFromQueryString(String keyName, String subKeyName) This method is deprecated. it is only used by deprecated classes.
boolean	hasValueSet(String keyName) Checks whether a value has been set for the given key name or not
boolean	isCSS2Supported() Indicates if the browser currently used by the client can handle CSS 2 styles.
boolean	isCacheValueModified(String key) This method is deprecated. it is only used by deprecated classes.
boolean	isCacheValuePersistable(String key) This method is deprecated. it is only used by deprecated classes.
boolean	isDHTMLSupported() Indicates if the browser currently used by the client can handle DHTML content or not.
boolean	isEdgeModeEnabled() Get flag whether System Preference enables a tag to force IE browsers to render in highest Document Mode.
boolean	isValueCached(String key) This method is deprecated. it is only used by deprecated classes.
boolean	isValueSafeForXSS(String key, String value) Check if the value is safe for XSS, which means check the value contains valid HTML tag or not
void	setCacheValuePersistable(String key, boolean persistable) This method is deprecated. it is only used by deprecated classes.
void	setDefinitionList(BrowserSettingDefinitionList bsDefinitionList) Sets the default definition of the browser setting.
void	setIframeVisibility(String value) Define a browser setting for allowing the IFrame to be shown on DHTML environments.
void	setPreferences(Preferences preferences) Set the Preferences instance to use for this BrowserSettings instance
void	setSession(WebIServerSession currentSession) Sets the session that will be used as default when accessing session settings.
String	updateCacheValue(String key, String subkey, String newValue) This method is deprecated. it is only used by deprecated classes.

From class java.lang.Object

From interface com.microstrategy.web.app.BrowserSettings

abstract void	clearHttpSessionValues() Clear http session browser settings.
abstract void	clearSessionBrowserSettings() This method is deprecated. use `clearSessionValues()` or `clearSessionValues(WebIServerSession)`.
abstract void	clearSessionValues(WebIServerSession session) Clear the session browser settings for the given session.
abstract void	clearSessionValues() Clear the session browser settings for current Intelligence Server session.
abstract void	flush() Prepare all required headers so browser settings are sent back to the client as cookies.
abstract String	getBrowserCompatName() Returns the name of the IE browser including its status to indicate whether it is requesitng in Compatibility Mode.
abstract String	getBrowserName() Returns the name of the browser that is being used for performing the request
abstract int	getBrowserType() Returns the type of the browser that is being used for performing the request being handled.
abstract int	getBrowserTypeAndVersion() Returns the type and the version of the browser that is being used for performing the request
abstract String	getBrowserVersion() Returns the numeric version of the browser that is being used.
abstract MarkupOutput	getDebugOut() Get the Debug Information into the output
abstract String	getDefaultValue(String key) Return the default value of a specific setting if not found for the current user.
abstract BrowserSettingDefinitionList	getDefinitionList() Return the default definition of the browser setting which will be use to determine the value of the browser settings in case the setting requested is not found for the user.
abstract String	getHttpSessionValue(String keyName) Returns the http session value of the key sent as parameter
abstract String	getLocale() This method is deprecated. Not used anymore. Use `getSession()` to get the display locale instead.
abstract Preferences	getPreferences() Get the Preferences instance currently assigned to this BrowserSettings
abstract WebIServerSession	getSession() Gets the session that is used as default when accessing session settings.
abstract String	getSessionValue(String keyName, WebIServerSession session) Returns the value of the key sent as parameter, related with the setting corresponding to the indicated session
abstract String	getSessionValue(String keyName) Returns the value of the key sent as parameter, related with the setting corresponding to the default session
abstract String	getUserAgent() Retrives the USER-AGENT string from the header of the browser.
abstract String	getValue(String keyName) Returns the value of the key sent as parameter
abstract boolean	hasValueSet(String keyName) Checks whether a value has been set for the given key name or not
abstract boolean	isCSS2Supported() Indicates if the browser currently used by the client can handle CSS 2 styles.
abstract boolean	isDHTMLSupported() Indicates if the browser currently used by the client can handle DHTML content or not.
abstract boolean	isEdgeModeEnabled() Get flag whether System Preference enables a tag or http header X-UA-COMPATIBLE to force IE browsers to render in highest Document Mode.
abstract void	setDefinitionList(BrowserSettingDefinitionList bsDefinitionList) Sets the default definition of the browser setting.
abstract void	setHttpSessionValue(String keyName, String value) Persists the specified http session value under the specified key
abstract void	setIframeVisibility(String value) Define a browser setting for allowing the IFrame to be shown on DHTML environments.
abstract void	setPreferences(Preferences preferences) Set the Preferences instance to use for this BrowserSettings instance
abstract void	setSession(WebIServerSession currentSession) Sets the session that will be used as default when accessing session settings.
abstract void	setSessionValue(String keyName, String value, WebIServerSession session) Persists the specified value under the specified key for the indicated session
abstract void	setSessionValue(String keyName, String value) Persists the specified value under the specified key for the default session
abstract void	setValue(String keyName, String value) Persists the specified value under the specified key

Fields

protected BrowserSettingElement _bSet

Container for browser setting values

protected BrowserSettingElement _bSetHttpSession

Container for HttpSession browser setting values

protected BrowserSettingElement _bSetSession

Container for Session browser setting values

Protected Constructors

protected AbstractBrowserSettings (BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices)

Public Methods

public void clearHttpSessionValues ()

public void clearSessionValues ()

Clears session browser settings

public void clearSessionValues (WebIServerSession session)

public void flush ()

Store the browser settings windows to more persistent storage.

public String getHttpSessionValue (String keyName)

Returns the http session value of the key sent as parameter

Parameters

keyName	the name associated with the value to return

Returns

the value found under the specified key. If not found, returns null

public String getSessionValue (String keyName, WebIServerSession session)

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

Parameters

keyName	the name associated with the value to return
session	an initialized `WebIServerSession` instance

Returns

the value found under the specified key, for the specified session

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

public String getValue (String keyName)

Returns the value of the key sent as parameter

Parameters

keyName	the name associated with the value to return

Returns

the value found under the specified key.

public boolean hasValueSet (String keyName)

Checks whether a value has been set for the given key name or not

Parameters

keyName	the name associated with the setting

Returns

true if there is a value been set already (other than the default)

public void setHttpSessionValue (String keyName, String value)

Persists the specified http session value under the specified key. If the value sent is null, no changes will be saved.

Parameters

keyName	name under to which the new setting will be saved
value	value of the setting to be saved

public void setSession (WebIServerSession currentSession)

Sets the session that will be used as default when accessing session settings and also reloads session browser settings.

Parameters

currentSession	an initialized `WebIServerSession` instance that represents the current session opened.

public void setSessionValue (String keyName, String value, WebIServerSession session)

Persists the specified value under the specified key for the indicated session

Parameters

keyName	name under to which the new setting will be saved
value	value of the setting to be saved
session	an initialized `WebIServerSession` instance

public void setSessionValue (String keyName, String value)

Persists the specified value under the specified key for the default session

Parameters

keyName	name under to which the new setting will be saved
value	value of the setting to be saved

public void setValue (String keyName, String value)

Persists the specified value under the specified key. If the value sent is null, no changes will be saved.

Parameters

keyName	name under to which the new setting will be saved
value	value of the setting to be saved

Protected Methods

protected boolean canStore (BrowserSettingElement bSet)

protected String getProjectKey (WebIServerSession session)

Returns the key to be used for the requested session

Parameters

session	an initialized `WebIServerSession` instance

Returns

a key built based on the session information sent as parameter. Returns null, if the session is not valid.

protected String getValue (BrowserSettingElement browserSettingElement, String keyName, boolean checkForXSS)

Get browser setting value.

Parameters

browserSettingElement	An instance of BrowserSettingElement.
keyName	The browser setting key.
checkForXSS	TODO

Returns

If the value is not found in browserSettings given, returns the default value defined in browser setting definition.

protected BrowserSettingElement loadHttpSessionValues ()

Load temporary browser setting windows from web session.

protected BrowserSettingElement loadSessionValues ()

Load project browser setting windows from web session.

protected abstract BrowserSettingElement loadValues ()

Store permenant browser setting windows in persistent storage.

protected void storeHttpSessionValues (BrowserSettingElement bSetHttpSession)

Store temporary browser setting windows to web session.

protected void storeSessionValues (BrowserSettingElement bSetSession)

Store project browser setting windows to web session.

protected abstract void storeValues (BrowserSettingElement bSet)

Load permanent browser setting windows from persistent storage.

Interfaces

Classes

Exceptions

AbstractBrowserSettings

Class Overview

Summary

Fields

protected BrowserSettingElement _bSet

protected BrowserSettingElement _bSetHttpSession

protected BrowserSettingElement _bSetSession

Protected Constructors

protected AbstractBrowserSettings (BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices)

Public Methods

public void clearHttpSessionValues ()

public void clearSessionValues ()

public void clearSessionValues (WebIServerSession session)

public void flush ()

public String getHttpSessionValue (String keyName)

Parameters

Returns

public String getSessionValue (String keyName, WebIServerSession session)

Parameters

Returns

public String getSessionValue (String keyName)

Parameters

Returns

public String getValue (String keyName)

Parameters

Returns

public boolean hasValueSet (String keyName)

Parameters

Returns

public void setHttpSessionValue (String keyName, String value)

Parameters

public void setSession (WebIServerSession currentSession)

Parameters

public void setSessionValue (String keyName, String value, WebIServerSession session)

Parameters

public void setSessionValue (String keyName, String value)

Parameters

public void setValue (String keyName, String value)

Parameters

Protected Methods

protected boolean canStore (BrowserSettingElement bSet)

protected String getProjectKey (WebIServerSession session)

Parameters

Returns

protected String getValue (BrowserSettingElement browserSettingElement, String keyName, boolean checkForXSS)

Parameters

Returns

protected BrowserSettingElement loadHttpSessionValues ()

protected BrowserSettingElement loadSessionValues ()

protected abstract BrowserSettingElement loadValues ()

protected void storeHttpSessionValues (BrowserSettingElement bSetHttpSession)

protected void storeSessionValues (BrowserSettingElement bSetSession)

protected abstract void storeValues (BrowserSettingElement bSet)