org.opennms.upgrade.implementations

Class DataCollectionConfigMigratorOffline

java.lang.Object

org.opennms.upgrade.api.AbstractOnmsUpgrade

org.opennms.upgrade.implementations.DataCollectionConfigMigratorOffline

All Implemented Interfaces:

OnmsUpgrade

public class DataCollectionConfigMigratorOffline
extends AbstractOnmsUpgrade

Used to modify package names within the data collection configuration files, following a refactor.

See:

• NMS-7612

Author:

Jesse White

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.upgrade.api.AbstractOnmsUpgrade

AbstractOnmsUpgrade.VersionOperator

Field Summary

Fields inherited from class org.opennms.upgrade.api.AbstractOnmsUpgrade

ZIP_EXT

Constructor Summary

Constructors

Constructor and Description
DataCollectionConfigMigratorOffline()

Method Summary

Modifier and Type	Method and Description
void	execute() Execute.
String	getDescription() Gets the description.
int	getOrder() Gets the order.
void	postExecute() Post execute.
void	preExecute() Pre-execute
boolean	requiresOnmsRunning() Requires OpenNMS running.
void	rollback() Rollback.

Methods inherited from class org.opennms.upgrade.api.AbstractOnmsUpgrade

getDbConnection, getFiles, getHomeDirectory, getId, getInstalledVersion, getMainProperties, getOpennmsProductDescription, getOpennmsProductName, getOpennmsVersion, getRrdExtension, getRrdProperties, getRrdStrategy, initializeDatasource, isInstalledVersion, isInstalledVersionGreaterOrEqual, isMeridian, isRrdToolEnabled, isStoreByForeignSourceEnabled, isStoreByGroupEnabled, loadProperties, log, printFullSettings, printMainSettings, registerProperties, setProductDescription, setProductName, setVersion, unzipFile, versionToInteger, zipDir, zipFile

Methods inherited from class java.lang.Object

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

Constructor Detail

DataCollectionConfigMigratorOffline

public DataCollectionConfigMigratorOffline()
                                    throws OnmsUpgradeException

Throws:

OnmsUpgradeException

Method Detail

getDescription

public String getDescription()

Description copied from interface: OnmsUpgrade

Gets the description.

This is for informational purposes, and should contain a brief description about what is the purpose of this upgrade class.

Returns:

the description

requiresOnmsRunning

public boolean requiresOnmsRunning()

Description copied from interface: OnmsUpgrade

Requires OpenNMS running.

Returns:

true, if OpenNMS must be running to execute this upgrade or false if OpenNMS must be stopped.

getOrder

public int getOrder()

Description copied from interface: OnmsUpgrade

Gets the order.

In order to execute all the implementations of this interface on a specify order, each implementation must return an integer for this purpose.

Returns:

the order

preExecute

public void preExecute()
                throws OnmsUpgradeException

Description copied from interface: OnmsUpgrade

Pre-execute

Runs some checks to ensure that what it would execute() would work. If something is missing, an exception will be thrown

Execute backups of the JRBs/RRDs if they are going to be modified.

Throws:

OnmsUpgradeException - the OpenNMS upgrade exception

execute

public void execute()
             throws OnmsUpgradeException

Description copied from interface: OnmsUpgrade

Execute.

This is the main method, and this is the one where all the upgrade code must be placed.

Throws:

OnmsUpgradeException - the OpenNMS upgrade exception

postExecute

public void postExecute()

Description copied from interface: OnmsUpgrade

Post execute.

Runs some clean up tasks after executing the execute() method. If something is wrong, an exception will be thrown

rollback

public void rollback()
              throws OnmsUpgradeException

Description copied from interface: OnmsUpgrade

Rollback.

Restore the initial state of the OpenNMS files if something went wrong while running the execute() method.

Must restore the backups of the files if necessary.

Throws:

OnmsUpgradeException - the onms upgrade exception