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

Class UpgradeInfo

java.lang.Object

com.microstrategy.web.app.utils.upgrade.UpgradeInfo

public class UpgradeInfo
extends java.lang.Object

This class provides the upgrade process the necessary information to conduct the upgrade.

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
UpgradeInfo(java.lang.String baseFolder, java.lang.String customFolder, java.lang.String targetFolder, java.lang.String plugInName)	Default constructor.

Method Summary

Modifier and Type	Method	Description
FileLoader	getBaseFileLoader()	Returns a FileLoader whose basePath is the base folder.
java.lang.String	getBaseFolder()	Returns the location (absolute path) of the Microstrategy Web version with no customizations being upgraded
ApplicationParameters	getBaseParameters()	Returns the ApplicationParameters (e.g.
FileLoader	getCustomizationFileLoader()	Returns a FileLoader whose basePath is the customized Microstrategy Web version folder.
java.lang.String	getCustomizationFolder()	Returns the location (absolute path) of the customized Microstrategy Web version being upgraded.
ApplicationParameters	getCustomizationParameters()	Returns the ApplicationParameters (e.g.
java.lang.String	getPlugInName()
FileLoader	getTargetFileLoader()	Returns a FileLoader whose basePath is the new Microstrategy Web version folder.
ApplicationParameters	getTargetParameters()	Returns the ApplicationParameters (e.g.
CustomizationInfo	getTargetPlugIn()	Returns the CustomizationInfo where the upgrade will be saved into.
java.lang.String	getTargtFolder()	Returns the location (absolute path) of the new Microstrategy Web version.
static AbstractConfigurationElement	loadConfig(java.lang.String relativePath, java.lang.String basePath, java.lang.Class c)	Loads an xml configuration file from the given parameters.
java.lang.String	toString()	Overrides toSTring to provide meaningful debugging information.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeInfo

public UpgradeInfo(java.lang.String baseFolder,
                   java.lang.String customFolder,
                   java.lang.String targetFolder,
                   java.lang.String plugInName)

Default constructor. Defines all parameter required for an upgrade.

Parameters:

baseFolder - The location (absolute path) of the Microstrategy Web version with no customizations being upgraded.

customFolder - The location (absolute path) of the customized Microstrategy Web version being upgraded.

targetFolder - The location (absolute path) of the new Microstrategy Web version.

plugInName - String

Method Detail

getBaseFolder

public java.lang.String getBaseFolder()

Returns the location (absolute path) of the Microstrategy Web version with no customizations being upgraded

getBaseFileLoader

public FileLoader getBaseFileLoader()

Returns a FileLoader whose basePath is the base folder.

getCustomizationFolder

public java.lang.String getCustomizationFolder()

Returns the location (absolute path) of the customized Microstrategy Web version being upgraded.

getCustomizationFileLoader

public FileLoader getCustomizationFileLoader()

Returns a FileLoader whose basePath is the customized Microstrategy Web version folder.

getTargtFolder

public java.lang.String getTargtFolder()

Returns the location (absolute path) of the new Microstrategy Web version.

Returns:

String

getTargetFileLoader

public FileLoader getTargetFileLoader()

Returns a FileLoader whose basePath is the new Microstrategy Web version folder.

getPlugInName

public java.lang.String getPlugInName()

getBaseParameters

public ApplicationParameters getBaseParameters()

Returns the ApplicationParameters (e.g. web.xml) as defined in the base Microstrategy Web version.

getCustomizationParameters

public ApplicationParameters getCustomizationParameters()

Returns the ApplicationParameters (e.g. web.xml) as defined in the customized Microstrategy Web version being upgraded.

getTargetParameters

public ApplicationParameters getTargetParameters()

Returns the ApplicationParameters (e.g. web.xml) as defined in the new Microstrategy Web version.

getTargetPlugIn

public CustomizationInfo getTargetPlugIn()

Returns the CustomizationInfo where the upgrade will be saved into.

loadConfig

public static AbstractConfigurationElement loadConfig(java.lang.String relativePath,
                                                      java.lang.String basePath,
                                                      java.lang.Class c)
                                               throws ConfigException

Loads an xml configuration file from the given parameters.

Parameters:

relativePath - The relative path of the xml file (e.g.: /WEB-INF/web.xml)

basePath - The absolute path used as the root to resolve the relative path location (e.g.: C:\Program Files\Microstrategy\Web)

c - The AbstractConfigurationElement class that represents the root node of the xml.

Throws:

ConfigException

toString

public java.lang.String toString()

Overrides toSTring to provide meaningful debugging information.

Overrides:

toString in class java.lang.Object