WebXMLModule (Web API 2021)

java.lang.Object
- com.microstrategy.web.app.utils.upgrade.AbstractModule
- - com.microstrategy.web.app.utils.upgrade.WebXMLModule

All Implemented Interfaces:

UpgradeModule
```
public class WebXMLModule
extends AbstractModule
```
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
Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors
Constructor Description

WebXMLModule(UpgradeManager manager)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDescription()`	A description of the task the module performs.
`java.lang.String`	`getName()`	The display name of this module.
`void`	`run(UpgradeInfo info)`	Method triggered to execute the module's upgrade tasks.

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
  - WebXMLModule
```
public WebXMLModule(UpgradeManager manager)
```
    Default constructor. Receives the UpgradeManager instantiating this WebXMLModule.
- Method Detail
  - 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.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: UpgradeModule
    
    A description of the task the module performs.
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: UpgradeModule
    
    The display name of this module.