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

Class XMLFileModule

java.lang.Object

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

com.microstrategy.web.app.utils.upgrade.GenericFileModule

com.microstrategy.web.app.utils.upgrade.XMLFileModule

All Implemented Interfaces:

UpgradeModule

public class XMLFileModule
extends GenericFileModule

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.utils.upgrade.GenericFileModule

GenericFileModule.PatternInfo

Field Summary

Fields inherited from class com.microstrategy.web.app.utils.upgrade.GenericFileModule

_patterns

Constructor Summary

Constructors

Constructor	Description
XMLFileModule(UpgradeManager manager)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getClassName()
protected java.lang.String	getContentType()
java.lang.String	getName()	The display name of this module.
void	run(UpgradeInfo info)	Method triggered to execute the module's upgrade tasks.
protected java.lang.String	upgradeContents(UpgradeInfo info, java.lang.String contents, java.io.File f)

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

getDescription, getNewCustomPath, processDir, setPatterns

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

XMLFileModule

public XMLFileModule(UpgradeManager manager)

Method Detail

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in class GenericFileModule

getContentType

protected java.lang.String getContentType()

Specified by:

getContentType in class GenericFileModule

upgradeContents

protected java.lang.String upgradeContents(UpgradeInfo info,
                                           java.lang.String contents,
                                           java.io.File f)

Specified by:

upgradeContents in class GenericFileModule

run

public void run(UpgradeInfo info)
         throws UpgradeException

Description copied from class: AbstractModule

Method triggered to execute the module's upgrade tasks.

Specified by:

run in class AbstractModule

Parameters:

info - upgrade information.

Throws:

UpgradeException - when an unexpected error that prevents the module to cotinue occurs. Other errors should simply be logged.

getName

public java.lang.String getName()

Description copied from interface: UpgradeModule

The display name of this module.