WebXMLModule

Class Overview

This module is responsible to identify changes in the web.xml and upgrading them into a microstrategy.xml file.

Running this module involves three main tasks:

1. Calculate deltas: Loads the base web.xml definition, the customized web.xml definition and calculates differences.
2. Process deltas: It removes parameters following best practices. For example, if the styleCatalog was changed in the customization, the parameter is not carried over to the plugin as best practices recommends simply creating a custom styleCatalog file that will be automatically merged.
3. Save deltas: Once deltas have been calculated and process, they will be saved as part of a plugin in a microstrategy.xml

Summary

[Expand] Inherited Methods
From class com.microstrategy.web.app.utils.upgrade.AbstractModule boolean canChangeEnabled() Default implementation, returns true. String getRelativePath(String baseDir, File file) Helper method that calculates the relative path of file, based on the given baseDir. UpgradeManager getUpgradeManager() Returns the UpgradeManager that created this AbstractModule instance. boolean isEnabled() Whether the module is enabled. abstract void run(UpgradeInfo info) Method triggered to execute the module's upgrade tasks. void setEnabled(boolean value) Method to change the enabled status of the module.
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(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.microstrategy.web.app.utils.upgrade.UpgradeModule abstract boolean canChangeEnabled() Determines whether the user can change the enabled status of this module. abstract String getDescription() A description of the task the module performs. abstract String getName() The display name of this module. abstract boolean isEnabled() Whether the module is enabled. abstract void setEnabled(boolean value) Method to change the enabled status of the module.