Package com.microstrategy.web.app.utils.upgrade

Class PageConfigsModule

java.lang.Object

com.microstrategy.web.app.utils.upgrade.AbstractModule

com.microstrategy.web.app.utils.upgrade.AbstractXMLConfigModule

com.microstrategy.web.app.utils.upgrade.PageConfigsModule

All Implemented Interfaces:

UpgradeModule

public class PageConfigsModule
extends AbstractXMLConfigModule

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.

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
PageConfigsModule(UpgradeManager manager)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	calculateJSPPath(java.lang.String sPath)
protected java.lang.Class	elementClass()	Subclasses must implement this method to identify the AbstractConfigurationElement class that represents the root node of the xml.
protected AbstractConfigurationElement	getCustomElement(java.lang.String controllerName)	Keeps a reference to the custom page-config so it can be further processed.
java.lang.String	getDescription()	A description of the task the module performs.
java.lang.String	getName()	The display name of this module.
protected java.lang.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.
protected java.lang.String	processXMLPath(java.lang.String sPath)

Methods inherited from class com.microstrategy.web.app.utils.upgrade.AbstractXMLConfigModule

calculateDeltas, calculateNewPath, getBaseElement, getUpgradeInfo, processConfigFile, run, saveDeltas

Methods inherited from class com.microstrategy.web.app.utils.upgrade.AbstractModule

canChangeEnabled, getRelativePath, getUpgradeManager, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

PageConfigsModule

public PageConfigsModule(UpgradeManager manager)

Method Detail

elementClass

protected java.lang.Class elementClass()

Description copied from class: AbstractXMLConfigModule

Subclasses must implement this method to identify the AbstractConfigurationElement class that represents the root node of the xml.

Specified by:

elementClass in class AbstractXMLConfigModule

initParameterName

protected java.lang.String initParameterName()

Description copied from class: AbstractXMLConfigModule

Subclasses must implement this method to identify the name of the init-parameter that defines the location of the xml configuration file.

Specified by:

initParameterName in class AbstractXMLConfigModule

getCustomElement

protected AbstractConfigurationElement getCustomElement(java.lang.String controllerName)
                                                 throws ConfigException

Keeps a reference to the custom page-config so it can be further processed.

Overrides:

getCustomElement in class AbstractXMLConfigModule

Throws:

ConfigException

processDeltas

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.

Overrides:

processDeltas in class AbstractXMLConfigModule

calculateJSPPath

protected java.lang.String calculateJSPPath(java.lang.String sPath)

processXMLPath

protected java.lang.String processXMLPath(java.lang.String sPath)

getName

public java.lang.String getName()

Description copied from interface: UpgradeModule

The display name of this module.

getDescription

public java.lang.String getDescription()

Description copied from interface: UpgradeModule

A description of the task the module performs.