| java.lang.Object | |||
| ↳ | com.microstrategy.web.app.utils.upgrade.AbstractModule | ||
| ↳ | com.microstrategy.web.app.utils.upgrade.AbstractXMLConfigModule | ||
| ↳ | com.microstrategy.web.app.utils.upgrade.PageConfigsModule | ||
Class Overview
This module is responsible for upgrading all page configFiles , include pageConfig.xml and Admin_pageConfig.xml. Besides calculating deltas, it will adapt file paths to follow new best practices, for example, it will move sections and templates to the jsp folder and config-src to the WEB-INF/xml/plugin.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PageConfigsModule(UpgradeManager manager) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | getDescription() | ||||||||||
| String | getName() | ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | calculateJSPPath(String sPath) | ||||||||||
| Class |
elementClass()
Subclasses must implement this method to identify the AbstractConfigurationElement class that
represents the root node of the xml.
| ||||||||||
| AbstractConfigurationElement |
getCustomElement(String controllerName)
Keeps a reference to the custom page-config so it can be further processed.
| ||||||||||
| String |
initParameterName()
Subclasses must implement this method to identify the name of the init-parameter that
defines the location of the xml configuration file.
| ||||||||||
| AbstractConfigurationElement |
processDeltas(AbstractConfigurationElement deltas)
Processes deltas by changing the jsp paths for templates and sections, by changing config-src
when necessary.
| ||||||||||
| String | processXMLPath(String sPath) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.microstrategy.web.app.utils.upgrade.AbstractXMLConfigModule
| |||||||||||
|
From class
com.microstrategy.web.app.utils.upgrade.AbstractModule
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.microstrategy.web.app.utils.upgrade.UpgradeModule
| |||||||||||
Public Constructors
Public Methods
public String getDescription ()
public String getName ()
Protected Methods
protected String calculateJSPPath (String sPath)
protected Class elementClass ()
Subclasses must implement this method to identify the AbstractConfigurationElement class that represents the root node of the xml.
protected AbstractConfigurationElement getCustomElement (String controllerName)
Keeps a reference to the custom page-config so it can be further processed.
Throws
| ConfigException |
|---|
protected String initParameterName ()
Subclasses must implement this method to identify the name of the init-parameter that defines the location of the xml configuration file.
protected AbstractConfigurationElement processDeltas (AbstractConfigurationElement deltas)
Processes deltas by changing the jsp paths for templates and sections, by changing config-src when necessary. It also identifies old config-src paths that are not necessary and moves them to the ~upgraded folder.