com.ibm.di.migam
Class MigrateAmConfig

java.lang.Object
  extended by com.ibm.di.migration.BaseMigrationUtility
      extended by com.ibm.di.migam.MigrateAmConfig

public class MigrateAmConfig
extends BaseMigrationUtility

The MigrateAmConfig class is a small program that will migrate any am.properties file from 6.0, 6.1, 6.1.1, or 7.0 to 7.1. See the main method for information of valid parameters that can be passed into the command. The program relies on the icu4j library for globalization. It relies on log4j for logging.


Field Summary
 
Fields inherited from class com.ibm.di.migration.BaseMigrationUtility
SWITCH_HELP, SWITCH_MIG_FILE, SWITCH_MIG_FILE_BAKUP, SWITCH_MIG_FILE_NEW, SWITCH_VERBOSE
 
Constructor Summary
MigrateAmConfig(String[] args, org.apache.log4j.Logger log)
           
 
Method Summary
protected  List<ChangeDescription> defineChanges(Map<String,String> props)
          Defines the changes that will be done over the properties of the source file.
protected  void interpretCommandLineOptions()
          Called to parse the passed command line arguments.
static void main(String[] args)
          The main method of the Migrate Global Properties Command.
protected  void parseArgs(String[] args)
          Parses the command line arguments by filling BaseMigrationUtility.commandLineOptions and BaseMigrationUtility.commandValuesList structures.
protected  void printHelpInformation()
          Called to print the help information to the stdOut.
 void setTdiDir(String tdiDir)
          Sets TDI installation folder.
protected  void validateCommandLineOptions()
          Called to check whether the parsed arguments are valid enough for the migration utility to continue.
 
Methods inherited from class com.ibm.di.migration.BaseMigrationUtility
applyChanges, backupFile, getCommandStandaloneValuesList, getCommandValueBySwitch, getLog, isHelpRequested, isSwitch, isVerboseMode, migrateFile, parseFile, parseFile, performPropertyAddition, performPropertyCommenting, performPropertyDeletion, performPropertyModification, performPropertyUncommenting, readFile, setLog, writeFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MigrateAmConfig

public MigrateAmConfig(String[] args,
                       org.apache.log4j.Logger log)
Parameters:
args -
log -
Method Detail

setTdiDir

public void setTdiDir(String tdiDir)
Sets TDI installation folder.

Parameters:
tdiDir -

parseArgs

protected void parseArgs(String[] args)
Description copied from class: BaseMigrationUtility
Parses the command line arguments by filling BaseMigrationUtility.commandLineOptions and BaseMigrationUtility.commandValuesList structures.

Overrides:
parseArgs in class BaseMigrationUtility
Parameters:
args - the array of all the command line arguments.

interpretCommandLineOptions

protected void interpretCommandLineOptions()
Description copied from class: BaseMigrationUtility
Called to parse the passed command line arguments.

The default implementation is to get the values of the common switches: BaseMigrationUtility.SWITCH_HELP, BaseMigrationUtility.SWITCH_MIG_FILE_BAKUP, BaseMigrationUtility.SWITCH_MIG_FILE_NEW, BaseMigrationUtility.SWITCH_MIG_FILE and BaseMigrationUtility.SWITCH_VERBOSE
The BaseMigrationUtility.SWITCH_HELP is checked first, if it is specified then the rest of the common switches will not be considered.

Overrides:
interpretCommandLineOptions in class BaseMigrationUtility

defineChanges

protected List<ChangeDescription> defineChanges(Map<String,String> props)
Description copied from class: BaseMigrationUtility
Defines the changes that will be done over the properties of the source file.

Specified by:
defineChanges in class BaseMigrationUtility
Parameters:
props - the Map of properties read from the source file. Note this is an immutable representation of the map.
Returns:
a Map defining the changes that will be done. The keys of this map represent the names of the properties. The corresponding values describe the particular changes that should be done done over the specific property. Must not be null
See Also:
ChangeDescription

printHelpInformation

protected void printHelpInformation()
Description copied from class: BaseMigrationUtility
Called to print the help information to the stdOut.

Overrides:
printHelpInformation in class BaseMigrationUtility

validateCommandLineOptions

protected void validateCommandLineOptions()
Description copied from class: BaseMigrationUtility
Called to check whether the parsed arguments are valid enough for the migration utility to continue. If an invalid argument is found an IllegalArgumentException should be thrown.

The default implementation checks the validity of the common command line parameters - file names, existence, permissions, etc.

Overrides:
validateCommandLineOptions in class BaseMigrationUtility

main

public static void main(String[] args)
The main method of the Migrate Global Properties Command. The command exits with a 0 if it completes successfully. If the command failes it exits with a -1.

Parameters:
args - The arguments passed into the command. Valid arguments are: