com.ibm.jsdt.support
Class SupportHelper

java.lang.Object
  extended by com.ibm.jsdt.support.SupportHelper
Direct Known Subclasses:
SupportAixHelper, SupportHPUXHelper, SupportLinuxHelper, SupportOS400Helper, SupportSolarisHelper, SupportWindowsHelper

Deprecated. Due to new package com.ibm.jsdt.support.deploymenthelper

public class SupportHelper
extends java.lang.Object

Helper for pre-deployment checker, entry, exit, and main programs. The SupportHeler provides operating system independent utilities commonly used in user programs developed for an application wrapper. Many helper functions require the same parameters so the data is housed in a SupportBase. Values must be set in the base class before calling their corresponding SupportHelper function.


Field Summary
static java.lang.String copyright
          Deprecated.  
static java.lang.String sNEWLN
          Deprecated. System independent line separator.
protected  SupportBase theSupportBase
          Deprecated.  
 
Constructor Summary
SupportHelper()
          Deprecated. Sole constructor.
 
Method Summary
 boolean arraySearch(java.lang.String[] messageArray, java.lang.String searchString)
          Deprecated. Search for a string in the array.
 java.lang.String buildCommand(java.lang.String propFileName, java.lang.String command, java.lang.String newFileName)
          Deprecated. Build a command that first configures the variables defined in the properties file, then calls a command to run The following variables are always set in the command: - IRU_userProgamsDir - the fully qualified directory where user programs are unpacked - IRU_responseFile - the fully qualified name of the response file
protected  boolean checkDeployerVersion(SupportBase s, java.lang.String minVersion, java.lang.String methodName)
          Deprecated. Verifies that the deployer version is compatible with the specified method and minimum version.
 int checkFreeSpace(SupportBase s)
          Deprecated. use instead method checkFreeSpaceAvailable(SupportBase)
 long checkFreeSpaceAvailable(SupportBase s)
          Deprecated. Gets the amount of free disk space in a path.
 int checkTargetDir(SupportBase s)
          Deprecated. use intead method checkTargetDirectory(SupportBase)
 long checkTargetDirectory(SupportBase s)
          Deprecated. Determines the validity of a destination directory stored in the ibmnsi.properties file.
 int compareVersions(SupportBase s)
          Deprecated. Compares two dotted version strings.
 void copyDirectory(SupportBase s)
          Deprecated. Copies a directory to another location.
 java.lang.String determineLogFileName(SupportBase s)
          Deprecated. Determines the name of the log file to use.
 java.lang.String[] directoryGrep(java.lang.String directoryName, java.lang.String regularExpression)
          Deprecated. Reads the file and directory names and returns a list of names that matches the regular expresion.
 boolean endOfFileGrep(SupportBase s)
          Deprecated. Scans the end of a file for a string.
 void executeCommand(SupportBase s)
          Deprecated. Executes the specified command in a separate process via Runtime.exec() with the specified environment and working directory and waits for it to finish.
 boolean fileCopy(SupportBase s)
          Deprecated. Copies a file to another location.
 boolean fileCopyAndRename(SupportBase s)
          Deprecated. Copies a file to another location and renames the file in the new target location.
 boolean fileDelete(SupportBase s)
          Deprecated. Deletes a file.
 boolean fileExists(SupportBase s)
          Deprecated. Checks for the existence of a file.
 boolean fileGrep(java.lang.String fileName, long startIndex, java.lang.String searchString)
          Deprecated. Searches the contents of the file for a search string.
 boolean fileGrep(SupportBase s)
          Deprecated. Scans a file for a string.
 long fileLength(java.lang.String fileName)
          Deprecated. Returns the length of the file in bytes
 int fileSearchAndReplace(SupportBase s)
          Deprecated. Performs a find and replace in a given file.
 int fileSearchAndReplaceLine(SupportBase s)
          Deprecated. Performs a find and replace of a line in the specified file.
 java.lang.String[] fileSearchAndReturnLinesWithSearch(java.lang.String filename, java.lang.String find, int startSearchPosition)
          Deprecated. Searches each line of a file to find a particular string.
 int findAndReplace(SupportBase s)
          Deprecated.  
protected  java.lang.String getBackLevelLogFileName(SupportBase s, java.lang.String dottedClassName)
          Deprecated. Retrieves the log file name for a user program on a back level (1.1) agent.
 java.lang.String getCommandStdError(SupportBase s)
          Deprecated. Retrieves the output of the most recently launched command process captured from stderr stream.
 java.lang.String getCommandStdOut(SupportBase s)
          Deprecated. Retrieves the standard output of the most recently launched command process captured from stdout stream.
 java.util.Locale getDeployerLocale(SupportBase s)
          Deprecated. Retrieves the Locale of the deployment wizard so that a translatable message can be created for display.
 java.lang.String getDomain(SupportBase s)
          Deprecated. Retreives the domain suffix for the local host.
 java.lang.String getEntryResponseFilePath(SupportBase s)
          Deprecated. Retrieves the name of the response file specified for the Entry program prepended with the logs directory path.
 java.lang.String getExitResponseFilePath(SupportBase s)
          Deprecated. Retrieves the name of the response file specified for the Exit program prepended with the logs directory.
 java.lang.String getFileValue(SupportBase s)
          Deprecated. Scans a file for a key and returns the string value found.
 java.util.Locale getGroupLocale(SupportBase s)
          Deprecated. Gets the locale of the install group from the server.
 java.lang.String getHostName(SupportBase s)
          Deprecated. Retrieves the unqualified local host name.
 java.lang.String getIbmNsiISMPPropValue(SupportBase s)
          Deprecated. Gets a value from the ibmnsi.properties file.
 java.util.Properties getIbmNsiProperties(SupportBase s)
          Deprecated. Lazy initializes and retrieves the Properties object associated with the ibmnsi.properties file.
 java.lang.String getIbmNsiPropValue(java.lang.String variableName)
          Deprecated. Determines the value of a passed variable name from ibmnsi.properties file.
 java.lang.String getIbmNsiPropValue(SupportBase s)
          Deprecated. Gets a value from the ibmnsi.properties file.
 java.lang.String getIbmNsiPropValueByKey(SupportBase s)
          Deprecated. Gets a value from the ibmnsi.properties file.
 java.lang.String getLastCommandOutput(SupportBase s)
          Deprecated. Retrieves the output of the most recently launched command process.
 int getLastCommandReturnCode(SupportBase s)
          Deprecated. Retrieves the return code from the most recently launched command process.
 java.lang.String getLogsDir(SupportBase s)
          Deprecated. Gets the logs directory.
 java.lang.String getMainResponseFilePath(SupportBase s)
          Deprecated. Retrieves the name of the response file specified for the Main program prepended with the logs directory.
 java.lang.String getOSType(java.lang.String os)
          Deprecated. Determine the operating system type for a operating system
 long getPartitionCapacity(SupportBase s)
          Deprecated. Gets the capacity of a given drive on Windows or partition on linux.
 java.lang.String getPartitionFileSystemType(SupportBase s)
          Deprecated. Gets the file system type of a given drive on Windows or mount point on linux.
 java.lang.String getPartitionVolumeLabel(SupportBase s)
          Deprecated. Gets the volume label of a given drive on Windows or mount point on linux.
 java.lang.String getPasswordValue(java.lang.String passwordVariableName)
          Deprecated. Retreives a passowrd value for the currently installing application from the ibmnsi.properties file.
 java.lang.String getPasswordValueByKey(java.lang.String key)
          Deprecated. Retreives a passowrd value from the ibmnsi.properties file.
 java.lang.String getPreDeploymentCheckerResponseFilePath(SupportBase s)
          Deprecated. Retrieves the name of the response file specified for the PreDeploymentChecker program prepended with the logs directory path.
 java.util.Properties getProductInstallingBundleProperties(SupportBase s)
          Deprecated. Retrieves the Properties object loaded from the default properties bundle for the currently installing product.
 java.lang.String getProductInstallingId(SupportBase s)
          Deprecated. Gets the application ID of the product currently installing on the target.
 java.lang.String getProductInstallingVersion(SupportBase s)
          Deprecated. Retrieves the version of the currently installing application.
 java.lang.String getQualifiedHostName()
          Deprecated. Retrieves the qualified local host name.
 java.lang.String getQualifiedHostName(SupportBase s)
          Deprecated. Retrieves the fully qualified local host name.
 java.util.List getQualifiedTiedPasswordValue(java.lang.String task, java.lang.String applicationId, java.lang.String variableKeyword)
          Deprecated. Returns a List of tied, password attribute values that correspond to the specified task, application Id and variable keyword.
 java.util.List getQualifiedTiedVariableValue(java.lang.String task, java.lang.String applicationId, java.lang.String variableKeyword)
          Deprecated. Returns a List of tied, host attribute values that correspond to the specified task, application Id and variable keyword.
protected  java.lang.String getResponseFilePath(SupportBase s, int stage)
          Deprecated. Retrieves the name of the response file specified for the program prepended with the logs directory.
protected  java.lang.String getResponseFilePath(SupportBase s, int stage, java.lang.String srcName)
          Deprecated. Gets the qualifed, updated response file path for the specified original response file source name.
protected  java.util.List<java.lang.String> getResponseFilePaths(SupportBase s, int stage)
          Deprecated. Retrieves the name of the response file specified for the program prepended with the logs directory.
 java.util.Properties getResponseFileProperties(java.lang.String propertiesFilePath)
          Deprecated. Gets a Properties object populated by a Java Properties formatted response file.
 java.lang.String getResponseFileProperty(java.lang.String propertiesFilePath, java.lang.String key)
          Deprecated. Gets a property value from a Java Properties formatted response file.
 java.lang.String getResponseFileValue(SupportBase s)
          Deprecated. Scans a response file for a key and returns the string value found.
 java.util.List getSelectedTaskList(SupportBase s)
          Deprecated. Retrieves a List of the task ids that have been selected for deployment in the Deployment Wizard.
 boolean getSetupFileRemovalSetting()
          Deprecated. Gets the setup file removal setting indicating whether or not the setup files will removed a the completion of the install.
 java.lang.String getStringFromCommandArray(SupportBase s)
          Deprecated. Convienence method to assemble a command String from a String[] for logging purposes.
 java.lang.String getSystemCommandOutput(java.lang.String command, java.lang.String commandToLog)
          Deprecated.  
 java.lang.String getSystemCommandOutput(SupportBase s)
          Deprecated. Invokes a system command and captures the output in a String.
 java.lang.String getSystemEnvVar(SupportBase s)
          Deprecated. Retrieves the value of a System environment variable.
 java.util.List getTaskApplicationList(SupportBase s)
          Deprecated. Retrieves a List of the application ids that were specified for deployment in the Deployment Wizard for the given task.
 java.util.List getTaskHostnameList(SupportBase s)
          Deprecated. Retrieves a List of the hostnames that were specified for deployment in the Deployment Wizard for the given task.
 java.lang.String getTempDir()
          Deprecated. Determines and returns the temporary directory from the operating system environment.
 SupportBase getTheSupportBase()
          Deprecated. Get the SupportBase instance of the class
 java.util.List getTiedPasswordValue(java.lang.String variableKeyword)
          Deprecated. Returns a List of tied, host password values that correspond to the variable keyword for the currently installing application.
 java.util.List getTiedPasswordValueForKey(java.lang.String key)
          Deprecated. Returns a List of tied, host password values that correspond to the specified key.
 java.util.List getTiedVariableValue(java.lang.String variableKeyword)
          Deprecated. Returns a List of tied, host attribute values that correspond to the variable keyword for the currently installing application.
 java.util.List getTiedVariableValueForKey(java.lang.String key)
          Deprecated. Returns a List of tied, host attribute values that correspond to the specified key.
 java.lang.String getTranslatedMessage(SupportBase s)
          Deprecated. Retrieves a translatable message from a Locale specific ResourceBundle .
 java.lang.String getUnpackedDir(SupportBase s)
          Deprecated. Gets the directory where images are unpacked.
 java.lang.String getVariableValueForTaskApplication(SupportBase s)
          Deprecated. Retrieves the value of a variable.
 java.lang.String[] getVpdInstallLocationArray(SupportBase s)
          Deprecated. Retrieves String array of install locations of an installed product with a given UID from the ISMP vpd.properties file.
 java.util.ArrayList getVpdPropertyList(SupportBase s)
          Deprecated. Retrieves a property from the ISMP vpd.properties file.
 java.lang.String[] getVpdVersionArray(SupportBase s)
          Deprecated. Retrieves a String array of versions of an installed product with a given UID from the ISMP vpd.properties file.
 int invokeCommand(java.lang.String command)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommand(java.lang.String command, java.lang.String commandToLog)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommand(java.lang.String command, java.lang.String commandToLog, java.lang.String launchDir)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommandLogOutput(java.lang.String command)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommandLogOutput(java.lang.String command, java.lang.String commandToLog)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommandLogOutput(java.lang.String command, java.lang.String commandToLog, java.lang.String launchDir)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommandLogOutputToFileName(java.lang.String command, java.lang.String logFileName)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommandLogOutputToFileName(java.lang.String command, java.lang.String commandToLog, java.lang.String logFileName)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 int invokeCommandLogOutputToFileName(java.lang.String command, java.lang.String commandToLog, java.lang.String logFileName, java.lang.String launchDir)
          Deprecated. Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish.
 boolean isAix()
          Deprecated. Determine if the computer is running on AIX operating system.
 boolean isAixOSType(java.lang.String os)
          Deprecated. Determine if the operating system is a type of AIX operating system.
 boolean isApplicationVersionEqual(SupportBase s)
          Deprecated. Verifies that the specified version is equal to the version of the product currently installing.
 boolean isEnoughTargetDirSpace(SupportBase s)
          Deprecated. use instead method isEnoughTargetDirSpaceAvailable(SupportBase)
 boolean isEnoughTargetDirSpaceAvailable(SupportBase s)
          Deprecated. Determines the validity and free space of a destination directory stored in the ibmnsi.properties file.
 boolean isHPUX()
          Deprecated. Determine if the computer is running on HPUX operating system.
 boolean isHPUXOSType(java.lang.String os)
          Deprecated. Determine if the operating system is a type of HPUX operating system.
 boolean isIpv6Address(java.lang.String computerName)
          Deprecated. Indicates whether or not the specified computer name is an IPv6 address.
 boolean isLinux()
          Deprecated. Determine if the computer is running a Linux operating system.
 boolean isLinuxOSType(java.lang.String os)
          Deprecated. Determine if the operating system is a type of Linux operating system.
 boolean isLinuxX86_32()
          Deprecated. Determine if the machine is running 32 bit linux on x86
 boolean isLinuxX86_64()
          Deprecated. Determine if the machine is running 64 bit linux on x86
 boolean isOS400()
          Deprecated. Deterine if the computer is running on OS/400 or iSeries operating system.
 boolean isOS400OSType(java.lang.String os)
          Deprecated. Determine if the operating system is a type of OS/400 or iSeries operating system.
 boolean isPortOpen(SupportBase s)
          Deprecated. Verifies that a TCP/IP port is not in use.
 boolean isPortRegistered(int port)
          Deprecated. Checks the operating system services file to see if the port is already registered.
 boolean isPowerLinuxOSType(java.lang.String os)
          Deprecated. Determine if the operating system is a type of power linux operating system
 boolean isSameDirectoryName(java.lang.String location1, java.lang.String location2)
          Deprecated. Compares two directories to see if they are the same.
 boolean isSunOS()
          Deprecated. Determine if the computer is running on Solaris operating system.
 boolean isSunOSType(java.lang.String os)
          Deprecated. Determine if the operating system is a type of Solaris operating system.
 boolean isVersionSupported(java.lang.String version, java.lang.String lowestSupportedVersion, java.lang.String highestSupportedVersion)
          Deprecated. Determine if the version specified falls within the boundary of the lowest supported version and highest supported version.
 boolean isWindows()
          Deprecated. Determine if the computer is running on Window operating system.
 boolean isWindowsOSType(java.lang.String os)
          Deprecated. Determine if the operating system is a type of Window operating system.
 int launchAndWait(SupportBase s)
          Deprecated. Launches a program and waits for the process to finish.
 void launchLocalInteractiveProgram(SupportBase s)
          Deprecated. Executes the specified local interative program command in a separate process via Runtime.exec() with the specified environment and working directory and returns immediately.
 void log(java.lang.String message)
          Deprecated. Writes the message to a default log file.
 void log(java.lang.String message, java.lang.String logFileName)
          Deprecated. Writes the message, the timestamp and separator string to the log file specified in the logFileName
 void log(SupportBase s)
          Deprecated. Writes a message to a log file.
 int logAppendFile(java.lang.String fileName)
          Deprecated. Appends the content of the file to the deployment wizard log file.
 int logAppendFile(java.lang.String[] fileNames)
          Deprecated. Appends the content of each file listed in the array to the deployment wizard log file.
 int logAppendFile(java.lang.String[] fileNames, java.lang.String logFileName)
          Deprecated. Appends the contents of the files in the array to the specified log file.
 int logAppendFile(java.lang.String fileName, java.lang.String logFileName)
          Deprecated. Appends the contents of the file to the specified log file if a log file is not specified in the application, then it is appended to the SupportBase.log in the deployment/logs directory.
 boolean logAppendFile(SupportBase s)
          Deprecated. This method provides a supported mechanism for adding the contents of a file to the log.
 void logNewLine(SupportBase s)
          Deprecated. Writes a blank line to a log file.
 void logStatus(SupportBase s)
          Deprecated. Writes a success or failure message to a log file prepended with a timestamp and "****INSTALLATION STATUS = ".
 void modifyResponseFile(SupportBase s)
          Deprecated. Changes a value in a response file.
 void postCompletionMessageToDeployerUI(SupportBase s)
          Deprecated. Overrides the default completion message to the deployment wizard on the "Detailed Messages" panel.
 void postErrorMessageToDeployerMainUI(SupportBase s)
          Deprecated. Posts a message with an error icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.
 void postErrorMessageToDeployerUI(SupportBase s)
          Deprecated. Posts a message with an error icon to the deployment wizard on the "Detailed Messages" panel.
 void postInformationMessageToDeployerMainUI(SupportBase s)
          Deprecated. Posts a message with an information icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.
 void postInformationMessageToDeployerUI(SupportBase s)
          Deprecated. Posts a message with an information icon to the deployment wizard on the "Detailed Messages" panel.
 void postSuccessMessageToDeployerMainUI(SupportBase s)
          Deprecated. Posts a message with a success icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.
 void postSuccessMessageToDeployerUI(SupportBase s)
          Deprecated. Posts a message with a success icon to the deployment wizard on the "Detailed Messages" panel.
 void postWarningMessageToDeployerMainUI(SupportBase s)
          Deprecated. Posts a message with a warning icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.
 void postWarningMessageToDeployerUI(SupportBase s)
          Deprecated. Posts a message with a warning icon to the deployment wizard on the "Detailed Messages" panel.
 java.lang.String readFile(SupportBase s)
          Deprecated. Reads in a file.
 java.lang.String removeAlphaCharsFromString(java.lang.String inputString)
          Deprecated. Removes all characters that are non 0 -9 or '.' from the input string and returns the resulting value.
 java.lang.String replaceSubstring(SupportBase s)
          Deprecated. Modifies a String by replacing a substring with a new substring.
 boolean setFileValue(SupportBase s)
          Deprecated. Scans a file for a key and replaces the key value.
 void setIbmNsiProperty(SupportBase s)
          Deprecated. Set a property into the currently cached ibmnsi Properties object and saves the updated properties to disk.
 void setResponseFileProperty(java.lang.String propertiesFilePath, java.lang.String key, java.lang.String value)
          Deprecated. Sets a property value into a Java Properties formatted response file.
 boolean setResponseFileValue(SupportBase s)
          Deprecated. Scans a response file for a key and sets the corresponding value.
 boolean setResponseFileValue(SupportBase s, boolean createKeyIfDoesNotExist)
          Deprecated. Scans a response file for a key and sets the corresponding value.
 void setTheSupportBase(SupportBase theSupportBase)
          Deprecated. Set the SupportBase instance of the class
 java.lang.String trimDoubleQuotes(java.lang.String inputString)
          Deprecated. Helper method that removes quotes from values retrieved from the response file
 boolean unPackJar(java.lang.String absolutePathName, java.lang.String destinationDirPath)
          Deprecated. Unpacks a jar file.
 boolean valueExists(java.lang.String stringToSearch, java.lang.String[] values)
          Deprecated. Determine if any of the given values exist in a given string
 boolean waitForFile(SupportBase s)
          Deprecated. Polls the system for the existence of a file and, optionally, strings within the file.
 void writeFile(SupportBase s)
          Deprecated. Writes a String to a file, appends it to the file or overwrites the file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final java.lang.String copyright
Deprecated. 
See Also:
Constant Field Values

theSupportBase

protected SupportBase theSupportBase
Deprecated. 

sNEWLN

public static final java.lang.String sNEWLN
Deprecated. 
System independent line separator.

Constructor Detail

SupportHelper

public SupportHelper()
Deprecated. 
Sole constructor.

Method Detail

copyDirectory

public void copyDirectory(SupportBase s)
Deprecated. 
Copies a directory to another location. Recursively copies a directory (and underlying tree) to a designated location on the file system. If the target directory does not exist, an attempt will be made to create it.

The SupportBase to be queried must invoke SupportBase.setSource and SupportBase.setTarget before calling this method.

Parameters:
s - the SupportBase to be queried:
  • a String directory to be copied SupportBase.getSource()
  • a String target directory SupportBase.getTarget()

fileCopy

public boolean fileCopy(SupportBase s)
Deprecated. 
Copies a file to another location. The copy is performed via Java (Buffered) streams and therefore can be of any type (text,binary etc.).

NOTE: If a file of the same name already exists in the target directory, it will be overwritten. If the target directory does not exist it will be created. The source file, and target directory should not be encapsulated in quotes

The SupportBase to be queried must invoke SupportBase.setSource and SupportBase.setTarget before calling this method.

Parameters:
s - the SupportBase to be queried:
  • a String file to be copied SupportBase.getSource()
  • a String target directory SupportBase.getTarget()
Returns:
a boolean
  • true if operation was successful
  • false if operation failed

fileCopyAndRename

public boolean fileCopyAndRename(SupportBase s)
Deprecated. 
Copies a file to another location and renames the file in the new target location. The copy is performed via Java (Buffered) streams and therefore can be of any type (text,binary etc.).

NOTE: If a file of the same name already exists in the target directory, it will be overwritten. If the target directory does not exist it will be created. The source file, target directory and target file name should not be encapsulated in quotes

The SupportBase to be queried must invoke SupportBase.setSource and SupportBase.setTarget and SupportBase.setTargetFileName before calling this method.

Parameters:
s - the SupportBase to be queried:
  • a String file to be copied SupportBase.getSource()
  • a String target directory SupportBase.getTarget()
  • a String target file name SupportBase.getTargetFileName()
Returns:
a boolean
  • true if operation was successful
  • false if operation failed

fileDelete

public boolean fileDelete(SupportBase s)
Deprecated. 
Deletes a file. Deletes the specified file from the file system.

The SupportBase to be queried must invoke SupportBase.setFileName before calling this method.

Parameters:
s - the SupportBase to be queried
  • a String file to be deleted SupportBase.getFileName()
Returns:
a boolean
  • true if operation was successful
  • false if operation failed

fileExists

public boolean fileExists(SupportBase s)
Deprecated. 
Checks for the existence of a file.

The SupportBase to be queried must invoke SupportBase.setFileName before calling this method.

Parameters:
s - the SupportBase to be queried
  • SupportBase.getFileName() for the String representing the file to check. Note that on Linux the filename specified must not contain quotes.
Returns:
a boolean
  • true if file exists
  • false if file does not exist

endOfFileGrep

public boolean endOfFileGrep(SupportBase s)
Deprecated. 
Scans the end of a file for a string.

The SupportBase to be queried must invoke SupportBase.setGrepFileName and SupportBase.setGrepString before calling this method.

The SupportBase to be queried must invoke SupportBase.setFileTextSearchLength to designate the the ending number of characters to search in the file, e.g. if 100 is specified, then only the LAST 100 characters of the file are searched for the "grep" string. If the character search count is longer than the file text, the entire file will be searched.

Parameters:
s - the SupportBase to be queried
  • a String file name SupportBase.getGrepFileName
  • a String to grep for SupportBase.getGrepString
Returns:
a boolean
  • true if the string was found in the file
  • false otherwise

getResponseFileValue

public java.lang.String getResponseFileValue(SupportBase s)
Deprecated. 
Scans a response file for a key and returns the string value found. This is a generic function that retrieves the value (right side) in a "key = value" pair in a given text based file. Typically, you can prepend the response file name with the return value from getLogsDir() which is an absolute path to the logs directory.

The SupportBase to be queried must invoke SupportBase.setResponseFileName and SupportBase.setKey before calling this method.

Parameters:
s - the SupportBase to be queried
  • a response file name SupportBase.getResponseFileName
  • a response file key SupportBase.getKey
Returns:
the String found at the key

setResponseFileValue

public boolean setResponseFileValue(SupportBase s)
Deprecated. 
Scans a response file for a key and sets the corresponding value. This function will set/replace a value in a response file. The value (right side) must be part of a "key = value" pair. It requires three String arguments (set in the SupportBase), the name of the file prepended with the absolute path, the key (leftside of key = value) and the new value. The "key = value" pair must be on the same line in the text based response file. The line must start with the var/key (i.e., no preceeding asteriks or blank spaces etc). Typically, you can prepend the rsp file name with the return value from getLogsDir() which is an absolute path to the logs directory.

The SupportBase to be queried must invoke SupportBase.setResponseFileName, SupportBase.setKey, and SupportBase.setKeyValue before calling this method.

Parameters:
s - the SupportBase to be queried
  • a response file name SupportBase.getResponseFileName
  • a response file key SupportBase.getKey
  • a response file key value SupportBase.getKeyValue
Returns:
a boolean
  • true if operation was successful
  • false if operation failed

setResponseFileValue

public boolean setResponseFileValue(SupportBase s,
                                    boolean createKeyIfDoesNotExist)
Deprecated. 
Scans a response file for a key and sets the corresponding value. This function will set/replace a value in a response file. The value (right side) must be part of a "key = value" pair. It requires three String arguments (set in the SupportBase), the name of the file prepended with the absolute path, the key (leftside of key = value) and the new value. The "key = value" pair must be on the same line in the text based response file. The line must start with the var/key (i.e., no preceeding asteriks or blank spaces etc). Typically, you can prepend the rsp file name with the return value from getLogsDir() which is an absolute path to the logs directory.

The SupportBase to be queried must invoke SupportBase.setResponseFileName, SupportBase.setKey, and SupportBase.setKeyValue before calling this method.

Parameters:
s - the SupportBase to be queried
  • a response file name SupportBase.getResponseFileName
  • a response file key SupportBase.getKey
  • a response file key value SupportBase.getKeyValue
createKeyIfDoesNotExist - set this to true if a key should be created if one does not exist.
Returns:
a boolean
  • true if operation was successful
  • false if operation failed

getFileValue

public java.lang.String getFileValue(SupportBase s)
Deprecated. 
Scans a file for a key and returns the string value found. This function is a generic function that retrieves the value (right side) in a "key = value" pair in a given text based file.

The SupportBase to be queried must invoke SupportBase.setFileName and SupportBase.setKey before calling this method.

Parameters:
s - the SupportBase to be queried
  • a file name SupportBase.getFileName
  • a file key SupportBase.getKey
Returns:
the value found at the key

setFileValue

public boolean setFileValue(SupportBase s)
Deprecated. 
Scans a file for a key and replaces the key value. This function will set/replace a value in a file. The value (right side) must be part of a "key = value" pair. It requires three String arguments (set in the SupportBase), the name of the file prepended with the absolute path, the key (leftside of key = value) and the new value. The "key = value" pair must be on the same line in the text based file. The line must start with the key (i.e., no preceeding asteriks or blank spaces etc).

The SupportBase to be queried must invoke SupportBase.setFileName, SupportBase.setKey, and SupportBase.setKeyValue before calling this method.

Parameters:
s - the SupportBase to be queried
  • a file name SupportBase.getFileName
  • a file key SupportBase.getKey
  • a file key value SupportBase.getKeyValue
Returns:
a boolean
  • true if operation was successful
  • false if operation failed

getLogsDir

public java.lang.String getLogsDir(SupportBase s)
Deprecated. 
Gets the logs directory. This function returns an absolute path to the logs directory with a slash appended to it. The logs directory contains response files, properties files, and log files for the product(s) that will be installed.

Parameters:
s - the SupportBase to be queried
Returns:
the logs directory

determineLogFileName

public java.lang.String determineLogFileName(SupportBase s)
Deprecated. 
Determines the name of the log file to use. If the application wrapper specified a log file name it will be retrieved from the ibmnsi.properties. Otherwise, the log file name that is set via the last setLogFileName method is used. If this wasn't set, then a default name of .log is used.

The SupportBase to be queried must invoke SupportBase.setLogsDir before calling this method.

Parameters:
s - the SupportBase to be queried

    getBackLevelLogFileName

    protected java.lang.String getBackLevelLogFileName(SupportBase s,
                                                       java.lang.String dottedClassName)
    Deprecated. 
    Retrieves the log file name for a user program on a back level (1.1) agent.

    If the same Java program is used for two or more of the user programs, the log file name may not be accurate because the log name lookup is based on the executing class name.

    This code should only run on a back level agent and/or for user programs which do not specifiy a log file name.

    The algorithim is as follows: 1) Find a key for which the value is the dotted class name of the currently executing program such as "testsuite.HelloWorldEntry". 2) Determine the stage/prefix from the key 3) Construct the log file name key based on the above steps and retrieve the log file name.

    Parameters:
    s - SupportBase for tracing
    dottedClassName - String the class name
    Returns:
    String

    modifyResponseFile

    public void modifyResponseFile(SupportBase s)
    Deprecated. 
    Changes a value in a response file. This function will set/replace a value in a response file. The value (right side) must be part of a "key = value" pair. The function is generic and can be used on any platform with any application. It uses three String arguments set in the SupportBase, the name of the file prepended with the absolute path, the key (leftside of key = value) and the new value. The "key = value" pair must be on the same line in the text based response file. The line must start with the key (i.e., no preceeding asteriks or blank spaces etc). Typically, you can prepend the rsp file name with the return value from getLogsDir() which is an absolute path to the logs directory.

    The SupportBase to be queried must invoke SupportBase.setResponseFileName, SupportBase.setKey, and SupportBase.setNewResponseFileValue before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a response file name SupportBase.getResponseFileName
    • a response file key name SupportBase.getKey
    • a response file key value SupportBase.getNewRespnseFileValue

    readFile

    public java.lang.String readFile(SupportBase s)
                              throws java.io.IOException
    Deprecated. 
    Reads in a file. This function reads the entire contents of a file into one string.

    The SupportBase to be queried must invoke SupportBase.setFileName before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a file name SupportBase.getFileName
    Returns:
    the contents of the file
    Throws:
    java.io.IOException - the file cannot be read

    writeFile

    public void writeFile(SupportBase s)
                   throws java.io.IOException
    Deprecated. 
    Writes a String to a file, appends it to the file or overwrites the file. If append is set to true it will append the string. If it is set to false, it will overwrite the old contents of the file with this new string. If the file doesn't already exist, it will be created.

    The SupportBase to be queried must invoke SupportBase.setFileName, SupportBase.setMessage, and SupportBase.setAppend before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String file name SupportBase.getFileName
    • a String message SupportBase.getMessage
    • a boolean indicating if we should append SupportBase.getAppend
    Throws:
    java.io.IOException - the file cannot be written

    getUnpackedDir

    public java.lang.String getUnpackedDir(SupportBase s)
    Deprecated. 
    Gets the directory where images are unpacked. The unpacked directory contains all the files exploded from the product's deployment package, including entry, exit, main, and pre-deployment checkers, as well as any other files specified in the application wrapper.

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the path to the unpacked directory with a slash appended to it

    isPortOpen

    public boolean isPortOpen(SupportBase s)
    Deprecated. 
    Verifies that a TCP/IP port is not in use. If port usage information cannot be obtained, a default of true is returned.

    The SupportBase to be queried must invoke SupportBase.setPortNumber before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a port number SupportBase.getPortNumber
    Returns:
    a boolean
    • true if port is not in use
    • false if port is in use

    checkFreeSpace

    public int checkFreeSpace(SupportBase s)
    Deprecated. use instead method checkFreeSpaceAvailable(SupportBase)

    Gets the amount of free disk space in a path. This function will return the amount of free space available in kilobytes.

    WINDOWS: You must pass a path prepended with a drive letter and a colon (exp: "c:").

    LINUX: You must pass a fully qualified path to the mount point or directory (exp: "/usr"). If "/usr" is passed and is itself a mount point the return value will be the amount of free space available in "/usr". If "/usr" is not actually a mount point, the return value will be the amount of free space in the filesystem on which "/usr" resides. In this example, the amount of free space on "/" (root) would be returned. Therefore, you can check the available free space in the target dir without knowing beforehand whether or not the target is a mount point.

    The SupportBase to be queried must invoke SupportBase.setPath before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a path SupportBase.getPath.
    Returns:
    int the amount of free space in KB

    0 will be returned if the directory does not exist, or if the drive or mnt point passed is invalid or not in the appropriate format


    checkFreeSpaceAvailable

    public long checkFreeSpaceAvailable(SupportBase s)
    Deprecated. 
    Gets the amount of free disk space in a path. This function will return the amount of free space available in kilobytes.

    WINDOWS: You must pass a path prepended with a drive letter and a colon (exp: "c:").

    LINUX: You must pass a fully qualified path to the mount point or directory (exp: "/usr"). If "/usr" is passed and is itself a mount point the return value will be the amount of free space available in "/usr". If "/usr" is not actually a mount point, the return value will be the amount of free space in the filesystem on which "/usr" resides. In this example, the amount of free space on "/" (root) would be returned. Therefore, you can check the available free space in the target dir without knowing beforehand whether or not the target is a mount point.

    The SupportBase to be queried must invoke SupportBase.setPath before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a path SupportBase.getPath.
    Returns:
    long the amount of free space in KB

    0 will be returned if the directory does not exist, or if the drive or mnt point passed is invalid or not in the appropriate format


    checkTargetDir

    public int checkTargetDir(SupportBase s)
    Deprecated. use intead method checkTargetDirectory(SupportBase)

    Determines the validity of a destination directory stored in the ibmnsi.properties file. If the directory does not already exist, it will be created. If the directory does not exist and cannot be created, the drive is invalid and the function will return 0. If the directory exists, the free space of the drive or mount point that contains the directory will be returned. The function will return integer representing the kilobytes of free space available. A return of 0 indicates no space available or an invalid directory.

    The SupportBase to be queried must invoke SupportBase.setPath before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • the application ID used to create NSI property file keys
    • a path SupportBase.getPath
    Returns:
    a int
    • 0 no space available or invalid directory
    • n the kilobytes of free space available

    checkTargetDirectory

    public long checkTargetDirectory(SupportBase s)
    Deprecated. 
    Determines the validity of a destination directory stored in the ibmnsi.properties file. If the directory does not already exist, it will be created. If the directory does not exist and cannot be created, the drive is invalid and the function will return 0. If the directory exists, the free space of the drive or mount point that contains the directory will be returned. The function will return long representing the kilobytes of free space available. A return of 0 indicates no space available or an invalid directory.

    The SupportBase to be queried must invoke SupportBase.setPath before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • the application ID used to create NSI property file keys
    • a path SupportBase.getPath
    Returns:
    a long
    • 0 no space available or invalid directory
    • n the kilobytes of free space available

    isEnoughTargetDirSpace

    public boolean isEnoughTargetDirSpace(SupportBase s)
    Deprecated. use instead method isEnoughTargetDirSpaceAvailable(SupportBase)

    Determines the validity and free space of a destination directory stored in the ibmnsi.properties file. If the directory does not already exist, it will be created.

    The SupportBase to be queried must invoke SupportBase.setPath, and SupportBase.setSizeKiloBytes before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a path SupportBase.getPath
    • an int representing the kilobytes of space required SupportBase.getKBSize
    Returns:
    a boolean
    • true if there is enough free space to install to the target directory
    • false not enough free space

    isEnoughTargetDirSpaceAvailable

    public boolean isEnoughTargetDirSpaceAvailable(SupportBase s)
    Deprecated. 
    Determines the validity and free space of a destination directory stored in the ibmnsi.properties file. If the directory does not already exist, it will be created.

    The SupportBase to be queried must invoke SupportBase.setPath, and SupportBase.setSizeKiloBytes before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a path SupportBase.getPath
    • an int representing the kilobytes of space required SupportBase.getKBSize
    Returns:
    a boolean
    • true if there is enough free space to install to the target directory
    • false not enough free space

    waitForFile

    public boolean waitForFile(SupportBase s)
    Deprecated. 
    Polls the system for the existence of a file and, optionally, strings within the file. It will pause the current thread for the specified number of seconds each time the specified file or string within the file is not found. The purpose of this function is to allow synchronization (Linux or Windows) of a wrapper's installation program with the particular product's installation program. The creation of a particular file may be taken as an indicator that the product's installation routine is complete. If success and/or failure string(s) are specified the function will continue to poll until one of the strings is found or the timeout expires.

    NOTE: In most cases, a check for (old) previous versions of the file should be performed and the (old) file should be deleted BEFORE invoking this function.

    The SupportBase to be queried must invoke SupportBase.setTimeOut_Sec, SupportBase.setInterval_Sec, and SupportBase.setPath before calling this method.

    Timeout specifies the total time to wait for the specified conditions. The function will return false if conditions aren't met in the allotted time. A negative timeout value indicates an "infinite" timeout. Interval specifies the number of seconds between checks for file existence and strings. Optionally, SupportBase.setSuccessString and SupportBase.setFailString may be invoked to narrow the search.

    Parameters:
    s - the SupportBase to be queried
    • a time out value SupportBase.getTimeOut_Sec
    • a poll interval SupportBase.getInterval_Sec
    • a path SupportBase.getPath
    Returns:
    a boolean
    • true if the file is found (created)
    • false all else

    launchAndWait

    public int launchAndWait(SupportBase s)
    Deprecated. 
    Launches a program and waits for the process to finish.

    The SupportBase to be queried must invoke SupportBase.setCommand or setCommandArray before calling this method.

    The value set via setCommand will be replaced by null when setCommandArray is invoked and vice versa.

    The SupportBase to be queried may optionally invoke SupportBase.setCommandLaunchDirectory or SupportBase.setCommandEnvironmentArray before calling this method.

    Command logging may be prohibited via the setCommandLogging method by passing a value of false .

    Return code will be within the range of -128 to +127. Out of the range return code will be wrapped into that range for Linux and OS400

    Parameters:
    s - the SupportBase to be queried
    • a command to be executed SupportBase.getCommand
    Returns:
    a int
    • -99 if failure occurred
    • n the return code from the Operating System call

    getSystemCommandOutput

    public java.lang.String getSystemCommandOutput(SupportBase s)
    Deprecated. 
    Invokes a system command and captures the output in a String. The String is returned when the process completes/returns.

    The "output" will consist of stdout, stderr, and an Exception stacktrace as appropriate. The stdout, stderr, and stacktrace will be concatenated together in that order.

    The SupportBase to be queried must invoke SupportBase.setCommand or setCommandArray before calling this method.

    The value set via setCommand will be replaced by null when setCommandArray is invoked and vice versa.

    The SupportBase to be queried may optionally invoke SupportBase.setCommandLaunchDirectory or SupportBase.setCommandEnvironmentArray before calling this method.

    Command logging may be prohibited via the setCommandLogging method by passing a value of false .

    Parameters:
    s - the SupportBase to be queried
    • a String the command to be executed SupportBase.getCommand()
    Returns:
    String the output of the command

    getSystemCommandOutput

    public java.lang.String getSystemCommandOutput(java.lang.String command,
                                                   java.lang.String commandToLog)
    Deprecated. 
    Parameters:
    command - - the command to run.
    commadToLog - - the comamnd to log. If null or empty string is specified, a command will be logged.
    Returns:
    String the output of the command

    getSystemEnvVar

    public java.lang.String getSystemEnvVar(SupportBase s)
    Deprecated. 
    Retrieves the value of a System environment variable. If the value is not set or the environment variable does not exist, the function will return null.

    The SupportBase to be queried must invoke SupportBase.setVariableName before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String variable name SupportBase.getVariableName
      Returns:
      a String
      • the value of the environment variable

    getGroupLocale

    public java.util.Locale getGroupLocale(SupportBase s)
    Deprecated. 
    Gets the locale of the install group from the server. The locale info will be obtained from ibmnsi.properties. It will return the default locale of the current machine if a value cannot be obtained from ibmnsi.properties.

    Parameters:
    s - the SupportBase to be queried
    Returns:
    String the locale of the group directory

    replaceSubstring

    public java.lang.String replaceSubstring(SupportBase s)
    Deprecated. 
    Modifies a String by replacing a substring with a new substring.

    The SupportBase to be queried must invoke SupportBase.setTargetString, SupportBase.setOldSubstring, and SupportBase.setNewSubstring before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String targetString SupportBase.getTargetString()
    • a String oldSubstring SupportBase..getOldSubstring()
    • a String newSubstring SupportBase.getNewSubstring()
    Returns:
    String resulting from replacing ALL occurrences of the old substring in the old string with the new substring

    getProductInstallingId

    public java.lang.String getProductInstallingId(SupportBase s)
    Deprecated. 
    Gets the application ID of the product currently installing on the target.

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the application ID

    getHostName

    public java.lang.String getHostName(SupportBase s)
    Deprecated. 
    Retrieves the unqualified local host name.

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the host name

    getQualifiedHostName

    public java.lang.String getQualifiedHostName(SupportBase s)
    Deprecated. 
    Retrieves the fully qualified local host name.

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the qualified host name

    getDomain

    public java.lang.String getDomain(SupportBase s)
    Deprecated. 
    Retreives the domain suffix for the local host.

    Example: raleigh.ibm.com

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the domain of the local host

    fileSearchAndReplace

    public int fileSearchAndReplace(SupportBase s)
    Deprecated. 
    Performs a find and replace in a given file. Replaces all occurrences of the "find" substring with the "replace" substring in the specified file. The SupportBase to be queried must invoke SupportBase.setFileName, SupportBase.setFind, and SupportBase.setReplace before calling this method. The following methods may optionally be called. SupportBase.setIgnoreCase SupportBase.setBackupFindAndReplace

    This method will NOT ignore whitespace.

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the number of replacements made, -1 if errors occurred

    fileSearchAndReplaceLine

    public int fileSearchAndReplaceLine(SupportBase s)
    Deprecated. 
    Performs a find and replace of a line in the specified file. The SupportBase to be queried must invoke SupportBase.setFileName, SupportBase.setFind, and SupportBase.setReplace before calling this method. It may optionally call SupportBase.setBackupFindAndReplace

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the number of replacements made, -1 if errors occurred

    findAndReplace

    public int findAndReplace(SupportBase s)
    Deprecated. 

    Performs a find and replace of a line in the specified file. The SupportBase to be queried must invoke SupportBase.setFileName, SupportBase.setFind, and SupportBase.setReplace before calling this method. It may optionally call SupportBase.setBackupFindAndReplace

    To search and replace an entire lines in a file use fileSearchAndReplaceLine

    To search and replace all occurrences of a substring in a file use fileSearchAndReplace

    Parameters:
    s - the SupportBase to be queried
    Returns:
    the number of replacements made, -1 if errors occurred

    postSuccessMessageToDeployerUI

    public void postSuccessMessageToDeployerUI(SupportBase s)
    Deprecated. 
    Posts a message with a success icon to the deployment wizard on the "Detailed Messages" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postSuccessMessageToDeployerMainUI

    public void postSuccessMessageToDeployerMainUI(SupportBase s)
    Deprecated. 
    Posts a message with a success icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postInformationMessageToDeployerUI

    public void postInformationMessageToDeployerUI(SupportBase s)
    Deprecated. 
    Posts a message with an information icon to the deployment wizard on the "Detailed Messages" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postInformationMessageToDeployerMainUI

    public void postInformationMessageToDeployerMainUI(SupportBase s)
    Deprecated. 
    Posts a message with an information icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postWarningMessageToDeployerUI

    public void postWarningMessageToDeployerUI(SupportBase s)
    Deprecated. 
    Posts a message with a warning icon to the deployment wizard on the "Detailed Messages" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postWarningMessageToDeployerMainUI

    public void postWarningMessageToDeployerMainUI(SupportBase s)
    Deprecated. 
    Posts a message with a warning icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postErrorMessageToDeployerUI

    public void postErrorMessageToDeployerUI(SupportBase s)
    Deprecated. 
    Posts a message with an error icon to the deployment wizard on the "Detailed Messages" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postErrorMessageToDeployerMainUI

    public void postErrorMessageToDeployerMainUI(SupportBase s)
    Deprecated. 
    Posts a message with an error icon to the deployment wizard on the "Detailed Messages" panel, and also on the "Status" panel.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    postCompletionMessageToDeployerUI

    public void postCompletionMessageToDeployerUI(SupportBase s)
    Deprecated. 
    Overrides the default completion message to the deployment wizard on the "Detailed Messages" panel. The user program must actually exit the install in order to cause the message to display.

    The SupportBase to be queried must invoke SupportBase.setMessage before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String message SupportBase.getMessage

    getTranslatedMessage

    public java.lang.String getTranslatedMessage(SupportBase s)
    Deprecated. 
    Retrieves a translatable message from a Locale specific ResourceBundle .

    The SupportBase to be queried. Must invoke SupportBase.setLocale , SupportBase.setMessageResourcePath , and SupportBase.setMessageSubstitutionString before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String dotted classpath SupportBase.getMessageResourcePath
    • a Locale message locale SupportBase.getLocale
    • a String message substitution parameters SupportBase.getMessageSubstitutionString
      Returns:
      String the translated message

    getDeployerLocale

    public java.util.Locale getDeployerLocale(SupportBase s)
    Deprecated. 
    Retrieves the Locale of the deployment wizard so that a translatable message can be created for display.

    Parameters:
    s - SupportBase to be queried
    Returns:
    Locale

    isApplicationVersionEqual

    public boolean isApplicationVersionEqual(SupportBase s)
    Deprecated. 
    Verifies that the specified version is equal to the version of the product currently installing. The SupportBase to be queried must invoke SupportBase.setApplicationVersion before calling this method.

    Parameters:
    s - SupportBase to be queried
    Returns:
    boolean

    getProductInstallingVersion

    public java.lang.String getProductInstallingVersion(SupportBase s)
    Deprecated. 
    Retrieves the version of the currently installing application.

    Parameters:
    s - SupportBase to be queried
    Returns:
    String

    getStringFromCommandArray

    public java.lang.String getStringFromCommandArray(SupportBase s)
    Deprecated. 
    Convienence method to assemble a command String from a String[] for logging purposes.

    The SupportBase to be queried must invoke SupportBase.setCommandArray before calling this method.

    Parameters:
    s - SupportBase
    Returns:
    String

    getIbmNsiProperties

    public java.util.Properties getIbmNsiProperties(SupportBase s)
    Deprecated. 
    Lazy initializes and retrieves the Properties object associated with the ibmnsi.properties file.

    No parameters need to be set into SupportBase prior to invocation.

    Note that the properties are cached with each instance of SupportBase . The properties are (re)loaded from disk for each instance of SupportBase .

    Typically, each pre-deployment checker, entry, main, or exit program will have its own cached properties instance.

    Returns:
    Properties

    getVpdPropertyList

    public java.util.ArrayList getVpdPropertyList(SupportBase s)
    Deprecated. 
    Retrieves a property from the ISMP vpd.properties file. The SupportBase to be queried must invoke SupportBase.setVpdUid and SupportBase.setStartPipe and SupportBase.setEndPipe and before calling this method.

    Parameters:
    s - SupportBase to be queried
    Returns:
    String the property value.

    getVpdInstallLocationArray

    public java.lang.String[] getVpdInstallLocationArray(SupportBase s)
    Deprecated. 
    Retrieves String array of install locations of an installed product with a given UID from the ISMP vpd.properties file.

    The return will be null if the UID is not found in the properties file. The SupportBase to be queried must invoke SupportBase.setVpdUid before calling this method.

    Parameters:
    s - SupportBase to be queried
    Returns:
    String[] the install locations.

    getVpdVersionArray

    public java.lang.String[] getVpdVersionArray(SupportBase s)
    Deprecated. 
    Retrieves a String array of versions of an installed product with a given UID from the ISMP vpd.properties file.

    The return will be null if the UID is not found in the properties file. The SupportBase to be queried must invoke SupportBase.setVpdUid before calling this method.

    Parameters:
    s - SupportBase to be queried
    Returns:
    String[] the version

    compareVersions

    public int compareVersions(SupportBase s)
    Deprecated. 
    Compares two dotted version strings.

    The compared version strings must be comprised of only dots and numbers. The SupportBase to be queried must invoke SupportBase.setVersion and SupportBase.setCompareVersion before calling this method.

    Parameters:
    s - SupportBase to be queried
    Returns:
    int there are four possible return values: 0 indicates versions are equal 1 indicates version is "greater" than compareVersion -1 indicates version is "less" than compareVersion Integer.MIN_VALUE if version or compareVersion contains characters other than dots and numbers.

    getProductInstallingBundleProperties

    public java.util.Properties getProductInstallingBundleProperties(SupportBase s)
    Deprecated. 
    Retrieves the Properties object loaded from the default properties bundle for the currently installing product.

    Nothing needs to be set into SupportBase prior to invoking this method.

    Parameters:
    s - SupportBase to be queried
    Returns:
    Properties

    executeCommand

    public void executeCommand(SupportBase s)
    Deprecated. 
    Executes the specified command in a separate process via Runtime.exec() with the specified environment and working directory and waits for it to finish.

    The SupportBase to be queried must invoke setCommand or setCommandArray before calling this method.

    The value set via setCommand will be replaced by null when setCommandArray is invoked and vice versa.

    The SupportBase to be queried may optionally invoke SupportBase.setCommandLaunchDirectory or SupportBase.setCommandEnvironmentArray before calling this method. The environment array and/or the working directory may be null . If the environment array is null, the current environment of the calling process will be used. If the working directory is null, the current directory will be used.

    Command logging may be prohibited via the setCommandLogging method by passing a value of false .

    The SupportBase.setWaitForOutput method may optionally be called with a boolean to indicate whether or not execution should be paused in order to ensure that the command output is captured in its entirety. The default is false.

    Return values may be obtained via the getLastCommandOutput method and/or the getLastCommandReturnCode method.

    The Wait For Completion property must be checked for the corresponding user program if the program being launched locally is an interactive program.

    Parameters:
    s - SupportBase to be queried

    getLastCommandOutput

    public java.lang.String getLastCommandOutput(SupportBase s)
    Deprecated. 
    Retrieves the output of the most recently launched command process.

    The "output" will consist of stdout, stderr, and an Exception stacktrace as appropriate. The stdout, stderr, and stacktrace will be concatenated together in that order.

    Parameters:
    s - SupportBase to be queried
    Returns:
    String

    getCommandStdOut

    public java.lang.String getCommandStdOut(SupportBase s)
    Deprecated. 
    Retrieves the standard output of the most recently launched command process captured from stdout stream.

    Parameters:
    s - SupportBase to be queried
    Returns:
    String

    getCommandStdError

    public java.lang.String getCommandStdError(SupportBase s)
    Deprecated. 
    Retrieves the output of the most recently launched command process captured from stderr stream.

    Parameters:
    s - SupportBase to be queried
    Returns:
    String from stderr

    getLastCommandReturnCode

    public int getLastCommandReturnCode(SupportBase s)
    Deprecated. 
    Retrieves the return code from the most recently launched command process.

    For Linux and i5/OS the return code will be wrapped to be within the range of -128 to +127 if it is not already in that range.

    Parameters:
    s - the SupportBase to be queried
    • a command to be executed SupportBase.getCommand
    Returns:
    a int
    • -99 if failure occurred

    getSelectedTaskList

    public java.util.List getSelectedTaskList(SupportBase s)
    Deprecated. 
    Retrieves a List of the task ids that have been selected for deployment in the Deployment Wizard.

    Nothing needs to be set into SupportBase prior to calling this method.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    The task id is an optional attribute in the solution XML. If tasks are selected that do not have an id specified, they will be identified by a number. The number is a one-based index derived from the order of appearance in the solution XML.

    The ordering of the tasks in the solution XML is preserved in the List.

    Type Parameters:
    code - SupportBase
    Returns:
    List

    getPreDeploymentCheckerResponseFilePath

    public java.lang.String getPreDeploymentCheckerResponseFilePath(SupportBase s)
    Deprecated. 
    Retrieves the name of the response file specified for the PreDeploymentChecker program prepended with the logs directory path.

    If multiple response files are associated with this program, the SupportBase method setOriginalResponseFileName should be called prior to calling this method.

    If no response file was specified for this program, null will be returned.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    Type Parameters:
    code - SupportBase
    Returns:
    String

    getEntryResponseFilePath

    public java.lang.String getEntryResponseFilePath(SupportBase s)
    Deprecated. 
    Retrieves the name of the response file specified for the Entry program prepended with the logs directory path.

    If multiple response files are associated with this program, the SupportBase method setOriginalResponseFileName should be called prior to calling this method.

    If no response file was specified for this program, null will be returned.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    Type Parameters:
    code - SupportBase
    Returns:
    String

    getMainResponseFilePath

    public java.lang.String getMainResponseFilePath(SupportBase s)
    Deprecated. 
    Retrieves the name of the response file specified for the Main program prepended with the logs directory.

    If multiple response files are associated with this program, the SupportBase method setOriginalResponseFileName should be called prior to calling this method.

    If no response file was specified for this program, null will be returned.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    Type Parameters:
    code - SupportBase
    Returns:
    String

    getExitResponseFilePath

    public java.lang.String getExitResponseFilePath(SupportBase s)
    Deprecated. 
    Retrieves the name of the response file specified for the Exit program prepended with the logs directory.

    If multiple response files are associated with this program, the SupportBase method setOriginalResponseFileName should be called prior to calling this method.

    If no response file was specified for this program, null will be returned.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    Type Parameters:
    code - SupportBase
    Returns:
    String

    getResponseFilePath

    protected java.lang.String getResponseFilePath(SupportBase s,
                                                   int stage)
    Deprecated. 
    Retrieves the name of the response file specified for the program prepended with the logs directory.

    Nothing needs to be set into SupportBase prior to calling this method.

    If no response file was specified for this program, null will be returned.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    Type Parameters:
    code - int the stage or program type
    code - SupportBase
    Returns:
    String

    getResponseFilePath

    protected java.lang.String getResponseFilePath(SupportBase s,
                                                   int stage,
                                                   java.lang.String srcName)
    Deprecated. 
    Gets the qualifed, updated response file path for the specified original response file source name.

    Parameters:
    s -
    stage -
    srcName -
    Returns:
    String

    getResponseFilePaths

    protected java.util.List<java.lang.String> getResponseFilePaths(SupportBase s,
                                                                    int stage)
    Deprecated. 
    Retrieves the name of the response file specified for the program prepended with the logs directory.

    Nothing needs to be set into SupportBase prior to calling this method.

    If no response file was specified for this program, null will be returned.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    Type Parameters:
    code - int the stage or program type
    code - SupportBase
    Returns:
    String

    getVariableValueForTaskApplication

    public java.lang.String getVariableValueForTaskApplication(SupportBase s)
    Deprecated. 
    Retrieves the value of a variable. The value is obtained by fully qualifying the specified variable with the task id and the application id.

    The SupportBase to be queried must invoke setVariableKeyword and setApplicationId and setTaskId before calling this method.

    Type Parameters:
    code - SupportBase
    Returns:
    String

    getTaskHostnameList

    public java.util.List getTaskHostnameList(SupportBase s)
    Deprecated. 
    Retrieves a List of the hostnames that were specified for deployment in the Deployment Wizard for the given task.

    The SupportBase to be queried must invoke setTaskId before calling this method.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    The task id is an optional attribute in the solution XML. If tasks are selected that do not have an id specified, they will be identified by a number. The number is a one-based index derived from the order of appearance in the solution XML.

    Type Parameters:
    code - SupportBase
    Returns:
    List

    getTaskApplicationList

    public java.util.List getTaskApplicationList(SupportBase s)
    Deprecated. 
    Retrieves a List of the application ids that were specified for deployment in the Deployment Wizard for the given task.

    The SupportBase to be queried must invoke setTaskId before calling this method.

    If the Deployment wizard has a specification version earlier than 2.1.1.0, then this method will return null .

    The task id is an optional attribute in the solution XML. If tasks are selected that do not have an id specified, they will be identified by a number. The number is a one-based index derived from the order of appearance in the solution XML.

    Type Parameters:
    code - SupportBase
    Returns:
    List

    checkDeployerVersion

    protected boolean checkDeployerVersion(SupportBase s,
                                           java.lang.String minVersion,
                                           java.lang.String methodName)
    Deprecated. 
    Verifies that the deployer version is compatible with the specified method and minimum version.

    An error message is logged if version incompatibility is detected.

    Type Parameters:
    code - SupportBase
    code - String minVersion
    code - String methodName
    Returns:
    boolean

    setIbmNsiProperty

    public void setIbmNsiProperty(SupportBase s)
    Deprecated. 
    Set a property into the currently cached ibmnsi Properties object and saves the updated properties to disk.

    The SupportBase to be queried must invoke SupportBase.setKey , and SupportBase.setKeyValue before calling this method.

    Type Parameters:
    code - SupportBase

    getPartitionFileSystemType

    public java.lang.String getPartitionFileSystemType(SupportBase s)
    Deprecated. 
    Gets the file system type of a given drive on Windows or mount point on linux. Note: This method is not supported on AIX or iSeries systems. The SupportBase to be queried must invoke SupportBase.setPath , before calling this method. The path format on Windows must be C:\\, where C is the drive letter.

    Type Parameters:
    code - SupportBase
    Returns:
    String

    getPartitionVolumeLabel

    public java.lang.String getPartitionVolumeLabel(SupportBase s)
    Deprecated. 
    Gets the volume label of a given drive on Windows or mount point on linux. Note: This method is not supported on AIX or iSeries systems. The SupportBase to be queried must invoke SupportBase.setPath , before calling this method. The path format on Windows must be C:\\, where C is the drive letter.

    Type Parameters:
    code - SupportBase
    Returns:
    String

    getPartitionCapacity

    public long getPartitionCapacity(SupportBase s)
    Deprecated. 
    Gets the capacity of a given drive on Windows or partition on linux. Note: This method is not supported on AIX or iSeries systems. The SupportBase to be queried must invoke SupportBase.setPath , before calling this method. The path format on Windows must be C:\\, where C is the drive letter.

    Type Parameters:
    code - SupportBase
    Returns:
    String

    isWindows

    public boolean isWindows()
    Deprecated. 
    Determine if the computer is running on Window operating system.

    Returns:
    true if operating system is Windows

    isLinux

    public boolean isLinux()
    Deprecated. 
    Determine if the computer is running a Linux operating system.

    Returns:
    true if operating system is Linux

    isLinuxX86_64

    public boolean isLinuxX86_64()
    Deprecated. 
    Determine if the machine is running 64 bit linux on x86

    Returns:
    true if operating system is Linux 64 bits

    isLinuxX86_32

    public boolean isLinuxX86_32()
    Deprecated. 
    Determine if the machine is running 32 bit linux on x86

    Returns:
    true if operating system is Linux 32 bits

    isSunOS

    public boolean isSunOS()
    Deprecated. 
    Determine if the computer is running on Solaris operating system.

    Returns:
    true if operating system is Solaris

    isHPUX

    public boolean isHPUX()
    Deprecated. 
    Determine if the computer is running on HPUX operating system.

    Returns:
    true if operating system is HPUX

    isAix

    public boolean isAix()
    Deprecated. 
    Determine if the computer is running on AIX operating system.

    Returns:
    true if operating system is AIX

    isOS400

    public boolean isOS400()
    Deprecated. 
    Deterine if the computer is running on OS/400 or iSeries operating system.

    Returns:
    true if operating system is iSeries

    isWindowsOSType

    public boolean isWindowsOSType(java.lang.String os)
    Deprecated. 
    Determine if the operating system is a type of Window operating system.

    Returns:
    true if operating system is Windows

    isLinuxOSType

    public boolean isLinuxOSType(java.lang.String os)
    Deprecated. 
    Determine if the operating system is a type of Linux operating system.

    Returns:
    true if operating system is Linux

    isAixOSType

    public boolean isAixOSType(java.lang.String os)
    Deprecated. 
    Determine if the operating system is a type of AIX operating system.

    Returns:
    true if operating system is AIX

    isOS400OSType

    public boolean isOS400OSType(java.lang.String os)
    Deprecated. 
    Determine if the operating system is a type of OS/400 or iSeries operating system.

    Returns:
    true if operating system is OS/400 or iSeries

    isHPUXOSType

    public boolean isHPUXOSType(java.lang.String os)
    Deprecated. 
    Determine if the operating system is a type of HPUX operating system.

    Returns:
    true if operating system is HPUX

    isSunOSType

    public boolean isSunOSType(java.lang.String os)
    Deprecated. 
    Determine if the operating system is a type of Solaris operating system.

    Returns:
    true if operating system is Solaris

    isPowerLinuxOSType

    public boolean isPowerLinuxOSType(java.lang.String os)
    Deprecated. 
    Determine if the operating system is a type of power linux operating system

    Returns:
    true if operating system is power linux

    getOSType

    public java.lang.String getOSType(java.lang.String os)
    Deprecated. 
    Determine the operating system type for a operating system

    Returns:
    String operating system type

    getPasswordValue

    public java.lang.String getPasswordValue(java.lang.String passwordVariableName)
    Deprecated. 
    Retreives a passowrd value for the currently installing application from the ibmnsi.properties file.

    The password is encrypted and stored as a hex string in the properties file. This will "unmask" the value and return it as a plain text string.

    Type Parameters:
    code - String passwordVariableName
    Returns:
    String

    getIbmNsiPropValue

    public java.lang.String getIbmNsiPropValue(SupportBase s)
    Deprecated. 
    Gets a value from the ibmnsi.properties file. Uses the application ID of the product currently installing and the name of the variable, concatenated together to form the key.

    The SupportBase to be queried must invoke SupportBase.setVariableName before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String variable name SupportBase.getVariableName
    Returns:
    the value in the properties file

    getIbmNsiPropValueByKey

    public java.lang.String getIbmNsiPropValueByKey(SupportBase s)
    Deprecated. 
    Gets a value from the ibmnsi.properties file.

    The SupportBase to be queried must invoke SupportBase.setKey before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String key in the ibmnsi.properties file SupportBase.getKey
      Returns:
      the value in the properties file

    getIbmNsiISMPPropValue

    public java.lang.String getIbmNsiISMPPropValue(SupportBase s)
    Deprecated. 
    Gets a value from the ibmnsi.properties file. Uses the application ID of the product currently installing, the property key type and the name of the variable, concatenated together to form the key.

    The SupportBase to be queried must invoke SupportBase.setVariableName and SupportBase.setPropertyKeyType before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a String variable name SupportBase.getVariableName
  • a String property key type SupportBase.getPropertyKeyType Valid key types are: SupportBase.ISMP_GLOBAL_PROPERTY, SupportBase.ISMP_PRODUCT_PROPERTY, and SupportBase.ISMP_WIZARD_PROPERTY
    Returns:
    the value in the properties file

  • getIbmNsiPropValue

    public java.lang.String getIbmNsiPropValue(java.lang.String variableName)
    Deprecated. 
    Determines the value of a passed variable name from ibmnsi.properties file.

    Parameters:
    variableName - - The name of the variable

    invokeCommand

    public int invokeCommand(java.lang.String command)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are not logged. The command return code is returned to the caller.

    The string “\bin\sh –c“ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    Parameters:
    command - - The command string to run.
    Returns:
    The return code from the command.

    invokeCommand

    public int invokeCommand(java.lang.String command,
                             java.lang.String commandToLog)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are not logged. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    Parameters:
    command - - The command string to run.
    commandToLog - - The command string to log.
    Returns:
    The return code from the command.

    invokeCommand

    public int invokeCommand(java.lang.String command,
                             java.lang.String commandToLog,
                             java.lang.String launchDir)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are not logged. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    Parameters:
    command - - The command string to run.
    commandToLog - - The command string to log.
    launchDir - The directory where to launch from.
    Returns:
    The return code from the command.

    invokeCommandLogOutput

    public int invokeCommandLogOutput(java.lang.String command)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are logged. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    All output is logged to the default log file specified in the application wrapper or the SupportBase.log.

    Parameters:
    command - - The command string to run.
    Returns:
    The return code from the command.

    invokeCommandLogOutput

    public int invokeCommandLogOutput(java.lang.String command,
                                      java.lang.String commandToLog)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are also logged. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    All output is logged to the default log file specified in the application wrapper or the default of SupportBase.log.

    Parameters:
    command - - The command string to run.
    commandToLog - The command to log.
    Returns:
    The return code from the command.

    invokeCommandLogOutput

    public int invokeCommandLogOutput(java.lang.String command,
                                      java.lang.String commandToLog,
                                      java.lang.String launchDir)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are also logged. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    All output is logged to the default log file specified in the application wrapper or the default of SupportBase.log.

    Parameters:
    command - - The command string to run.
    commandToLog - The command to log.
    launchDir - The directory where to launch from.
    Returns:
    The return code from the command.

    invokeCommandLogOutputToFileName

    public int invokeCommandLogOutputToFileName(java.lang.String command,
                                                java.lang.String logFileName)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are logged to the file supplied. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    Parameters:
    command - - The command string to run.
    logFileName - - The name of the log file used for logging.
    Returns:
    The return code from the command.

    invokeCommandLogOutputToFileName

    public int invokeCommandLogOutputToFileName(java.lang.String command,
                                                java.lang.String commandToLog,
                                                java.lang.String logFileName)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are logged to the file supplied. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    Parameters:
    command - - The command string to run.
    commandToLog - - The command string to log.
    logFileName - - The name of the log file used for logging.
    Returns:
    The return code from the command.

    invokeCommandLogOutputToFileName

    public int invokeCommandLogOutputToFileName(java.lang.String command,
                                                java.lang.String commandToLog,
                                                java.lang.String logFileName,
                                                java.lang.String launchDir)
    Deprecated. 
    Builds the appropriate command string for the operating system, logs the command to run, executes the command, and waits for it to finish. The return code from the command and the command output are logged to the file supplied. The command return code is returned to the caller.

    The string “\bin\sh –c “ is added to the beginning of the command for Linux platforms. The string “cmd /C “ is added to the beginning of the command for Windows platforms.

    Parameters:
    command - - The command string to run.
    commandToLog - - The command string to log.
    logFileName - - The name of the log file used for logging.
    launchDir - - The directory where to launch from.
    Returns:
    The return code from the command.

    log

    public void log(SupportBase s)
    Deprecated. 
    Writes a message to a log file. Writes logging information to a specified file prepended with a timestamp and "**** ". The file name set in the SupportBase is prepended with the path set as the logs directory.

    The SupportBase to be queried must invoke SupportBase.setMessage, SupportBase.setLogFileName, and SupportBase.setLogsDir before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a message SupportBase.getMessage
    • a log file name SupportBase.getLogFileName
    • a log directory name SupportBase.getLogsDir

    logNewLine

    public void logNewLine(SupportBase s)
    Deprecated. 
    Writes a blank line to a log file.

    The SupportBase to be queried must invoke SupportBase.setLogFileName and SupportBase.setLogsDir before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a log file name SupportBase.getLogFileName
    • a log directory name SupportBase.getLogsDir

    logStatus

    public void logStatus(SupportBase s)
    Deprecated. 
    Writes a success or failure message to a log file prepended with a timestamp and "****INSTALLATION STATUS = ". This String is hardcoded to facilitate searching. It takes the status String (typically SUCCESS or FAILURE) and the file name prepended with absolute path as arguments.

    The SupportBase to be queried must invoke SupportBase.setInstallSuccessStatus, SupportBase.setLogFileName, and SupportBase.setLogsDir before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • a boolean installation status SupportBase.getInstallSuccessStatus
    • a String log file name SupportBase.getLogFileName
    • a String log directory name SupportBase.getLogsDir

    log

    public void log(java.lang.String message)
    Deprecated. 
    Writes the message to a default log file. The message is written to the log file specified in the application. If a log file is not specified in the application, then it will be written to the SupportBase.log in the deployment/logs directory.

    Parameters:
    Message - - to write to the log.

    log

    public void log(java.lang.String message,
                    java.lang.String logFileName)
    Deprecated. 
    Writes the message, the timestamp and separator string to the log file specified in the logFileName

    Parameters:
    message - -Full text message string to write to the log.
    logFileName - -Fully qualified file name to write the message to.

    logAppendFile

    public boolean logAppendFile(SupportBase s)
    Deprecated. 
    This method provides a supported mechanism for adding the contents of a file to the log. For example, the user program code can create a temporary file and invoke the install program so that its output goes into the temporary file. After the install program is finished, the user program can use this method to add the contents of the temporary file to the log.

    The SupportBase to be queried must invoke SupportBase.setFileName, SupportBase.setLogFileName and SupportBase.setLogsDir before calling this method.

    Parameters:
    s - the SupportBase to be queried
    • The file SupportBase.getFileName to be opened.
    • a log file name SupportBase.getLogFileName where the contents of SupportBase.getFileName are appended.
    Returns:
    true if the file was appended to the log successfully.

    logAppendFile

    public int logAppendFile(java.lang.String fileName)
    Deprecated. 
    Appends the content of the file to the deployment wizard log file. If the file does not exist or on an error encountered in appending to a log then a failure is returned. The log file specified in the application wrapper is used if it is set, otherwise it is logged to .log

    Parameters:
    fileName - - Specify the file name with an absolute path
    Returns:
    SUCCESS if the file exists, FAILURE if not

    logAppendFile

    public int logAppendFile(java.lang.String[] fileNames)
    Deprecated. 
    Appends the content of each file listed in the array to the deployment wizard log file. If any one of the files doesnot exist a message is written to the log and a failure is returned at the end of the loop.The log file specified in the application wrapper is used if it is set, otherwise it is logged to .log

    Parameters:
    fileNames - - Array of string. Each element is a fully qualified name of a file to append.
    Returns:
    - SUCCESS -Successfully appended - FAILURE -File does not exist or an I/O error occurred during append. All exceptions are written to the log file.

    logAppendFile

    public int logAppendFile(java.lang.String fileName,
                             java.lang.String logFileName)
    Deprecated. 
    Appends the contents of the file to the specified log file if a log file is not specified in the application, then it is appended to the SupportBase.log in the deployment/logs directory.

    Parameters:
    fileName - - Specify the file name with the absolute path
    logFileName - - should be the fully qualified path.
    Returns:

    logAppendFile

    public int logAppendFile(java.lang.String[] fileNames,
                             java.lang.String logFileName)
    Deprecated. 
    Appends the contents of the files in the array to the specified log file. If a log file is not specified in the application, then it is appended to the SupportBase.log in the deployment/logs directory.

    Parameters:
    fileNames - - Use an absolute path for the names of the files in the array.
    logFileName - - The fully qualified log file name
    Returns:

    removeAlphaCharsFromString

    public java.lang.String removeAlphaCharsFromString(java.lang.String inputString)
    Deprecated. 
    Removes all characters that are non 0 -9 or '.' from the input string and returns the resulting value.

    Parameters:
    inputString - - The original input string.
    Returns:
    -The formatted string with all characters, which are not in 0-9 or '.'

    getTempDir

    public java.lang.String getTempDir()
    Deprecated. 
    Determines and returns the temporary directory from the operating system environment.

    Returns:

    fileGrep

    public boolean fileGrep(SupportBase s)
    Deprecated. 
    Scans a file for a string.

    The SupportBase to be queried must invoke SupportBase.setGrepFileName and SupportBase.setGrepString before calling this method.

    The SupportBase to be queried may optionally invoke SupportBase.setFileTextStartIndex to designate the starting point in the string text from which to begin the search.

    Parameters:
    s - the SupportBase to be queried
    • a String file name SupportBase.getGrepFileName
    • a String to grep for SupportBase.getGrepString
    Returns:
    a boolean
    • true if the string was found in the file
    • false otherwise

    fileGrep

    public boolean fileGrep(java.lang.String fileName,
                            long startIndex,
                            java.lang.String searchString)
    Deprecated. 
    Searches the contents of the file for a search string. If the file doesnot exist, a FileNotFoundException is logged and false is returned.

    Returns:
    - True if the string was found, false if the string was not found or the file does not exist.

    fileLength

    public long fileLength(java.lang.String fileName)
    Deprecated. 
    Returns the length of the file in bytes

    Parameters:
    fileName - - Specify the file name using an absolute path.
    Returns:
    - The length of the file is returned if it exists. If it does not it returns 0.

    directoryGrep

    public java.lang.String[] directoryGrep(java.lang.String directoryName,
                                            java.lang.String regularExpression)
    Deprecated. 
    Reads the file and directory names and returns a list of names that matches the regular expresion. For example, if the regular expression was "*.exe", then all file names ending in".exe" are returned in the array.This is not a recursive grep and only the directory name is searched. See the java.util.regex.Pattern javadoc for regular expression details.

    Parameters:
    directoryName - - The directory name should contain the absolute path.
    regularExpression - - The regular expression to match.
    Returns:
    Array of names that match the regular expression, a zero length array is returned if no matches are found or the directory is empty. Null is returned if the directory doesnot exist.

    arraySearch

    public boolean arraySearch(java.lang.String[] messageArray,
                               java.lang.String searchString)
    Deprecated. 
    Search for a string in the array. If search string is an exact match to any one entry in the array, then true is returned.

    Parameters:
    messageArray - - Array of strings to search.
    searchString - - Search string.
    Returns:
    - True if the search string is found in the array. False if the array is null or the search string is not in the array.

    isSameDirectoryName

    public boolean isSameDirectoryName(java.lang.String location1,
                                       java.lang.String location2)
    Deprecated. 
    Compares two directories to see if they are the same. Note: If short names are passed in for Windows, the path must exist.

    Parameters:
    String -
    String -
    Returns:
    boolean

    buildCommand

    public java.lang.String buildCommand(java.lang.String propFileName,
                                         java.lang.String command,
                                         java.lang.String newFileName)
    Deprecated. 
    Build a command that first configures the variables defined in the properties file, then calls a command to run The following variables are always set in the command: - IRU_userProgamsDir - the fully qualified directory where user programs are unpacked - IRU_responseFile - the fully qualified name of the response file

    Parameters:
    propFileName - -The name of the properties file.
    command - -The real command to be run.
    newFileName - -The name of the command which is built.
    Returns:
    Success if the script was built successfully, Failure if there is an error.

    trimDoubleQuotes

    public java.lang.String trimDoubleQuotes(java.lang.String inputString)
    Deprecated. 
    Helper method that removes quotes from values retrieved from the response file

    Parameters:
    String - -the string to remove quotes from
    Returns:
    String -the string without double quotes

    getPasswordValueByKey

    public java.lang.String getPasswordValueByKey(java.lang.String key)
    Deprecated. 
    Retreives a passowrd value from the ibmnsi.properties file.

    By specifying a fully qualified key, a password for applications other than the one currently installing can be obtained. The key may be in the form "taskId.appId.keyword".

    Any password variable key that appears in the ibmnsi.properties file may be used.

    The password is encrypted and stored as a hex string in the properties file. This will "unmask" the value and return it as a plain text string.

    Type Parameters:
    code - String the key in the ibmnsi.properties file
    Returns:
    String

    getTiedVariableValue

    public java.util.List getTiedVariableValue(java.lang.String variableKeyword)
    Deprecated. 
    Returns a List of tied, host attribute values that correspond to the variable keyword for the currently installing application.

    There is one value for each target computer selected for the task supplying the attribute to which the variable has been tied.

    The order of the values in the list corresponds to the natural ordering of the fully-qualified hostnames for the particular tied task. The list of ordered, fully-qualified hostnames is available via the property .qualified.hostnames.

    Type Parameters:
    code - String keyword. The variable keyword.
    Returns:
    List

    getQualifiedTiedVariableValue

    public java.util.List getQualifiedTiedVariableValue(java.lang.String task,
                                                        java.lang.String applicationId,
                                                        java.lang.String variableKeyword)
    Deprecated. 
    Returns a List of tied, host attribute values that correspond to the specified task, application Id and variable keyword.

    There is one value for each target computer selected for the task supplying the attribute to which the variable has been tied.

    The order of the values in the list corresponds to the natural ordering of the fully-qualified hostnames for the particular tied task. The list of of ordered, fully-qualified hostnames is available via the property .qualified.hostnames.

    Type Parameters:
    code - String task. This is the task that contains the application whose variable has been tied. It is NOT the task that supplies the attribute to which the variable has been tied.
    code - String application id. The application which contains the variable whose value is tied.
    code - String keyword. The variable keyword.
    Returns:
    List

    getTiedVariableValueForKey

    public java.util.List getTiedVariableValueForKey(java.lang.String key)
    Deprecated. 
    Returns a List of tied, host attribute values that correspond to the specified key.

    There is one value for each target computer selected for the task supplying the attribute to which the variable has been tied.

    If the key is not task qualified, the current task is assumed.

    The order of the values in the list corresponds to the natural ordering of the fully-qualified hostnames for the particular tied task. The list of of ordered, fully-qualified hostnames is available via the property .qualified.hostnames.

    Type Parameters:
    code - String key
    Returns:
    List

    getTiedPasswordValue

    public java.util.List getTiedPasswordValue(java.lang.String variableKeyword)
    Deprecated. 
    Returns a List of tied, host password values that correspond to the variable keyword for the currently installing application.

    There is one value for each target computer selected for the task supplying the attribute to which the variable has been tied.

    The order of the values in the list corresponds to the natural ordering of the fully-qualified hostnames for the particular tied task. The list of of ordered, fully-qualified hostnames is available via the property .qualified.hostnames.

    Type Parameters:
    code - String key
    Returns:
    List

    getQualifiedTiedPasswordValue

    public java.util.List getQualifiedTiedPasswordValue(java.lang.String task,
                                                        java.lang.String applicationId,
                                                        java.lang.String variableKeyword)
    Deprecated. 
    Returns a List of tied, password attribute values that correspond to the specified task, application Id and variable keyword.

    There is one value for each target computer selected for the task supplying the attribute to which the variable has been tied.

    The order of the values in the list corresponds to the natural ordering of the fully-qualified hostnames for the particular tied task. The list of of ordered, fully-qualified hostnames is available via the property .qualified.hostnames.

    Type Parameters:
    code - String task. This is the task that contains the application whose variable has been tied. It is NOT the task that supplies attribute to which the variable has been tied.
    code - String application id. The application which contains the variable whose value is tied.
    code - String keyword. The variable keyword.
    Returns:
    List

    getTiedPasswordValueForKey

    public java.util.List getTiedPasswordValueForKey(java.lang.String key)
    Deprecated. 
    Returns a List of tied, host password values that correspond to the specified key.

    There is one value for each target computer selected for the task supplying the attribute to which the variable has been tied.

    If the key is not task qualified, the current task is assumed.

    The order of the values in the list corresponds to the natural ordering of the fully-qualified hostnames for the particular tied task. The list of of ordered, fully-qualified hostnames is available via the property .qualified.hostnames.

    Type Parameters:
    code - String key
    Returns:
    List

    isVersionSupported

    public boolean isVersionSupported(java.lang.String version,
                                      java.lang.String lowestSupportedVersion,
                                      java.lang.String highestSupportedVersion)
    Deprecated. 
    Determine if the version specified falls within the boundary of the lowest supported version and highest supported version. Comparison is made after removing all dots and non-numeric characters from the provided version

    Parameters:
    Version - - version of a product to verify is supported
    lowestSupportedVersion - - the lowest supported version of a product
    highestSupportedVersion - - the highest supported version of product
    Returns:
    - true if the Version of product being checked is the same as, or between the provided lower and upper supported limits. - false otherwise

    valueExists

    public boolean valueExists(java.lang.String stringToSearch,
                               java.lang.String[] values)
    Deprecated. 
    Determine if any of the given values exist in a given string

    Parameters:
    stringToSearch - - the string to be searched for a particular value
    values - - an array of string values
    Returns:
    true if any of the values are found in the string false otherwise

    fileSearchAndReturnLinesWithSearch

    public java.lang.String[] fileSearchAndReturnLinesWithSearch(java.lang.String filename,
                                                                 java.lang.String find,
                                                                 int startSearchPosition)
    Deprecated. 
    Searches each line of a file to find a particular string. If the string is found, then it appends to a buffer the entire line with that string.

    Parameters:
    filename - - The file name that contains the string.
    find - - The string to find.
    startSearchPosition - - The position of the file to start searching from.
    Returns:
    An array of all of the lines with the string

    getQualifiedHostName

    public java.lang.String getQualifiedHostName()
    Deprecated. 
    Retrieves the qualified local host name.

    Returns:
    the qualified host name

    getSetupFileRemovalSetting

    public boolean getSetupFileRemovalSetting()
    Deprecated. 
    Gets the setup file removal setting indicating whether or not the setup files will removed a the completion of the install. The default value is true.

    Returns:
    boolean true if setup files will be removed, false if setup files will not be removed.

    setResponseFileProperty

    public void setResponseFileProperty(java.lang.String propertiesFilePath,
                                        java.lang.String key,
                                        java.lang.String value)
    Deprecated. 
    Sets a property value into a Java Properties formatted response file.

    Type Parameters:
    code - String propertiesFilePath In order to obtain the correct response file path and name, one of the following methods should be used; getPreDeploymentCheckerResponseFilePath, getEntryResponseFilePath, getMainResponseFilePath, getExitResponseFilePath, getResponseFilePath.
    code - String key
    code - String value

    getResponseFileProperty

    public java.lang.String getResponseFileProperty(java.lang.String propertiesFilePath,
                                                    java.lang.String key)
    Deprecated. 
    Gets a property value from a Java Properties formatted response file.

    Type Parameters:
    code - String propertiesFilePath In order to obtain the correct response file path and name, one of the following methods should be used; getPreDeploymentCheckerResponseFilePath, getEntryResponseFilePath, getMainResponseFilePath, getExitResponseFilePath, getResponseFilePath.
    code - String key
    Returns:
    String value

    getResponseFileProperties

    public java.util.Properties getResponseFileProperties(java.lang.String propertiesFilePath)
    Deprecated. 
    Gets a Properties object populated by a Java Properties formatted response file.

    Type Parameters:
    code - String propertiesFilePath In order to obtain the correct response file path and name, one of the following methods should be used; getPreDeploymentCheckerResponseFilePath, getEntryResponseFilePath, getMainResponseFilePath, getExitResponseFilePath, getResponseFilePath.
    Returns:
    Properties

    unPackJar

    public boolean unPackJar(java.lang.String absolutePathName,
                             java.lang.String destinationDirPath)
    Deprecated. 
    Unpacks a jar file.

    Type Parameters:
    code - String absolutePathName The absolute path to the jar file including the name of the jar file.
    code - String destinationDirPath The absolute destination path where the jar file will be upacked to.
    Returns:
    true if the jar file was successfully unpacked. false otherwise.

    launchLocalInteractiveProgram

    public void launchLocalInteractiveProgram(SupportBase s)
    Deprecated. 
    Executes the specified local interative program command in a separate process via Runtime.exec() with the specified environment and working directory and returns immediately. The method does not wait for the launched program to complete.

    This method should not be used to launch interactive programs during a remote deployment. The method assumes a local deployment.

    The SupportBase to be queried must invoke setCommand or setCommandArray before calling this method.

    The value set via setCommand will be replaced by null when setCommandArray is invoked and vice versa.

    The SupportBase to be queried may optionally invoke SupportBase.setCommandLaunchDirectory or SupportBase.setCommandEnvironmentArray before calling this method. The environment array and/or the working directory may be null . If the environment array is null, the current environment of the calling process will be used. If the working directory is null, the current directory will be used.

    Command logging may be prohibited via the setCommandLogging method by passing a value of false .

    The SupportBase.setWaitForOutput cannot be used with this method.

    The Wait For Completion property must be checked for the corresponding user program.

    An alternative of launchLocalInteractiveProgram method is to invoke SupportBase.setLocalInteractive(true) prior to invoking executeCommand .

    Parameters:
    s - SupportBase to be queried

    isPortRegistered

    public boolean isPortRegistered(int port)
    Deprecated. 
    Checks the operating system services file to see if the port is already registered.

    Parameters:
    port - the port to check
    Returns:
    true if the port is already registered, false otherwise

    isIpv6Address

    public boolean isIpv6Address(java.lang.String computerName)
    Deprecated. 
    Indicates whether or not the specified computer name is an IPv6 address.

    For example, "FEDC:BA98:7654:3210:FEDC:BA98:7654:3210" would return true. The name "test.ibm.com" would return false.

    Parameters:
    computerName -
    Returns:
    boolean

    getTheSupportBase

    public SupportBase getTheSupportBase()
    Deprecated. 
    Get the SupportBase instance of the class

    Returns:

    setTheSupportBase

    public void setTheSupportBase(SupportBase theSupportBase)
    Deprecated. 
    Set the SupportBase instance of the class

    Parameters:
    theSupportBase -