com.ibm.jsdt.support
Class SupportBase

java.lang.Object
  extended by com.ibm.jsdt.common.Base
      extended by com.ibm.jsdt.support.SupportBase
Direct Known Subclasses:
SupportAixBase, SupportHPUXBase, SupportLinuxBase, SupportOS400Base, SupportSolarisBase, SupportWindowsBase

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

public abstract class SupportBase
extends com.ibm.jsdt.common.Base

Base for Pre-deployment checker, Entry, Exit, and Main programs. The SupportBase acts as a repository to store values that are used by functions available in the SupportHelper. Values must be set in the base class before calling their corresponding SupportHelper function. Once set into the base class, data can be used in various combinations to pass parameters to helper functions.

See the documentation of the SupportHelper functions you will use for a list of the setters you must call.


Field Summary
static java.lang.String AIX
          Deprecated.  
protected  boolean backupFindAndReplace
          Deprecated.  
protected  java.lang.String chmodValue
          Deprecated.  
static java.lang.String copyright
          Deprecated.  
static java.lang.String DEPLOYER_SPECIFICATION_VERSION_KEY
          Deprecated.  
protected static int ENTRY_STAGE
          Deprecated.  
protected static int EXIT_STAGE
          Deprecated.  
protected  java.lang.String[] failString
          Deprecated.  
static int FAILURE
          Deprecated.  
protected  java.lang.String fileName
          Deprecated.  
protected  java.lang.String find
          Deprecated.  
protected  java.lang.String grepFileName
          Deprecated.  
protected  java.lang.String grepString
          Deprecated.  
protected  java.lang.String groupName
          Deprecated.  
static java.lang.String HPUX
          Deprecated.  
protected  boolean ignoreCase
          Deprecated.  
protected  boolean ignoreWhitespace
          Deprecated.  
static java.lang.String ISMP_GLOBAL_PROPERTY
          Deprecated.  
static java.lang.String ISMP_PRODUCT_PROPERTY
          Deprecated.  
static java.lang.String ISMP_WIZARD_PROPERTY
          Deprecated.  
protected  java.lang.String jarName
          Deprecated.  
protected  java.lang.String key
          Deprecated.  
protected  java.lang.String keyValue
          Deprecated.  
static java.lang.String LINUX_ON_POWER
          Deprecated.  
static java.lang.String LINUX_X86_32
          Deprecated.  
static java.lang.String LINUX_X86_64
          Deprecated.  
protected  java.lang.String logFileDir
          Deprecated.  
protected  java.lang.String logFileName
          Deprecated.  
protected static int MAIN_STAGE
          Deprecated.  
protected  java.lang.String message
          Deprecated.  
protected  java.lang.String newResponseFileValue
          Deprecated.  
static java.lang.String OS400
          Deprecated.  
protected  java.lang.String password
          Deprecated.  
protected  java.lang.String path
          Deprecated.  
static int PDC_CANCEL_INSTALL
          Deprecated.  
static int PDC_DO_NOT_INSTALL
          Deprecated.  
static int PDC_DOES_NOT_EXIST
          Deprecated.  
static int PDC_EXISTS
          Deprecated.  
protected  int portNumber
          Deprecated.  
protected  java.lang.String propertyLogFileName
          Deprecated.  
protected  java.lang.String propType
          Deprecated.  
protected  int registryKey
          Deprecated.  
protected  java.lang.String registryStringValue
          Deprecated.  
protected  java.lang.String registrySubKey
          Deprecated.  
protected  java.lang.String replace
          Deprecated.  
protected  java.lang.String responseFileName
          Deprecated.  
static java.lang.String SELECTED_TASK_NAMES_KEY
          Deprecated.  
protected  int servicePack
          Deprecated.  
static java.lang.String sNEWLN
          Deprecated.  
protected static java.lang.String sSLASH
          Deprecated.  
static int SUCCESS
          Deprecated.  
protected  java.lang.String[] successString
          Deprecated.  
static java.lang.String SUNOS
          Deprecated.  
protected  java.lang.String userName
          Deprecated.  
protected static int VERSIONCHECKER_STAGE
          Deprecated.  
static int VPD_INSTALL_LOCATION_PIPE
          Deprecated.  
static int VPD_VERSION_PIPE
          Deprecated.  
static java.lang.String WINDOWS
          Deprecated.  
 
Fields inherited from class com.ibm.jsdt.common.Base
NEW_LINE, OS_NAME, SLASH
 
Constructor Summary
SupportBase()
          Deprecated. Constructor solely use to invoke trace
 
Method Summary
 java.lang.String getAgentRelease()
          Deprecated. Retrieves the release of the IBM Installation Agent code base.
 boolean getAppend()
          Deprecated. Standard getter.
 java.lang.String getApplicationId()
          Deprecated. Returns the application Id.
 java.lang.String getApplicationVersion()
          Deprecated. Retrieves the application version
protected  java.lang.String getBackLevelDeployerMessage(java.lang.String methodName, java.lang.String sinceVersion)
          Deprecated. Obtains a back-level version message when an unavailble new API is invoked that is dependent on the version of the Deployment wizard.
protected  java.lang.String getBackLevelJsdtMessage(java.lang.String methodName)
          Deprecated. Obtains a back-level version message when an unavailble new API is invoked.
 boolean getBackupFindAndReplace()
          Deprecated. Standard getter.
 java.lang.String getChmodValue()
          Deprecated. Standard getter.
 java.lang.String getCommand()
          Deprecated. Standard getter.
 java.lang.String[] getCommandArray()
          Deprecated. Retrieves the array of command tokens.
 java.lang.String[] getCommandEnvironmentArray()
          Deprecated. Gets the environment for a system command line invocation.
 java.lang.String getCommandLaunchDirectory()
          Deprecated. Gets the working directory for a command line invocation.
 java.lang.String getCompareVersion()
          Deprecated. Retrieves the application version to compare.
 java.lang.String getDeploymentPackageJarName()
          Deprecated. Retrieves the deployment package jar file name.
 java.lang.String getDeploymentWizardSpecificationVersion()
          Deprecated. Retrieves the Specification-version of the Deployment wizard.
 java.lang.String[] getFailString()
          Deprecated. Standard getter.
 java.lang.String getFileName()
          Deprecated. Standard getter.
 int getFileTextSearchLength()
          Deprecated. Sets the length of a file text (sub)String to be searched.
 int getFileTextStartIndex()
          Deprecated. Sets the index or starting position in the file text String from which to delineate a substring.
 java.lang.String getFind()
          Deprecated. Standard getter.
 java.lang.String getGrepFileName()
          Deprecated. Standard getter.
 java.lang.String getGrepString()
          Deprecated. Standard getter.
 java.lang.String getGroupName()
          Deprecated. Standard getter.
 SupportHelper getHelper()
          Deprecated. Instantiates a new SupportHelper and returns it.
 java.util.Properties getIbmNsiProperties()
          Deprecated. Lazy initializes and retrieves the Properties object associated with the ibmnsi.properties file.
 java.lang.String getIbmnsiPropertyKeyPrefix()
          Deprecated. Retrieves the appropriate key prefix for a value in the ibmnsi.properites file.
 boolean getIgnoreCase()
          Deprecated. Standard getter.
 boolean getIgnoreWhitespace()
          Deprecated. Standard getter.
 boolean getInstallSuccessStatus()
          Deprecated. Standard getter.
 int getInterval_Sec()
          Deprecated. Standard getter.
 java.lang.String getJarFile()
          Deprecated. Standard getter.
 int getKBSize()
          Deprecated. Standard getter.
 java.lang.String getKey()
          Deprecated. Standard getter.
 java.lang.String getKeyValue()
          Deprecated. Standard getter.
 java.util.Locale getLocale()
          Deprecated. Retrieves the Locale of a translatable resource.
 java.lang.String getLogFileDir()
          Deprecated. Standard getter.
 java.lang.String getLogFileName()
          Deprecated. Standard getter.
 java.lang.String getMainResources()
          Deprecated. Get the name of the main ResourceBundle.
 java.lang.String getMessage()
          Deprecated. Standard getter.
 java.lang.String getMessageResourcePath()
          Deprecated. Retrieves the dotted classpath of a translatable resource's ResourceBundle
 java.lang.String[] getMessageSubstitutionStringArray()
          Deprecated. Retrieves the String array of message substitution paramaters.
 java.lang.String getNewResponseFileValue()
          Deprecated. Standard getter.
 java.lang.String getNewSubstring()
          Deprecated. Standard getter.
 java.lang.String getNSIProperty(java.lang.String key)
          Deprecated. Gets the value corresponding to the given key from the ibmnsi.properties file.
 java.lang.String getOldSubstring()
          Deprecated. Standard getter.
 java.lang.String getOriginalResponseFileName()
          Deprecated.  
 java.lang.String getPassword()
          Deprecated. Standard getter.
 java.lang.String getPath()
          Deprecated. Standard getter.
 int getPortNumber()
          Deprecated. Standard getter.
 java.util.List getPrivileges()
          Deprecated. Standard getter.
 java.lang.String getPropertyKeyType()
          Deprecated. Standard getter.
 java.lang.String getPropertyLogFileName()
          Deprecated. Gets the log file name stored in the ibmnsi.properties file.
 int getRegistryKey()
          Deprecated. Standard getter.
 java.lang.String getRegistryStringValue()
          Deprecated. Standard getter.
 java.lang.String getRegistrySubKey()
          Deprecated. Standard getter.
 java.lang.String getReplace()
          Deprecated. Standard getter.
 java.lang.String getResourceString(java.lang.String key)
          Deprecated. Get a string from the ResourceBundle using specified given key.
 java.lang.String getResourceString(java.lang.String key, java.util.Locale loc)
          Deprecated. Get a string for the given key and locale.
 java.lang.String getResourceString(java.lang.String key, java.lang.String parms)
          Deprecated. Get a string for the given key and substution parameters
 java.lang.String getResourceString(java.lang.String key, java.lang.String[] substitutions)
          Deprecated. Retrieves a translated message for the given key and substitution parameters.
 java.lang.String getResourceString(java.lang.String key, java.lang.String parms, java.util.Locale loc)
          Deprecated. Get a string for the given key, substitution paramaters, and locale.
 java.lang.String[] getResourceStringArray(java.lang.String stem)
          Deprecated. Gets an array of String values from a ResourceBundle.
 java.lang.String[] getResourceStringArray(java.lang.String stem, java.util.Locale loc)
          Deprecated. Gets an array of String values from a ResourceBundle.
 java.lang.String getResponseFileName()
          Deprecated. Standard getter.
 java.lang.Object[] getRPMArray()
          Deprecated. Standard getter.
 java.lang.String getRpmPackage()
          Deprecated. Standard getter.
 java.lang.String getSection()
          Deprecated. Standard getter.
 int getServicePack()
          Deprecated. Standard getter.
 java.util.List getServices()
          Deprecated. Standard getter.
 java.lang.String getSingleSubstitutionString(java.lang.String key, java.lang.String substitution)
          Deprecated. Retrieves a translated message for the given key and single substitution parameter.
 java.lang.String getSource()
          Deprecated. Standard getter.
 java.lang.String[] getSuccessString()
          Deprecated. Standard getter.
 java.lang.String getTarget()
          Deprecated. Standard getter for a target directory
 java.lang.String getTargetFileName()
          Deprecated. Retrieves the name of the file when it is copied to the new target location.
 java.lang.String getTargetString()
          Deprecated. Standard getter.
 java.lang.String getTaskId()
          Deprecated. Returns the task Id.
 int getTimeOut_Sec()
          Deprecated. Standard getter.
 java.lang.String getUserName()
          Deprecated. Standard getter.
 java.lang.String getVariableKeyword()
          Deprecated. Returns the variableKeyword.
 java.lang.String getVariableName()
          Deprecated. Standard getter.
 java.lang.String getVersion()
          Deprecated. Retrieves the application version.
 int getVpdEndPipe()
          Deprecated. Retrieves the number of the last pipe character that delimits the sought VPD property.
 int getVpdStartPipe()
          Deprecated. Retrieves the number of the first pipe character that delimits the sought VPD property.
 java.lang.String getVpdUid()
          Deprecated. Returns the UID of the product for which the VPD property value is sought.
 java.lang.String getWindowsDrive()
          Deprecated. Retrieves the windows drive which is a drive letter followed by a colon and a backslash.
 boolean isLocalInteractive()
          Deprecated. Indicates whether or not the associated program launch command is for a local interactive program.
 void setAppend(boolean data)
          Deprecated. Standard setter.
 void setApplicationId(java.lang.String applicationId)
          Deprecated. Sets the application Id.
 void setApplicationVersion(java.lang.String _applicationVersion)
          Deprecated. Sets the application version
 void setBackupFindAndReplace(boolean backup)
          Deprecated. Standard setter.
 void setChmodValue(java.lang.String data)
          Deprecated. Standard setter.
 void setCommand(java.lang.String data)
          Deprecated. Standard setter.
 void setCommandArray(java.lang.String[] args)
          Deprecated. Sets the array of command tokens.
 void setCommandEnvironmentArray(java.lang.String[] env)
          Deprecated. Sets the environment for a system command line invocation.
 void setCommandLaunchDirectory(java.lang.String launchDirectoryPath)
          Deprecated. Sets the working directory for a command line invocation.
 void setCommandLogging(boolean shouldLog)
          Deprecated. Sets an indicator as to whether or not this command should be traced/logged.
 void setCompareVersion(java.lang.String cVersion)
          Deprecated. Sets the application version to compare.
 void setFailString(java.lang.String[] data)
          Deprecated. Standard setter.
 void setFailString(java.util.Vector data)
          Deprecated. Standard setter.
 void setFileName(java.lang.String data)
          Deprecated. Standard setter.
 void setFileTextSearchLength(int _fileTextSearchLength)
          Deprecated. Gets the length of a file text (sub)String to be searched.
 void setFileTextStartIndex(int _fileTextStartIndex)
          Deprecated. Gets the index or starting position in the file text String from which to delineate a substring.
 void setFind(java.lang.String findString)
          Deprecated. Standard setter.
 void setFind(java.lang.String findString, boolean ignoreCase, boolean ignoreWhitespace)
          Deprecated. Standard setter.
 void setGrepFileName(java.lang.String data)
          Deprecated. Standard setter.
 void setGrepString(java.lang.String data)
          Deprecated. Standard setter.
 void setGroupName(java.lang.String data)
          Deprecated. Standard setter.
 void setIgnoreCase(boolean ignoreCase)
          Deprecated. Standard setter.
 void setInstallSuccessStatus(boolean data)
          Deprecated. Standard setter.
 void setInterval_Sec(int data)
          Deprecated. Standard setter.
 void setJarFile(java.lang.String data)
          Deprecated. Standard setter.
 void setKey(java.lang.String data)
          Deprecated. Standard setter.
 void setKeyValue(java.lang.String data)
          Deprecated. Standard setter.
 void setLocale(java.util.Locale _locale)
          Deprecated. Sets the Locale for a translatable resource.
 void setLocalInteractive(boolean isLocalInteractive)
          Deprecated. The value specified indicates whether or not the associated program launch command is for a local interactive program.
 void setLogFileDir(java.lang.String data)
          Deprecated. Standard setter.
 void setLogFileName(java.lang.String data)
          Deprecated. Standard setter.
 void setMainResources(java.lang.String myResources)
          Deprecated. Set the name of the main ResourceBundle.
 void setMessage(java.lang.String data)
          Deprecated. Standard setter.
 void setMessageResourcePath(java.lang.String _path)
          Deprecated. Sets the dotted classpath of a translated message's ResourceBundle .
 void setMessageSubstitutionString(java.lang.String _subs)
          Deprecated. Sets the comma delimited set of message subtitutions.
 void setMessageSubstitutionStringArray(java.lang.String[] _tmpArray)
          Deprecated. Sets the Array of message subtitutions.
 void setNewResponseFileValue(java.lang.String data)
          Deprecated. Standard setter.
 void setNewSubstring(java.lang.String data)
          Deprecated. Standard setter.
 void setOldSubstring(java.lang.String data)
          Deprecated. Standard setter.
 void setOriginalResponseFileName(java.lang.String originalResponseFileName)
          Deprecated.  
 void setPassword(java.lang.String data)
          Deprecated. Standard setter.
 void setPath(java.lang.String data)
          Deprecated. Standard setter.
 void setPortNumber(int data)
          Deprecated. Standard setter.
 void setPrivileges(java.util.List data)
          Deprecated. Standard setter.
 void setPropertyKeyType(java.lang.String data)
          Deprecated. Standard setter.
 void setRegistryKey(int data)
          Deprecated. Standard setter.
 void setRegistryStringValue(java.lang.String data)
          Deprecated. Standard setter.
 void setRegistrySubKey(java.lang.String data)
          Deprecated. Standard setter.
 void setReplace(java.lang.String replaceString)
          Deprecated. Standard setter.
 void setResponseFileName(java.lang.String data)
          Deprecated. Standard setter.
 void setRPMArray(java.lang.Object[] data)
          Deprecated. Standard setter.
 void setRPMArray(java.lang.String[] data)
          Deprecated. Standard setter.
 void setRPMArray(java.util.Vector data)
          Deprecated. Standard setter.
 void setRpmPackage(java.lang.String data)
          Deprecated. Standard setter.
 void setSection(java.lang.String data)
          Deprecated. Standard setter.
 void setServicePack(int data)
          Deprecated. Standard setter.
 void setServices(java.util.List data)
          Deprecated. Standard setter.
 void setSizeKiloBytes(int data)
          Deprecated. Standard setter.
 void setSizeMegaBytes(int data)
          Deprecated. Standard setter.
 void setSource(java.lang.String data)
          Deprecated. Standard setter for a source file or directory.
 void setSuccessString(java.lang.String[] data)
          Deprecated. Standard setter.
 void setSuccessString(java.util.Vector data)
          Deprecated. Standard setter.
 void setTarget(java.lang.String data)
          Deprecated. Standard setter for a target directory.
 void setTargetFileName(java.lang.String targetFileName)
          Deprecated. Sets the new name of the file that is being copied.
 void setTargetString(java.lang.String data)
          Deprecated. Standard setter.
 void setTaskId(java.lang.String taskId)
          Deprecated. Sets the task Id.
 void setTimeOut_Sec(int data)
          Deprecated. Standard setter.
 void setUserName(java.lang.String data)
          Deprecated. Standard setter.
 void setVariableKeyword(java.lang.String variableKeyword)
          Deprecated. Sets the variableKeyword.
 void setVariableName(java.lang.String data)
          Deprecated. Standard setter.
 void setVersion(java.lang.String _version)
          Deprecated. Sets the application version.
 void setVpdEndPipe(int vpdEndPipe)
          Deprecated. Sets the number of the last pipe character that delimits the sought VPD property.
 void setVpdStartPipe(int vpdStartPipe)
          Deprecated. Sets the number of the first pipe character that delimits the sought VPD property.
 void setVpdUid(java.lang.String vpdUid)
          Deprecated. Sets the uid of the product for which the VPD property value is sought.
 void setWaitForOutput(boolean _waitForOutput)
          Deprecated. Sets an indicator as to whether or not a pause is needed to caputure a system command call's output in its entirety.
 void setWindowsDrive(java.lang.String windowsDrive)
          Deprecated. Sets the windows drive letter.
 boolean shouldLogCommand()
          Deprecated. Gets an indicator as to whether or not this command should be traced/logged.
 boolean shouldWaitForOutput()
          Deprecated. Indicates whether or not a pause is needed to capture a system command call's output in its entirety.
 void trace(java.lang.Object object)
          Deprecated.  
 void trace(java.lang.Object[] objects, boolean ignore)
          Deprecated.  
 void trace(java.lang.String text)
          Deprecated.  
 
Methods inherited from class com.ibm.jsdt.common.Base
getBuildPropertiesAccessor, getFullVersion, showBuildProperties, showFullVersion
 
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

sSLASH

protected static final java.lang.String sSLASH
Deprecated. 

sNEWLN

public static java.lang.String sNEWLN
Deprecated. 

ISMP_GLOBAL_PROPERTY

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

ISMP_WIZARD_PROPERTY

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

ISMP_PRODUCT_PROPERTY

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

PDC_DO_NOT_INSTALL

public static final int PDC_DO_NOT_INSTALL
Deprecated. 
See Also:
Constant Field Values

PDC_CANCEL_INSTALL

public static final int PDC_CANCEL_INSTALL
Deprecated. 
See Also:
Constant Field Values

PDC_EXISTS

public static final int PDC_EXISTS
Deprecated. 
See Also:
Constant Field Values

PDC_DOES_NOT_EXIST

public static final int PDC_DOES_NOT_EXIST
Deprecated. 
See Also:
Constant Field Values

SUCCESS

public static final int SUCCESS
Deprecated. 
See Also:
Constant Field Values

FAILURE

public static final int FAILURE
Deprecated. 
See Also:
Constant Field Values

VPD_INSTALL_LOCATION_PIPE

public static final int VPD_INSTALL_LOCATION_PIPE
Deprecated. 
See Also:
Constant Field Values

VPD_VERSION_PIPE

public static final int VPD_VERSION_PIPE
Deprecated. 
See Also:
Constant Field Values

DEPLOYER_SPECIFICATION_VERSION_KEY

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

SELECTED_TASK_NAMES_KEY

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

VERSIONCHECKER_STAGE

protected static final int VERSIONCHECKER_STAGE
Deprecated. 
See Also:
Constant Field Values

ENTRY_STAGE

protected static final int ENTRY_STAGE
Deprecated. 
See Also:
Constant Field Values

MAIN_STAGE

protected static final int MAIN_STAGE
Deprecated. 
See Also:
Constant Field Values

EXIT_STAGE

protected static final int EXIT_STAGE
Deprecated. 
See Also:
Constant Field Values

WINDOWS

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

AIX

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

LINUX_ON_POWER

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

LINUX_X86_64

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

LINUX_X86_32

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

SUNOS

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

HPUX

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

OS400

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

path

protected java.lang.String path
Deprecated. 

fileName

protected java.lang.String fileName
Deprecated. 

jarName

protected java.lang.String jarName
Deprecated. 

registrySubKey

protected java.lang.String registrySubKey
Deprecated. 

registryStringValue

protected java.lang.String registryStringValue
Deprecated. 

grepFileName

protected java.lang.String grepFileName
Deprecated. 

grepString

protected java.lang.String grepString
Deprecated. 

find

protected java.lang.String find
Deprecated. 

replace

protected java.lang.String replace
Deprecated. 

backupFindAndReplace

protected boolean backupFindAndReplace
Deprecated. 

ignoreCase

protected boolean ignoreCase
Deprecated. 

ignoreWhitespace

protected boolean ignoreWhitespace
Deprecated. 

chmodValue

protected java.lang.String chmodValue
Deprecated. 

responseFileName

protected java.lang.String responseFileName
Deprecated. 

key

protected java.lang.String key
Deprecated. 

keyValue

protected java.lang.String keyValue
Deprecated. 

logFileName

protected java.lang.String logFileName
Deprecated. 

logFileDir

protected java.lang.String logFileDir
Deprecated. 

userName

protected java.lang.String userName
Deprecated. 

groupName

protected java.lang.String groupName
Deprecated. 

password

protected java.lang.String password
Deprecated. 

message

protected java.lang.String message
Deprecated. 

newResponseFileValue

protected java.lang.String newResponseFileValue
Deprecated. 

propType

protected java.lang.String propType
Deprecated. 

propertyLogFileName

protected java.lang.String propertyLogFileName
Deprecated. 

successString

protected java.lang.String[] successString
Deprecated. 

failString

protected java.lang.String[] failString
Deprecated. 

registryKey

protected int registryKey
Deprecated. 

portNumber

protected int portNumber
Deprecated. 

servicePack

protected int servicePack
Deprecated. 
Constructor Detail

SupportBase

public SupportBase()
Deprecated. 
Constructor solely use to invoke trace

Method Detail

trace

public void trace(java.lang.String text)
Deprecated. 

Logs the text to the support framework trace log (IRU_SupportTrace.log by default). This text will only be logged when the support framework trace is enabled and the log file has not exceeded its maximum size.

Parameters:
text - - The text to be logged
See Also:
java.util.logging

trace

public void trace(java.lang.Object[] objects,
                  boolean ignore)
Deprecated. 

Trace method invoked via reflection.

Parameters:
objects -
ignore -
See Also:
java.util.logging

trace

public void trace(java.lang.Object object)
Deprecated. 

Trace method invoked via reflection.

Parameters:
object -
See Also:
java.util.logging

getNSIProperty

public java.lang.String getNSIProperty(java.lang.String key)
Deprecated. 
Gets the value corresponding to the given key from the ibmnsi.properties file. This file contains all the configuration data for the product.

NOTE: When an application wrapper is serialized, all the variables/configuration information that was specified in the wrapper is written to a properties file named, <application id >.properties. For example IRU2_1DDB2Express8_2Win.properties. When the staging server is launched it has access to all the default values specified, given that the properties file is stored in the solution ser file. Any configuration changes made by the user are held in memory and when the install takes place, all of the configuration information for each application in the solution, as well as staging server configuration info is written to ibmnsi.propertes. It is from this file that you may retrieve the variables, using the API provided by the support framework.

Parameters:
key - the key to be queried
Returns:
value the value corresponding to the given key

getHelper

public SupportHelper getHelper()
Deprecated. 
Instantiates a new SupportHelper and returns it.

Returns:
an instance of SupportHelper

getAppend

public boolean getAppend()
Deprecated. 
Standard getter.

Returns:
a boolean representing whether or not data should be appended

getChmodValue

public java.lang.String getChmodValue()
Deprecated. 
Standard getter.

Returns:
the required chmod value

getCommand

public java.lang.String getCommand()
Deprecated. 
Standard getter.

Returns:
the required command to be executed

getPropertyLogFileName

public java.lang.String getPropertyLogFileName()
Deprecated. 
Gets the log file name stored in the ibmnsi.properties file. Once found, the name is cached in the instance variable.

Returns:
the log file name retrieved from the ibmnsi.properties file

getFailString

public java.lang.String[] getFailString()
Deprecated. 
Standard getter.

Returns:
the list of failure strings

getFileName

public java.lang.String getFileName()
Deprecated. 
Standard getter.

Returns:
the required file name

getGrepFileName

public java.lang.String getGrepFileName()
Deprecated. 
Standard getter.

Returns:
the file to grep

getGrepString

public java.lang.String getGrepString()
Deprecated. 
Standard getter.

Returns:
the String to grep

getGroupName

public java.lang.String getGroupName()
Deprecated. 
Standard getter.

Returns:
the group name

getInstallSuccessStatus

public boolean getInstallSuccessStatus()
Deprecated. 
Standard getter.

Returns:
a boolean indicating the installation status

getInterval_Sec

public int getInterval_Sec()
Deprecated. 
Standard getter.

Returns:
the desired time interval in seconds

getJarFile

public java.lang.String getJarFile()
Deprecated. 
Standard getter.

Returns:
the jar file name / product id

getKBSize

public int getKBSize()
Deprecated. 
Standard getter.

Returns:
the size in kilobytes

getKey

public java.lang.String getKey()
Deprecated. 
Standard getter.

Returns:
the key

getKeyValue

public java.lang.String getKeyValue()
Deprecated. 
Standard getter.

Returns:
the key value

getLogFileDir

public java.lang.String getLogFileDir()
Deprecated. 
Standard getter.

Returns:
the log file directory

getLogFileName

public java.lang.String getLogFileName()
Deprecated. 
Standard getter.

Returns:
the log file name

getMessage

public java.lang.String getMessage()
Deprecated. 
Standard getter.

Returns:
the desired message

getNewResponseFileValue

public java.lang.String getNewResponseFileValue()
Deprecated. 
Standard getter.

Returns:
the response file value

getNewSubstring

public java.lang.String getNewSubstring()
Deprecated. 
Standard getter.

Returns:
the new substring

getOldSubstring

public java.lang.String getOldSubstring()
Deprecated. 
Standard getter.

Returns:
the old substring

getPassword

public java.lang.String getPassword()
Deprecated. 
Standard getter.

Returns:
the password

getPath

public java.lang.String getPath()
Deprecated. 
Standard getter.

Returns:
the path

getPortNumber

public int getPortNumber()
Deprecated. 
Standard getter.

Returns:
the port number

getPrivileges

public java.util.List getPrivileges()
Deprecated. 
Standard getter.

Returns:
the list of user privileges

getPropertyKeyType

public java.lang.String getPropertyKeyType()
Deprecated. 
Standard getter.

Returns:
the property key type

getRegistryKey

public int getRegistryKey()
Deprecated. 
Standard getter.

Returns:
the registry key

getRegistryStringValue

public java.lang.String getRegistryStringValue()
Deprecated. 
Standard getter.

Returns:
the registry key value

getRegistrySubKey

public java.lang.String getRegistrySubKey()
Deprecated. 
Standard getter.

Returns:
the registry subkey value

getResponseFileName

public java.lang.String getResponseFileName()
Deprecated. 
Standard getter.

Returns:
the response file name

getRPMArray

public java.lang.Object[] getRPMArray()
Deprecated. 
Standard getter.

Returns:
the array of RPM names

getRpmPackage

public java.lang.String getRpmPackage()
Deprecated. 
Standard getter.

Returns:
the RPM package

getSection

public java.lang.String getSection()
Deprecated. 
Standard getter.

Returns:
the section of a response file

getServicePack

public int getServicePack()
Deprecated. 
Standard getter.

Returns:
the service pack

getServices

public java.util.List getServices()
Deprecated. 
Standard getter.

Returns:
the list of services

getSource

public java.lang.String getSource()
Deprecated. 
Standard getter.

Returns:
the source (such as a file or directory)

getSuccessString

public java.lang.String[] getSuccessString()
Deprecated. 
Standard getter.

Returns:
the String array used to check for success

getTarget

public java.lang.String getTarget()
Deprecated. 
Standard getter for a target directory

Returns:
the target

getTargetString

public java.lang.String getTargetString()
Deprecated. 
Standard getter.

Returns:
the target string

getTimeOut_Sec

public int getTimeOut_Sec()
Deprecated. 
Standard getter.

Returns:
the delay before time out, measured in seconds

getUserName

public java.lang.String getUserName()
Deprecated. 
Standard getter.

Returns:
the user name

getVariableName

public java.lang.String getVariableName()
Deprecated. 
Standard getter.

Returns:
the variable name

setAppend

public void setAppend(boolean data)
Deprecated. 
Standard setter.

Parameters:
data - a boolean representing whether or not data should be appended

setChmodValue

public void setChmodValue(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the required chmod value

setCommand

public void setCommand(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the required command value

setFailString

public void setFailString(java.lang.String[] data)
Deprecated. 
Standard setter.

Parameters:
data - an Array of Strings that the application uses to indicate failure

setFailString

public void setFailString(java.util.Vector data)
Deprecated. 
Standard setter.

Parameters:
data - a Vector of Strings that the application uses to indicate failure

setFileName

public void setFileName(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the required file name

setGrepFileName

public void setGrepFileName(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the name of the file to be grepped

setGrepString

public void setGrepString(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the string to be grepped

setGroupName

public void setGroupName(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the required group name value

setInstallSuccessStatus

public void setInstallSuccessStatus(boolean data)
Deprecated. 
Standard setter.

Parameters:
data - a boolean indicating the install status

setInterval_Sec

public void setInterval_Sec(int data)
Deprecated. 
Standard setter.

Parameters:
data - the time interval in seconds

setJarFile

public void setJarFile(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the jar file name

setKey

public void setKey(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the required key

setKeyValue

public void setKeyValue(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the required key value

setLogFileDir

public void setLogFileDir(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the directory of the required log file

setLogFileName

public void setLogFileName(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the name of the required log file

setMessage

public void setMessage(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the required message

setNewResponseFileValue

public void setNewResponseFileValue(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the new response file value

setNewSubstring

public void setNewSubstring(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the new substring value

setOldSubstring

public void setOldSubstring(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the old substring value

setPassword

public void setPassword(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the password value

setPath

public void setPath(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the desired path

setPortNumber

public void setPortNumber(int data)
Deprecated. 
Standard setter.

Parameters:
data - the port number value

setPrivileges

public void setPrivileges(java.util.List data)
Deprecated. 
Standard setter.

Parameters:
data - a list of recognized privileges

setPropertyKeyType

public void setPropertyKeyType(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the property key type

setRegistryKey

public void setRegistryKey(int data)
Deprecated. 
Standard setter.

Parameters:
data - a registry key value

setRegistryStringValue

public void setRegistryStringValue(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - a registry key string

setRegistrySubKey

public void setRegistrySubKey(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the name of a registry subkey

setResponseFileName

public void setResponseFileName(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the name of a response file

setRPMArray

public void setRPMArray(java.lang.Object[] data)
Deprecated. 
Standard setter.

Parameters:
data - the desired RPM names

setRPMArray

public void setRPMArray(java.lang.String[] data)
Deprecated. 
Standard setter.

Parameters:
data - the desired RPM names

setRPMArray

public void setRPMArray(java.util.Vector data)
Deprecated. 
Standard setter.

Parameters:
data - the desired RPM names

setRpmPackage

public void setRpmPackage(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the desired RPM package name

setSection

public void setSection(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the desired section value

setServicePack

public void setServicePack(int data)
Deprecated. 
Standard setter.

Parameters:
data - the service pack level

setServices

public void setServices(java.util.List data)
Deprecated. 
Standard setter.

Parameters:
data - a list of services - use service name from registry or service's properties panel

setSizeKiloBytes

public void setSizeKiloBytes(int data)
Deprecated. 
Standard setter.

Parameters:
data - the size in kilobytes

setSizeMegaBytes

public void setSizeMegaBytes(int data)
Deprecated. 
Standard setter.

Parameters:
data - the size in megabytes

setSource

public void setSource(java.lang.String data)
Deprecated. 
Standard setter for a source file or directory. Whether a file or directory is specified depends on the method that will be using this value. For example, SupportHelper.copyDirectory(SupportBase s) requires a directory and SupportHelper.fileCopy(SupportBase s) requires a file name or file path.

Parameters:
data - the source value

setSuccessString

public void setSuccessString(java.lang.String[] data)
Deprecated. 
Standard setter.

Parameters:
data - an array of success string values

setSuccessString

public void setSuccessString(java.util.Vector data)
Deprecated. 
Standard setter.

Parameters:
data - an array of success string values

setTarget

public void setTarget(java.lang.String data)
Deprecated. 
Standard setter for a target directory.

Parameters:
data - the target value

setTargetString

public void setTargetString(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the target string value

setTimeOut_Sec

public void setTimeOut_Sec(int data)
Deprecated. 
Standard setter.

Parameters:
data - the time out in seconds

setUserName

public void setUserName(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the user name

setVariableName

public void setVariableName(java.lang.String data)
Deprecated. 
Standard setter.

Parameters:
data - the variable name

setFind

public void setFind(java.lang.String findString)
Deprecated. 
Standard setter.

Parameters:
findString - the string that will be matched during a find and replace operation

setFind

public void setFind(java.lang.String findString,
                    boolean ignoreCase,
                    boolean ignoreWhitespace)
Deprecated. 
Standard setter.

Parameters:
findString - the string that will be matched during a find and replace operation
ignoreCase - indicates whether text case will be considered when matching this string
ignoreWhitespace - indicates whether whitespace will be considered when matching this string

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)
Deprecated. 
Standard setter.

Parameters:
ignoreCase - indicates whether text case will be considered when matching this string

setReplace

public void setReplace(java.lang.String replaceString)
Deprecated. 
Standard setter.

Parameters:
replaceString - the string that will be substituted for any mached lined during a find and replace operation

setBackupFindAndReplace

public void setBackupFindAndReplace(boolean backup)
Deprecated. 
Standard setter.

Parameters:
backup - indicates whether a backup file should be created as part of a find and replace operation

setLocale

public void setLocale(java.util.Locale _locale)
Deprecated. 
Sets the Locale for a translatable resource.

Parameters:
_locale - the Locale to be used

setMessageSubstitutionString

public void setMessageSubstitutionString(java.lang.String _subs)
Deprecated. 
Sets the comma delimited set of message subtitutions.

Parameters:
_subs - The string to be substituted into the message

setMessageSubstitutionStringArray

public void setMessageSubstitutionStringArray(java.lang.String[] _tmpArray)
Deprecated. 
Sets the Array of message subtitutions.

Parameters:
_tmpArray - The array of strings to be substituted into the message

setMessageResourcePath

public void setMessageResourcePath(java.lang.String _path)
Deprecated. 
Sets the dotted classpath of a translated message's ResourceBundle .

Parameters:
_path - the dotted classpath

setApplicationVersion

public void setApplicationVersion(java.lang.String _applicationVersion)
Deprecated. 
Sets the application version

Parameters:
_applicationVersion - the Strin representation of the version

getFind

public java.lang.String getFind()
Deprecated. 
Standard getter.

Returns:
a String to be used for matching lines in a find/replace operation

getReplace

public java.lang.String getReplace()
Deprecated. 
Standard getter.

Returns:
a String that will be substituted for any matches in a find/replace operation

getIgnoreCase

public boolean getIgnoreCase()
Deprecated. 
Standard getter.

Returns:
a boolean that determines whether to ignore case while performing a find/replace operation

getIgnoreWhitespace

public boolean getIgnoreWhitespace()
Deprecated. 
Standard getter.

Returns:
a boolean that determines whether to ignore whitespace while performing a find/replace operation

getBackupFindAndReplace

public boolean getBackupFindAndReplace()
Deprecated. 
Standard getter.

Returns:
a boolean indicating if we should create a backup file as part of a find/replace operation

getLocale

public java.util.Locale getLocale()
Deprecated. 
Retrieves the Locale of a translatable resource.

Returns:
Locale

getSingleSubstitutionString

public java.lang.String getSingleSubstitutionString(java.lang.String key,
                                                    java.lang.String substitution)
Deprecated. 
Retrieves a translated message for the given key and single substitution parameter.

The method setMainResources() must be called before calling this method.

Parameters:
key - the key to look for
substitution - the replacement value
Returns:
String

getResourceString

public java.lang.String getResourceString(java.lang.String key,
                                          java.lang.String[] substitutions)
Deprecated. 
Retrieves a translated message for the given key and substitution parameters.

The method setMainResources() must be called before calling this method.

Overrides:
getResourceString in class com.ibm.jsdt.common.Base
Parameters:
key - the key to look for
substitutions - the replacement values in order
Returns:
String

getMessageSubstitutionStringArray

public java.lang.String[] getMessageSubstitutionStringArray()
Deprecated. 
Retrieves the String array of message substitution paramaters.

Returns:
String

getMessageResourcePath

public java.lang.String getMessageResourcePath()
Deprecated. 
Retrieves the dotted classpath of a translatable resource's ResourceBundle

Returns:
String

getApplicationVersion

public java.lang.String getApplicationVersion()
Deprecated. 
Retrieves the application version

Returns:
String

setCommandEnvironmentArray

public void setCommandEnvironmentArray(java.lang.String[] env)
Deprecated. 
Sets the environment for a system command line invocation.

Parameters:
env - String array of environment variable settings

getCommandEnvironmentArray

public java.lang.String[] getCommandEnvironmentArray()
Deprecated. 
Gets the environment for a system command line invocation.

Returns:
String env array

setCommandLaunchDirectory

public void setCommandLaunchDirectory(java.lang.String launchDirectoryPath)
Deprecated. 
Sets the working directory for a command line invocation.

Parameters:
launchDirectoryPath - the name of the working directory

getCommandLaunchDirectory

public java.lang.String getCommandLaunchDirectory()
Deprecated. 
Gets the working directory for a command line invocation.

Returns:
String

setCommandLogging

public void setCommandLogging(boolean shouldLog)
Deprecated. 
Sets an indicator as to whether or not this command should be traced/logged.

Parameters:
shouldLog - a boolean

shouldLogCommand

public boolean shouldLogCommand()
Deprecated. 
Gets an indicator as to whether or not this command should be traced/logged.

Returns:
boolean

getCommandArray

public java.lang.String[] getCommandArray()
Deprecated. 
Retrieves the array of command tokens.

Returns:
String[]

setCommandArray

public void setCommandArray(java.lang.String[] args)
Deprecated. 
Sets the array of command tokens.

Parameters:
args - String[] of command arguments

getIbmNsiProperties

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

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.

Returns:
Properties

getVpdUid

public java.lang.String getVpdUid()
Deprecated. 
Returns the UID of the product for which the VPD property value is sought.

Returns:
String The vpdUid to get.

setVpdUid

public void setVpdUid(java.lang.String vpdUid)
Deprecated. 
Sets the uid of the product for which the VPD property value is sought.

Parameters:
vpdUid - String The vpdUid to set.

getVpdEndPipe

public int getVpdEndPipe()
Deprecated. 
Retrieves the number of the last pipe character that delimits the sought VPD property.

Returns:
int the vpdStartPipe.

setVpdEndPipe

public void setVpdEndPipe(int vpdEndPipe)
Deprecated. 
Sets the number of the last pipe character that delimits the sought VPD property.

Parameters:
vpdEndPipe - int the vpdStartPipe.

getVpdStartPipe

public int getVpdStartPipe()
Deprecated. 
Retrieves the number of the first pipe character that delimits the sought VPD property.

Returns:
int the vpdStartPipe.

setVpdStartPipe

public void setVpdStartPipe(int vpdStartPipe)
Deprecated. 
Sets the number of the first pipe character that delimits the sought VPD property.

Parameters:
vpdStartPipe -

getVersion

public java.lang.String getVersion()
Deprecated. 
Retrieves the application version.

Returns:
String

setVersion

public void setVersion(java.lang.String _version)
Deprecated. 
Sets the application version.

Parameters:
_version - String version number

getCompareVersion

public java.lang.String getCompareVersion()
Deprecated. 
Retrieves the application version to compare.

Returns:
String

setCompareVersion

public void setCompareVersion(java.lang.String cVersion)
Deprecated. 
Sets the application version to compare.

Parameters:
cVersion - String version to compare

getDeploymentPackageJarName

public java.lang.String getDeploymentPackageJarName()
Deprecated. 
Retrieves the deployment package jar file name.

The value is retrieved as a non-translatable property.

Returns:
String

getAgentRelease

public java.lang.String getAgentRelease()
Deprecated. 
Retrieves the release of the IBM Installation Agent code base.

For example, it would return 2.1.0.0, not 3.1.0.0 for IR 2.1.

It will return null for releases prior to IR 2.1 .

NOTE: This is not the same as the version number of the IBM Installation Agent.

Returns:
String

getIbmnsiPropertyKeyPrefix

public java.lang.String getIbmnsiPropertyKeyPrefix()
Deprecated. 
Retrieves the appropriate key prefix for a value in the ibmnsi.properites file.

For release IR 2.1 and later, the prefix is the application ID. Earlier releases used the deployment package jar file name.

Returns:
String

shouldWaitForOutput

public boolean shouldWaitForOutput()
Deprecated. 
Indicates whether or not a pause is needed to capture a system command call's output in its entirety.

Returns:
boolean waitForOutput.

setWaitForOutput

public void setWaitForOutput(boolean _waitForOutput)
Deprecated. 
Sets an indicator as to whether or not a pause is needed to caputure a system command call's output in its entirety.

Parameters:
_waitForOutput - boolean

getFileTextSearchLength

public int getFileTextSearchLength()
Deprecated. 
Sets the length of a file text (sub)String to be searched.

Returns:
int the length or number of characters.

setFileTextSearchLength

public void setFileTextSearchLength(int _fileTextSearchLength)
Deprecated. 
Gets the length of a file text (sub)String to be searched.

Parameters:
_fileTextSearchLength - int the length or number of characters.

getFileTextStartIndex

public int getFileTextStartIndex()
Deprecated. 
Sets the index or starting position in the file text String from which to delineate a substring.

This may be zero, in which case the entire file text String is the "substring".

Returns:
int the index of the starting position in the file text string.

setFileTextStartIndex

public void setFileTextStartIndex(int _fileTextStartIndex)
Deprecated. 
Gets the index or starting position in the file text String from which to delineate a substring.

This may be zero, in which case the entire file text String is the "substring".

Parameters:
_fileTextStartIndex - int the index of the starting position in the file text String.

getMainResources

public java.lang.String getMainResources()
Deprecated. 
Get the name of the main ResourceBundle.

Note that this is a fully qualified package name without the file extension.

Overrides:
getMainResources in class com.ibm.jsdt.common.Base
Returns:
the ResourceBundle in use

setMainResources

public void setMainResources(java.lang.String myResources)
Deprecated. 
Set the name of the main ResourceBundle.

Note that this is a fully qualified package name without the file extension.

Overrides:
setMainResources in class com.ibm.jsdt.common.Base
Parameters:
myResources - the ResourceBundle to use

getResourceString

public java.lang.String getResourceString(java.lang.String key)
Deprecated. 
Get a string from the ResourceBundle using specified given key.

This method provides a signature for retrieving a string from a specific bundle. This is typically done when a bean needs to get a string that is not in its default bundle.

By default, the bean tries to get the string in the locale of the server. If the server locale is undefined (for example, at design time) the default locale is used.

Overrides:
getResourceString in class com.ibm.jsdt.common.Base
Parameters:
key - the String used as the look-up key

getResourceString

public java.lang.String getResourceString(java.lang.String key,
                                          java.lang.String parms)
Deprecated. 
Get a string for the given key and substution parameters

This method provides a signature for retrieving a string from a specific bundle in a specific locale. This is typically done when a bean needs to get a string that is not in the locale of the server.

Overrides:
getResourceString in class com.ibm.jsdt.common.Base
Parameters:
key - the String used as the look-up key
substitutions - the replacement values in order
Returns:
String

getResourceString

public java.lang.String getResourceString(java.lang.String key,
                                          java.util.Locale loc)
Deprecated. 
Get a string for the given key and locale.

This method provides a signature for retrieving a string from a specific bundle in a specific locale. This is typically done when a bean needs to get a string that is not in the locale of the server.

Overrides:
getResourceString in class com.ibm.jsdt.common.Base
Parameters:
key - the String used as the look-up key
loc - the desired Locale of the result
Returns:
String

getResourceString

public java.lang.String getResourceString(java.lang.String key,
                                          java.lang.String parms,
                                          java.util.Locale loc)
Deprecated. 
Get a string for the given key, substitution paramaters, and locale.

This method provides a signature for retrieving a string from a specific bundle in a specific locale. This is typically done when a bean needs to get a string that is not in the locale of the server.

Overrides:
getResourceString in class com.ibm.jsdt.common.Base
Parameters:
key - the String used as the look-up key
parms - the replacement values in order
loc - the desired Locale of the result
Returns:
String

getResourceStringArray

public java.lang.String[] getResourceStringArray(java.lang.String stem)
Deprecated. 
Gets an array of String values from a ResourceBundle. The keys in the bundle must be consist of the stem plus a numeric suffix. The numeric suffixes must be sequential and zero based. The array index will equal the numeric suffix.

Overrides:
getResourceStringArray in class com.ibm.jsdt.common.Base
Parameters:
stem - String that is the base key name without the numeric suffix.
Returns:
a String Array containing the values for each key with the given key stem.

getResourceStringArray

public java.lang.String[] getResourceStringArray(java.lang.String stem,
                                                 java.util.Locale loc)
Deprecated. 
Gets an array of String values from a ResourceBundle. The keys in the bundle must be consist of the stem plus a numeric suffix. The numeric suffixes must be sequential and zero based. The array index will equal the numeric suffix.

Overrides:
getResourceStringArray in class com.ibm.jsdt.common.Base
Parameters:
stem - String that is the base key name without the numeric suffix.
loc - Locale of the ResourceBundle.
Returns:
a String Array containg the values for each key with the given key stem.

getBackLevelJsdtMessage

protected java.lang.String getBackLevelJsdtMessage(java.lang.String methodName)
Deprecated. 
Obtains a back-level version message when an unavailble new API is invoked.

Type Parameters:
code - String methodName
Returns:
String

getDeploymentWizardSpecificationVersion

public java.lang.String getDeploymentWizardSpecificationVersion()
Deprecated. 
Retrieves the Specification-version of the Deployment wizard.

It will return null for Specification-versions prior to 2.1.1.0

Returns:
String

getBackLevelDeployerMessage

protected java.lang.String getBackLevelDeployerMessage(java.lang.String methodName,
                                                       java.lang.String sinceVersion)
Deprecated. 
Obtains a back-level version message when an unavailble new API is invoked that is dependent on the version of the Deployment wizard.

Type Parameters:
code - String methodName
Returns:
String the earliest compatible version the deployer.

getApplicationId

public java.lang.String getApplicationId()
Deprecated. 
Returns the application Id.

Returns:
String

setApplicationId

public void setApplicationId(java.lang.String applicationId)
Deprecated. 
Sets the application Id.

Type Parameters:
code - String

getTaskId

public java.lang.String getTaskId()
Deprecated. 
Returns the task Id.

Returns:
String

setTaskId

public void setTaskId(java.lang.String taskId)
Deprecated. 
Sets the task Id.

Type Parameters:
code - String

getVariableKeyword

public java.lang.String getVariableKeyword()
Deprecated. 
Returns the variableKeyword.

Returns:
String

setVariableKeyword

public void setVariableKeyword(java.lang.String variableKeyword)
Deprecated. 
Sets the variableKeyword.

Type Parameters:
code - String

getWindowsDrive

public java.lang.String getWindowsDrive()
Deprecated. 
Retrieves the windows drive which is a drive letter followed by a colon and a backslash.

Returns:
String .

setWindowsDrive

public void setWindowsDrive(java.lang.String windowsDrive)
Deprecated. 
Sets the windows drive letter.

A backslash is appended if one is not present.

Parameters:
w - String .

getTargetFileName

public java.lang.String getTargetFileName()
Deprecated. 
Retrieves the name of the file when it is copied to the new target location.

Returns:
String Returns the targetFileName.

setTargetFileName

public void setTargetFileName(java.lang.String targetFileName)
Deprecated. 
Sets the new name of the file that is being copied.

If nothing is specified the original file name will be used.

Parameters:
String - targetFileName

isLocalInteractive

public boolean isLocalInteractive()
Deprecated. 
Indicates whether or not the associated program launch command is for a local interactive program.

Returns:
boolean the isLocalInteractive

setLocalInteractive

public void setLocalInteractive(boolean isLocalInteractive)
Deprecated. 
The value specified indicates whether or not the associated program launch command is for a local interactive program.

Type Parameters:
code - boolean isLocalInteractive the isLocalInteractive to set

getOriginalResponseFileName

public java.lang.String getOriginalResponseFileName()
Deprecated. 
Returns:
the originalResponseFileName

setOriginalResponseFileName

public void setOriginalResponseFileName(java.lang.String originalResponseFileName)
Deprecated. 
Parameters:
originalResponseFileName - the originalResponseFileName to set