com.microstrategy.web.app.beans.AppContext |
![]() |
This interface maintains a reference to all the context objects required by
the application.
It saves an instance of specific applications objects, such as the
SessionManager
, the Preferences
and the PageManager
.
It extends the BeanContext by adding information not only relevant to the
WebComponents in the application, but for the application itself.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | CONFIG_ADMIN_SERVERS | Name of the file containing the i-servers the application is conencted to | |||||||||
String | CONFIG_ADMIN_SERVLET_NAME | URI of the deployed applciation for web administration servlet | |||||||||
String | CONFIG_APP_BEANS_EVENTS | Name of the application events definition file | |||||||||
String | CONFIG_BLOCK_LIBRARY | Location of the BLOCK LIBRARY to use. | |||||||||
String | CONFIG_CACHE_SETTINGS_FILE | cache config file | |||||||||
String | CONFIG_CACHE_SETTINGS_PROP | ||||||||||
String | CONFIG_CONFIG_FILES_DEFAULT_LOCATION | Config files location | |||||||||
String | CONFIG_CONTROLLER_CLASS | Location of the configuration file | |||||||||
String | CONFIG_DEBUG_FLAGS_MASK | Debug Mask Flag | |||||||||
String | CONFIG_DEFAULT_BLANK_ANALYSIS_ID | Indicates the default object id for the blank Analysis object. | |||||||||
String | CONFIG_DEFAULT_BLANK_HTML5_DASHBOARD_ID | Indicates the default object id for the blank Analysis object. | |||||||||
String | CONFIG_DEFAULT_BLANK_REPORT_ID | Indicates the default object id for the blank report object. | |||||||||
String | CONFIG_DEFAULT_BLANK_REPORT_WRITING_ID | Indicates the default object id for the blank report writing object. | |||||||||
String | CONFIG_DEFAULT_BLANK_XDA_REPORT_ID | Indicates the default object id for the blank xda report object. | |||||||||
String | CONFIG_DEFAULT_EVENT | Application's default event id | |||||||||
String | CONFIG_DEFAULT_PDF_IMAGES_FOLDER | Application's default images folder for PDF. | |||||||||
String | CONFIG_DISABLE_MAX_STATE_COMPRESSION | Constant used for specifying whether to compress XML status for RWBean and ReportBean,of which the size of XML status tends to be big. | |||||||||
String | CONFIG_EXCEL_DIRECT_EXPORT | Indicates if the application uses the excel direct export functionality | |||||||||
String | CONFIG_EXTERNAL_SECURITY_CLASS | Name of the class to be used as external security component on the application | |||||||||
String | CONFIG_FORMATTER_FILE | formatter config file | |||||||||
String | CONFIG_FORMAT_PROPERTIES_MAPPING | file to store the mapping of formatting properties between the back end and the browser | |||||||||
String | CONFIG_GLOBAL_FEATURES_CLASS | Name of the class to be used as external security component on the application | |||||||||
String | CONFIG_IFRAME_JSP | Name of the jsp containing the iframe logic | |||||||||
String | CONFIG_IFRAME_RESOURCE | Name of the JSP used for the IFrame | |||||||||
String | CONFIG_IPAADMIN_FILE | Name of the file containing the IPA configuration | |||||||||
String | CONFIG_IPAENV_FILE | Name of the file containing the IPA environments | |||||||||
String | CONFIG_ISERVER_POLLING_FREQUENCY | polling frequency for asyncrhronous call to the i-server | |||||||||
String | CONFIG_LOG_FILES_DEFAULT_LOCATION | Logger properties file location | |||||||||
String | CONFIG_LOG_FILE_MB_SIZE_LIMIT | Maximum log file size | |||||||||
String | CONFIG_LOG_PROPERTIES_FILE | Logger properties file | |||||||||
String | CONFIG_MD_BEANS_EVENTS | Name of the md events definition file | |||||||||
String | CONFIG_MESSAGES | Name of the MessagesManager object initialization file | |||||||||
String | CONFIG_OBJBROWSER_FOLDERLINKS_FILE | file that stores the folderLinks for object browsers | |||||||||
String | CONFIG_PAGE_MANAGER | Location of the configuration file | |||||||||
String | CONFIG_PAGE_MANAGER_RESOURCE | Name of the configurations file's master copy | |||||||||
String | CONFIG_PREFERENCES | Location of the user preferences file | |||||||||
String | CONFIG_PREFERENCES_GROUPS | Name of the grouped preferences file | |||||||||
String | CONFIG_PREFERENCES_GROUPS_RESOURCE | Mame of the preferences groups' master copy | |||||||||
String | CONFIG_RELOAD_CONFIG | Reload configuration file on every request | |||||||||
String | CONFIG_SERVER_ADMIN_SERVLET_NAME | URI of the deployed applciation for intelligence server administration servlet | |||||||||
String | CONFIG_SERVER_TYPE | ||||||||||
String | CONFIG_SERVLET_COMPONENT_NAME | Name of servlet component name | |||||||||
String | CONFIG_SERVLET_EVENT_HANDLER_NAME | Name of servlet component event handler | |||||||||
String | CONFIG_SERVLET_NAME | URI of the deployed applciation | |||||||||
String | CONFIG_SERVLET_PATH | Servlet's path | |||||||||
String | CONFIG_SSL_KEYSTORE | ||||||||||
String | CONFIG_SSL_KEYSTORE_PWD | ||||||||||
String | CONFIG_SSL_TRUSTSTORE | ||||||||||
String | CONFIG_SSL_TRUSTSTORE_PWD | ||||||||||
String | CONFIG_STYLE_CATALOG | Location of the style catalog's file | |||||||||
String | CONFIG_STYLE_CATALOG_RESOURCE | Name of the style catalog's master file | |||||||||
String | CONFIG_SUBSCRIPTION_API_RESOURCE | Mame of the subscription api proeprties master copy | |||||||||
String | CONFIG_SUBSCRIPTION_API_TEMPLATE_RESOURCE | Mame of the subscription template properties master copy | |||||||||
String | CONFIG_SUBSCRIPTION_ENGINE_RESOURCE | Mame of the subscriptions engine properties master copy | |||||||||
String | CONFIG_SUBSCRIPTION_FOLDER | Location of the subscription properties files | |||||||||
String | CONFIG_SUBSCRIPTION_PORTAL_RESOURCE | Mame of the subscription portal properties master copy | |||||||||
String | CONFIG_SYS_DEFINITONS_RESOURCE | Mame of the user preferences' master copy | |||||||||
String | CONFIG_SYS_PREFERENCE_DEFINITION | Location of the admin preferences file | |||||||||
String | CONFIG_SYS_SERVER_DEFAULTS | Name of the file containing the default values for i-servers' configuaration | |||||||||
String | CONFIG_SYS_SERVER_DEFAULTS_RESOURCE | Mame of the admin preferences' master copy | |||||||||
String | CONFIG_WEBAPIERRORS_CLASSPATH | Classpath prefix of WebAPIErrors property files. | |||||||||
String | CONFIG_WEBAPIERRORS_FOLDER | Destination of dispensed WebAPIErrors property files. | |||||||||
String | CONFIG_WEB_SERVLET_NAME | URI of the deployed applciation for web servlet | |||||||||
String | CONFIG_WIDGET_LIBRARY | This constant is deprecated. Use CONFIG_BLOCK_LIBRARY instead. | |||||||||
String | CONFIG_XHR_JSP | Name of the jsp containing the xhr partial update content | |||||||||
String | CUSTOM_HELP_RESOUCRCES_FOLDER | Constant used for specifying the type of resources level to return => Custom Help folder (plugins) | |||||||||
String | CUSTOM_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => CUSTOM folders | |||||||||
String | DEFAULT_EVENT_XML | Constant used for the default events xml relative to the configuration path. | |||||||||
String | DISPLAY_MODE_HTML | Constant used to indicate that the rendering will be done in format of html | |||||||||
String | DISPLAY_MODE_JSON | Constant used to indicate that the rendering will be done in format of json | |||||||||
String | HELP_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => Help folder | |||||||||
String | IMAGE_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => Images folder | |||||||||
String | JAVASCRIPT_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => Javascript folder | |||||||||
String | JSP_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => JSP folder | |||||||||
String | RESOURCE_FOLDER_PREFIX | Prefix used to know which configParameters are resourceFolders | |||||||||
String | STYLE_DB_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => Styles folder for double byte | |||||||||
String | STYLE_FIXED_FONT_DB_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => Styles folder with fixed font for double byte | |||||||||
String | STYLE_FIXED_FONT_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => Styles folder with fixed font | |||||||||
String | STYLE_RESOURCES_FOLDER | Constant used for specifying the type of resources level to return => Styles folder |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract void |
dispenseFile(String realPath, String resourcePath)
Dispenses the master copy of the a resource file located in the classpath into the
file indicated in the realpath
| ||||||||||
abstract WebAppSessionManager |
getAppSessionManager()
This method returns the Application Session Manager associated with this application context.
| ||||||||||
abstract String |
getBrowserHeaderLocaleId()
This method will extract from request header a value corresponding to browser's locale info.
| ||||||||||
abstract String |
getBrowserHeaderLocaleId(Locale defaultLocale)
This method will extract from request header a value corresponding to browser's locale info.
| ||||||||||
abstract String |
getBrowserLocaleId()
This method returns the Locale Id defined in web preferences as Language.
| ||||||||||
abstract String |
getBrowserServerLocaleId()
This method returns the Locale associated with Date and Number format locale web preference.If default, it'll return
browser's locale Id instead.
| ||||||||||
abstract BrowserSettings |
getBrowserSettings()
This method returns the BrowserSettings object associated with this
application context.
| ||||||||||
abstract String |
getConfigParameter(String param)
Returns the value of a configuration parameter.
| ||||||||||
abstract String |
getConfigServletPath()
Get the full application path to the Servlet as defined in the configuration file
| ||||||||||
abstract ContextMenuManager |
getContextMenuManager(String contextMenuName)
Returns an instance of a
ContextMenuManager object. | ||||||||||
abstract PageComponent |
getCurrentPage()
Returns the name of the current page associated with the context.
| ||||||||||
abstract Document |
getDocumentFromFileResource(String filePath)
This method returns a DOM Document from a file resource.
| ||||||||||
abstract ExternalSecurity |
getExternalSecurity()
This method returns the External Security instance associated with this application context.
| ||||||||||
abstract String |
getFileContentsAsString(String filePath, String encoding)
Returns the contents of the resource file as string from the file path provided using the named character encoding.
| ||||||||||
abstract String |
getFileContentsAsString(String filePath)
Returns the contents of the resource file as string from the file path provided.
| ||||||||||
abstract String |
getFontName()
Returns a string with the name of the fonts, or the list of fonts
that a browser should use when rendering the page.
| ||||||||||
abstract String |
getFontSize()
A string with the base font size to use, the string
might contain the type of size (i.e, pt, px, etc.)
| ||||||||||
abstract PageManager |
getPageManager()
This method gets the PageManager object associated with this application context.
| ||||||||||
abstract Preferences |
getPreferences()
This method returns the Preferences object associated with this application context.
| ||||||||||
abstract String |
getRealPath(String filePath)
Return the absolute path of th erelative path provided
| ||||||||||
abstract String |
getResourceFileAsString(String filePath, String resourceFileName)
Returns the contents of the resource file as string from the file path provided.
| ||||||||||
abstract String |
getResourcesFolder(String folderType)
Return the path to the resources folder indicated on the configuration file, corresponding to the
type sent as parameter.
| ||||||||||
abstract String |
getRootName()
Returns the name of the root component
In the case of the jsp/servlet enviroment,it will be the name of the main servlet component
This corresponds to the value of the parameter
CONFIG_SERVLET_NAME | ||||||||||
abstract SessionManager |
getSessionManager()
This method is deprecated.
Use
WebAppSessionManager instead, via the getAppSessionManager method. | ||||||||||
abstract boolean |
isDoubleByte()
Returns true if the locale is a double byte language like Chinese, Korean or Japenese.
| ||||||||||
abstract void |
putConfigParameter(String key, String value)
Appends a Configuration Parameter to the Configuration Parameters list.
| ||||||||||
abstract void |
setAppSessionManager(WebAppSessionManager sm)
This method sets the Application Session Manager associated with this application context.
| ||||||||||
abstract void |
setBrowserSettings(BrowserSettings bs)
This method sets the BrowserSettings object to be associated with this application context.
| ||||||||||
abstract void |
setConfigServletPath(String configServletPath)
Define the full application path to the Servlet as defined in the configuration file.
| ||||||||||
abstract void |
setCurrentPage(PageComponent page)
Set a page as the current page of this context.
| ||||||||||
abstract void |
setDefaultEvent(int eventID)
Sets the eventTD provided as the default event of the application
| ||||||||||
abstract void |
setExternalSecurity(ExternalSecurity es)
This method sets the External Security associated with this application context.
| ||||||||||
abstract void |
setPageManager(PageManager pageManager)
This method sets the PageManager object associated with this application context.
| ||||||||||
abstract void |
setPreferences(Preferences prefs)
This method sets a Preferences object for use with this application context.
| ||||||||||
abstract void |
setServletPath(String servletPath)
Define the full application path to the Servlet.
| ||||||||||
abstract void |
setSessionManager(SessionManager sm)
This method is deprecated.
Use
WebAppSessionManager instead, via the getAppSessionManager method. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Name of the file containing the i-servers the application is conencted to
URI of the deployed applciation for web administration servlet
Name of the application events definition file
Location of the BLOCK LIBRARY to use.
cache config file
Config files location
Location of the configuration file
Debug Mask Flag
Indicates the default object id for the blank Analysis object.
Indicates the default object id for the blank Analysis object.
Indicates the default object id for the blank report object.
Indicates the default object id for the blank report writing object.
Indicates the default object id for the blank xda report object.
Application's default event id
Application's default images folder for PDF.
Constant used for specifying whether to compress XML status for RWBean and ReportBean,of which the size of XML status tends to be big.
Indicates if the application uses the excel direct export functionality
Name of the class to be used as external security component on the application
formatter config file
file to store the mapping of formatting properties between the back end and the browser
Name of the class to be used as external security component on the application
Name of the jsp containing the iframe logic
Name of the JSP used for the IFrame
Name of the file containing the IPA configuration
Name of the file containing the IPA environments
polling frequency for asyncrhronous call to the i-server
Logger properties file location
Maximum log file size
Logger properties file
Name of the md events definition file
Name of the MessagesManager object initialization file
file that stores the folderLinks for object browsers
Location of the configuration file
Name of the configurations file's master copy
Location of the user preferences file
Name of the grouped preferences file
Mame of the preferences groups' master copy
Reload configuration file on every request
URI of the deployed applciation for intelligence server administration servlet
Name of servlet component name
Name of servlet component event handler
URI of the deployed applciation
Servlet's path
Location of the style catalog's file
Name of the style catalog's master file
Mame of the subscription api proeprties master copy
Mame of the subscription template properties master copy
Mame of the subscriptions engine properties master copy
Location of the subscription properties files
Mame of the subscription portal properties master copy
Mame of the user preferences' master copy
Location of the admin preferences file
Name of the file containing the default values for i-servers' configuaration
Mame of the admin preferences' master copy
Classpath prefix of WebAPIErrors property files.
Destination of dispensed WebAPIErrors property files.
URI of the deployed applciation for web servlet
This constant is deprecated.
Use CONFIG_BLOCK_LIBRARY instead.
Location of the BLOCK LIBRARY to use.
Name of the jsp containing the xhr partial update content
Constant used for specifying the type of resources level to return => Custom Help folder (plugins)
Constant used for specifying the type of resources level to return => CUSTOM folders
Constant used for the default events xml relative to the configuration path.
Constant used to indicate that the rendering will be done in format of html
Constant used to indicate that the rendering will be done in format of json
Constant used for specifying the type of resources level to return => Help folder
Constant used for specifying the type of resources level to return => Images folder
Constant used for specifying the type of resources level to return => Javascript folder
Constant used for specifying the type of resources level to return => JSP folder
Prefix used to know which configParameters are resourceFolders
Constant used for specifying the type of resources level to return => Styles folder for double byte
Constant used for specifying the type of resources level to return => Styles folder with fixed font for double byte
Constant used for specifying the type of resources level to return => Styles folder with fixed font
Constant used for specifying the type of resources level to return => Styles folder
Dispenses the master copy of the a resource file located in the classpath into the file indicated in the realpath
realPath | the destination of the resource file to dispense |
---|---|
resourcePath | the resource file to dispense. |
This method returns the Application Session Manager associated with this application context.
If not explicitly set through the setAppSessionManager(WebAppSessionManager)
method, a new one is automatically
created.
Note that this method fully replaces the getSessionManager method.
WebAppSessionManager
, representing the session manager associated with the AppContext object.This method will extract from request header a value corresponding to browser's locale info. This info
will be resolved in order to return current browser's LCID. This is equivalent to
findBestSupportedLocale(Locale, Locale[])
with available display locales from
getAvailableLocales(int)
for TYPE_WEB_SUPPORTED
.
Defaults to LCID of 1033.
String
with the LCIDThis method will extract from request header a value corresponding to browser's locale info. This info
will be resolved in order to return current browser's LCID. This is equivalent to
findBestSupportedLocale(Locale, Locale[])
with available display locales from
getAvailableLocales(int)
for TYPE_WEB_SUPPORTED
.
String
with the LCID
This method returns the Locale Id defined in web preferences as Language. If default, it'll return browser's locale Id instead.
String
with the Locale ID.
This method returns the Locale associated with Date and Number format locale web preference.If default, it'll return browser's locale Id instead.
String
with the Locale ID.
This method returns the BrowserSettings object associated with this application context.
Returns the value of a configuration parameter. Configuration parameters are defined in the web.xml file using the context-param and init-param tags.
param | name of the parameter to retrieve |
---|
Get the full application path to the Servlet as defined in the configuration file
String
with the servlet path
Returns an instance of a ContextMenuManager
object. Referenced ny name
contextMenuName | name of the ContextMenuManager object to retrieve |
---|
ContextMenuManager
object
Returns the name of the current page associated with the context.
It returns null
if there no current page.
PageComponent
which is set on this object.This method returns a DOM Document from a file resource. The method works by attempting the following operations, in order:
filePath | The absolute or relative path to the file resource. |
---|
Document
node that contains the file contents.
This method returns the External Security instance associated with this application context.
Returns the contents of the resource file as string from the file path provided using the named character encoding. it does not dispense the file
filePath | location of the resource file (relative path) |
---|---|
encoding | The name of a supported character encoding. |
Returns the contents of the resource file as string from the file path provided. it does not dispense the file
filePath | location of the resource file (relative path) |
---|
Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page. This is usually retrieved from user Preferences
A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
This method gets the PageManager object associated with this application context.
This method returns the Preferences object associated with this application context.
Return the absolute path of th erelative path provided
filePath | relative path to get the relative path from |
---|
Returns the contents of the resource file as string from the file path provided. If the resource cannot be found in the location, it will be dispensed
filePath | location of the resource file (relative path) |
---|---|
resourceFileName | resource file |
Return the path to the resources folder indicated on the configuration file, corresponding to the
type sent as parameter.
This is actually a convenience method for the getConfigParameter. This method returns all configuration
parameters that starts with RESOURCE_FOLDER_PREFIX
and folderType is whatever goes after that.
This method also makes sure that the name of the folder has always a backslash "/" at the end.
folderType | integer constant that specifies the type of resource folder to return |
---|
Returns the name of the root component
In the case of the jsp/servlet enviroment,it will be the name of the main servlet component
This corresponds to the value of the parameter CONFIG_SERVLET_NAME
This method is deprecated.
Use WebAppSessionManager
instead, via the getAppSessionManager method.
This method returns the Session Manager associated with this application context.
Returns true if the locale is a double byte language like Chinese, Korean or Japenese.
Appends a Configuration Parameter to the Configuration Parameters list. Configuration parameters are defined in the web.xml file using the context-param and init-param tags.
key | name of the configuration parameter |
---|---|
value | value of the configuration parameter |
This method sets the Application Session Manager associated with this application context.
This method sets the BrowserSettings object to be associated with this application context.
bs | An instance of an BrowserSettings object.
|
---|
Define the full application path to the Servlet as defined in the configuration file.
configServletPath | a String with the servlet path
|
---|
Sets the eventTD provided as the default event of the application
eventID | eventID of the application's default event |
---|
This method sets the External Security associated with this application context.
es | An ExternalSecurity instance.
|
---|
This method sets the PageManager object associated with this application context.
pageManager | A PageManager object.
|
---|
This method sets a Preferences object for use with this application context.
prefs | A Preferences object.
|
---|
Define the full application path to the Servlet. This value is read form the configuration file and if is not set it will be automatically generated from the request.
servletPath | a String with the servlet path
|
---|
This method is deprecated.
Use WebAppSessionManager
instead, via the getAppSessionManager method.
This method sets the Session Manager associated with this application context.
sm | A SessionManager instance.
|
---|