HttpBrowserSettings

This class is deprecated.
Use CookieBrowserSettings instead.

Class Overview

This class represents an implementation of the BrowserSettings interface. The values of the settings this class has access to come from cookies saved on the user's computer or the URL query string. For being able to set and retrieve these values successfully, the ContainerServices is required by the constructor. When asked to set a setting, it will be saved as a cookie with the specified name (key). When requesting a value, it will first try to retrieve it from the URL; if not found there, it will try to get its value from the cookies.

The different BrowserSettings available through this class can be defined as: Generic settings:
=> Values will be found on the URL as parameters if they were generated by the buildBrowserSettingURLParameter() method
=> Values can be saved when using the setValue(keyName, value) method. => Values can be retrieved using the getValue(keyName) method.

Project settings:
These are the settings that are directly related with a user IServer session. The values are stored as temporal cookies on the client machine, meaning they will disappear once the browser session is ended.
=> Values can be saved when using the setSessionValue(keyName, value) method, once the current session has been specified by using the setSession() method. => Values can also be saved if using the setSessionValue(keyName, value, session) method, for specifying the session this value is related to, if different from the current session => Values can be retrieved using the getSessionValue(keyName) method.

Temporal settings:
These settings are also temporal but are not related with any IServer user session.
=> Values can be saved when using the setHttpSessionValue(keyName, value) method. => Values can be retrieved using the getHttpSessionValue(keyName) method.

Retrieving values from cookie is transparent to users since they get properly formatted when calling the different setValue() methods.

Summary

[Expand] Inherited Constants
From class com.microstrategy.web.app.GenericBrowserSettings String GENERIC_HTTP_SESSION_KEY Primary key to use for representing global temporal browser setting values String GENERIC_KEY Primary key to use for representing global persistent browser setting values String GENERIC_PROJECT_KEY_PREFIX key name prefix for project settings *
From interface com.microstrategy.web.objects.EnumBrowserType int BROWSER_TYPE_ANDROID int BROWSER_TYPE_CHROME int BROWSER_TYPE_EDGE int BROWSER_TYPE_FIREFOX int BROWSER_TYPE_FIREFOX_2 int BROWSER_TYPE_FIREFOX_3 int BROWSER_TYPE_FIREFOX_3_5 int BROWSER_TYPE_IE Constant that represents the Internet Explorer family browsers int BROWSER_TYPE_IE10 int BROWSER_TYPE_IE11 int BROWSER_TYPE_IE6 int BROWSER_TYPE_IE7 int BROWSER_TYPE_IE8 int BROWSER_TYPE_IE9 int BROWSER_TYPE_IE_W3C int BROWSER_TYPE_NETSCAPE Constant that represents the Netscape family browsers int BROWSER_TYPE_OTHER Constant that represents browsers that do not belong to the Netscape or IE family int BROWSER_TYPE_SAFARI int BROWSER_TYPE_SAFARI_3 int BROWSER_TYPE_SAFARI_3_1 int BROWSER_TYPE_SAFARI_4 int BROWSER_TYPE_UNKNOWN browser type unknown

[Expand] Inherited Fields
From class com.microstrategy.web.app.GenericBrowserSettings protected ContainerServices _containerServices Instance of ContainerServices to be used for accessing the values of Form, Query String and cookies protected WebIServerSession _session Instance of WebIServerSession related with the BrowserSettings currently processed

[Expand] Inherited Methods
From class com.microstrategy.web.app.GenericBrowserSettings void addCacheValue(String key, String value) This method is deprecated. it is only used by deprecated classes. void addCacheValue(String key, String value, boolean persistable) 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, String subkey) 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. 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 Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
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() Clear the session browser settings for current Intelligence Server session. abstract void clearSessionValues(WebIServerSession session) Clear the session browser settings for the given 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) Persists the specified value under the specified key for the default session abstract void setSessionValue(String keyName, String value, WebIServerSession session) Persists the specified value under the specified key for the indicated session abstract void setValue(String keyName, String value) Persists the specified value under the specified key