|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.jsdt.common.Base
com.ibm.jsdt.support.SupportBase
public abstract class SupportBase
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 |
---|
public static final java.lang.String copyright
protected static final java.lang.String sSLASH
public static java.lang.String sNEWLN
public static final java.lang.String ISMP_GLOBAL_PROPERTY
public static final java.lang.String ISMP_WIZARD_PROPERTY
public static final java.lang.String ISMP_PRODUCT_PROPERTY
public static final int PDC_DO_NOT_INSTALL
public static final int PDC_CANCEL_INSTALL
public static final int PDC_EXISTS
public static final int PDC_DOES_NOT_EXIST
public static final int SUCCESS
public static final int FAILURE
public static final int VPD_INSTALL_LOCATION_PIPE
public static final int VPD_VERSION_PIPE
public static final java.lang.String DEPLOYER_SPECIFICATION_VERSION_KEY
public static final java.lang.String SELECTED_TASK_NAMES_KEY
protected static final int VERSIONCHECKER_STAGE
protected static final int ENTRY_STAGE
protected static final int MAIN_STAGE
protected static final int EXIT_STAGE
public static final java.lang.String WINDOWS
public static final java.lang.String AIX
public static final java.lang.String LINUX_ON_POWER
public static final java.lang.String LINUX_X86_64
public static final java.lang.String LINUX_X86_32
public static final java.lang.String SUNOS
public static final java.lang.String HPUX
public static final java.lang.String OS400
protected java.lang.String path
protected java.lang.String fileName
protected java.lang.String jarName
protected java.lang.String registrySubKey
protected java.lang.String registryStringValue
protected java.lang.String grepFileName
protected java.lang.String grepString
protected java.lang.String find
protected java.lang.String replace
protected boolean backupFindAndReplace
protected boolean ignoreCase
protected boolean ignoreWhitespace
protected java.lang.String chmodValue
protected java.lang.String responseFileName
protected java.lang.String key
protected java.lang.String keyValue
protected java.lang.String logFileName
protected java.lang.String logFileDir
protected java.lang.String userName
protected java.lang.String groupName
protected java.lang.String password
protected java.lang.String message
protected java.lang.String newResponseFileValue
protected java.lang.String propType
protected java.lang.String propertyLogFileName
protected java.lang.String[] successString
protected java.lang.String[] failString
protected int registryKey
protected int portNumber
protected int servicePack
Constructor Detail |
---|
public SupportBase()
Method Detail |
---|
public void trace(java.lang.String text)
text
- - The text to be loggedjava.util.logging
public void trace(java.lang.Object[] objects, boolean ignore)
objects
- ignore
- java.util.logging
public void trace(java.lang.Object object)
object
- java.util.logging
public java.lang.String getNSIProperty(java.lang.String key)
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.
key
- the key to be queried
public SupportHelper getHelper()
SupportHelper
and returns it.
SupportHelper
public boolean getAppend()
boolean
representing whether or not data should be appendedpublic java.lang.String getChmodValue()
public java.lang.String getCommand()
public java.lang.String getPropertyLogFileName()
ibmnsi.properties
file. Once found, the name
is cached in the instance variable.
ibmnsi.properties
filepublic java.lang.String[] getFailString()
public java.lang.String getFileName()
public java.lang.String getGrepFileName()
public java.lang.String getGrepString()
String
to greppublic java.lang.String getGroupName()
public boolean getInstallSuccessStatus()
boolean
indicating the installation statuspublic int getInterval_Sec()
public java.lang.String getJarFile()
public int getKBSize()
public java.lang.String getKey()
public java.lang.String getKeyValue()
public java.lang.String getLogFileDir()
public java.lang.String getLogFileName()
public java.lang.String getMessage()
public java.lang.String getNewResponseFileValue()
public java.lang.String getNewSubstring()
public java.lang.String getOldSubstring()
public java.lang.String getPassword()
public java.lang.String getPath()
public int getPortNumber()
public java.util.List getPrivileges()
public java.lang.String getPropertyKeyType()
public int getRegistryKey()
public java.lang.String getRegistryStringValue()
public java.lang.String getRegistrySubKey()
public java.lang.String getResponseFileName()
public java.lang.Object[] getRPMArray()
public java.lang.String getRpmPackage()
public java.lang.String getSection()
public int getServicePack()
public java.util.List getServices()
public java.lang.String getSource()
public java.lang.String[] getSuccessString()
String
array used to check for successpublic java.lang.String getTarget()
public java.lang.String getTargetString()
public int getTimeOut_Sec()
public java.lang.String getUserName()
public java.lang.String getVariableName()
public void setAppend(boolean data)
data
- a boolean
representing whether or not data should be appendedpublic void setChmodValue(java.lang.String data)
data
- the required chmod valuepublic void setCommand(java.lang.String data)
data
- the required command valuepublic void setFailString(java.lang.String[] data)
data
- an Array
of String
s that the application uses to indicate failurepublic void setFailString(java.util.Vector data)
data
- a Vector
of String
s that the application uses to indicate failurepublic void setFileName(java.lang.String data)
data
- the required file namepublic void setGrepFileName(java.lang.String data)
data
- the name of the file to be greppedpublic void setGrepString(java.lang.String data)
data
- the string to be greppedpublic void setGroupName(java.lang.String data)
data
- the required group name valuepublic void setInstallSuccessStatus(boolean data)
data
- a boolean
indicating the install statuspublic void setInterval_Sec(int data)
data
- the time interval in secondspublic void setJarFile(java.lang.String data)
data
- the jar file namepublic void setKey(java.lang.String data)
data
- the required keypublic void setKeyValue(java.lang.String data)
data
- the required key valuepublic void setLogFileDir(java.lang.String data)
data
- the directory of the required log filepublic void setLogFileName(java.lang.String data)
data
- the name of the required log filepublic void setMessage(java.lang.String data)
data
- the required messagepublic void setNewResponseFileValue(java.lang.String data)
data
- the new response file valuepublic void setNewSubstring(java.lang.String data)
data
- the new substring valuepublic void setOldSubstring(java.lang.String data)
data
- the old substring valuepublic void setPassword(java.lang.String data)
data
- the password valuepublic void setPath(java.lang.String data)
data
- the desired pathpublic void setPortNumber(int data)
data
- the port number valuepublic void setPrivileges(java.util.List data)
data
- a list of recognized privilegespublic void setPropertyKeyType(java.lang.String data)
data
- the property key typepublic void setRegistryKey(int data)
data
- a registry key valuepublic void setRegistryStringValue(java.lang.String data)
data
- a registry key stringpublic void setRegistrySubKey(java.lang.String data)
data
- the name of a registry subkeypublic void setResponseFileName(java.lang.String data)
data
- the name of a response filepublic void setRPMArray(java.lang.Object[] data)
data
- the desired RPM namespublic void setRPMArray(java.lang.String[] data)
data
- the desired RPM namespublic void setRPMArray(java.util.Vector data)
data
- the desired RPM namespublic void setRpmPackage(java.lang.String data)
data
- the desired RPM package namepublic void setSection(java.lang.String data)
data
- the desired section valuepublic void setServicePack(int data)
data
- the service pack levelpublic void setServices(java.util.List data)
data
- a list of services - use service name from registry or service's properties panelpublic void setSizeKiloBytes(int data)
data
- the size in kilobytespublic void setSizeMegaBytes(int data)
data
- the size in megabytespublic void setSource(java.lang.String data)
data
- the source valuepublic void setSuccessString(java.lang.String[] data)
data
- an array of success string valuespublic void setSuccessString(java.util.Vector data)
data
- an array of success string valuespublic void setTarget(java.lang.String data)
data
- the target valuepublic void setTargetString(java.lang.String data)
data
- the target string valuepublic void setTimeOut_Sec(int data)
data
- the time out in secondspublic void setUserName(java.lang.String data)
data
- the user namepublic void setVariableName(java.lang.String data)
data
- the variable namepublic void setFind(java.lang.String findString)
findString
- the string that will be matched during a find and replace operationpublic void setFind(java.lang.String findString, boolean ignoreCase, boolean ignoreWhitespace)
findString
- the string that will be matched during a find and replace operationignoreCase
- indicates whether text case will be considered when matching this stringignoreWhitespace
- indicates whether whitespace will be considered when matching this stringpublic void setIgnoreCase(boolean ignoreCase)
ignoreCase
- indicates whether text case will be considered when matching this stringpublic void setReplace(java.lang.String replaceString)
replaceString
- the string that will be substituted for any mached lined during a find and replace operationpublic void setBackupFindAndReplace(boolean backup)
backup
- indicates whether a backup file should be created as part of a find and replace operationpublic void setLocale(java.util.Locale _locale)
Locale
for a translatable resource.
_locale
- the Locale
to be usedpublic void setMessageSubstitutionString(java.lang.String _subs)
_subs
- The string to be substituted into the messagepublic void setMessageSubstitutionStringArray(java.lang.String[] _tmpArray)
Array
of message subtitutions.
_tmpArray
- The array of strings to be substituted into the messagepublic void setMessageResourcePath(java.lang.String _path)
ResourceBundle
.
_path
- the dotted classpathpublic void setApplicationVersion(java.lang.String _applicationVersion)
_applicationVersion
- the Strin representation of the versionpublic java.lang.String getFind()
String
to be used for matching lines in a find/replace operationpublic java.lang.String getReplace()
String
that will be substituted for any matches in a find/replace operationpublic boolean getIgnoreCase()
boolean
that determines whether to ignore case while performing a find/replace operationpublic boolean getIgnoreWhitespace()
boolean
that determines whether to ignore whitespace while performing a find/replace operationpublic boolean getBackupFindAndReplace()
boolean
indicating if we should create a backup file as part of a find/replace operationpublic java.util.Locale getLocale()
Locale
of a
translatable resource.
Locale
public java.lang.String getSingleSubstitutionString(java.lang.String key, java.lang.String substitution)
The method setMainResources()
must be
called before calling this method.
key
- the key to look forsubstitution
- the replacement value
String
public java.lang.String getResourceString(java.lang.String key, java.lang.String[] substitutions)
The method setMainResources()
must be
called before calling this method.
getResourceString
in class com.ibm.jsdt.common.Base
key
- the key to look forsubstitutions
- the replacement values in order
String
public java.lang.String[] getMessageSubstitutionStringArray()
String
array
of message substitution paramaters.
String
public java.lang.String getMessageResourcePath()
ResourceBundle
String
public java.lang.String getApplicationVersion()
String
public void setCommandEnvironmentArray(java.lang.String[] env)
env
- String
array of environment variable settingspublic java.lang.String[] getCommandEnvironmentArray()
String
env arraypublic void setCommandLaunchDirectory(java.lang.String launchDirectoryPath)
launchDirectoryPath
- the name of the working directorypublic java.lang.String getCommandLaunchDirectory()
String
public void setCommandLogging(boolean shouldLog)
shouldLog
- a boolean
public boolean shouldLogCommand()
boolean
public java.lang.String[] getCommandArray()
String[]
public void setCommandArray(java.lang.String[] args)
args
- String[]
of command argumentspublic java.util.Properties getIbmNsiProperties()
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.
Properties
public java.lang.String getVpdUid()
String
The vpdUid to get.public void setVpdUid(java.lang.String vpdUid)
vpdUid
- String
The vpdUid to set.public int getVpdEndPipe()
int
the vpdStartPipe.public void setVpdEndPipe(int vpdEndPipe)
vpdEndPipe
- int
the vpdStartPipe.public int getVpdStartPipe()
int
the vpdStartPipe.public void setVpdStartPipe(int vpdStartPipe)
vpdStartPipe
- public java.lang.String getVersion()
String
public void setVersion(java.lang.String _version)
_version
- String
version numberpublic java.lang.String getCompareVersion()
String
public void setCompareVersion(java.lang.String cVersion)
cVersion
- String
version to comparepublic java.lang.String getDeploymentPackageJarName()
The value is retrieved as a non-translatable property.
String
public java.lang.String getAgentRelease()
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.
String
public java.lang.String getIbmnsiPropertyKeyPrefix()
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.
String
public boolean shouldWaitForOutput()
boolean
waitForOutput.public void setWaitForOutput(boolean _waitForOutput)
_waitForOutput
- boolean
public int getFileTextSearchLength()
int
the length or number of
characters.public void setFileTextSearchLength(int _fileTextSearchLength)
_fileTextSearchLength
- int
the length or number of
characters.public int getFileTextStartIndex()
This may be zero, in which case the entire file text String is the "substring".
int
the index of the starting
position in the file text string.public void setFileTextStartIndex(int _fileTextStartIndex)
This may be zero, in which case the entire file text String is the "substring".
_fileTextStartIndex
- int
the index of the starting
position in the file text String.public java.lang.String getMainResources()
ResourceBundle
.
Note that this is a fully qualified package name without the file extension.
getMainResources
in class com.ibm.jsdt.common.Base
ResourceBundle
in usepublic void setMainResources(java.lang.String myResources)
ResourceBundle
.
Note that this is a fully qualified package name without the file extension.
setMainResources
in class com.ibm.jsdt.common.Base
myResources
- the ResourceBundle
to usepublic java.lang.String getResourceString(java.lang.String key)
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.
getResourceString
in class com.ibm.jsdt.common.Base
key
- the String
used as the look-up keypublic java.lang.String getResourceString(java.lang.String key, java.lang.String parms)
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.
getResourceString
in class com.ibm.jsdt.common.Base
key
- the String
used as the look-up keysubstitutions
- the replacement values in order
String
public java.lang.String getResourceString(java.lang.String key, java.util.Locale loc)
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.
getResourceString
in class com.ibm.jsdt.common.Base
key
- the String
used as the look-up keyloc
- the desired Locale
of the result
String
public java.lang.String getResourceString(java.lang.String key, java.lang.String parms, java.util.Locale loc)
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.
getResourceString
in class com.ibm.jsdt.common.Base
key
- the String
used as the look-up keyparms
- the replacement values in orderloc
- the desired Locale
of the result
String
public java.lang.String[] getResourceStringArray(java.lang.String stem)
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.
getResourceStringArray
in class com.ibm.jsdt.common.Base
stem
- String
that is the base key name
without the numeric suffix.
String
Array
containing
the values for each key with the given key stem.public java.lang.String[] getResourceStringArray(java.lang.String stem, java.util.Locale loc)
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.
getResourceStringArray
in class com.ibm.jsdt.common.Base
stem
- String
that is the base key name
without the numeric suffix.loc
- Locale
of the
ResourceBundle
.
String
Array
containg
the values for each key with the given key stem.protected java.lang.String getBackLevelJsdtMessage(java.lang.String methodName)
code
- String methodName
String
public java.lang.String getDeploymentWizardSpecificationVersion()
It will return null
for Specification-versions
prior to 2.1.1.0
String
protected java.lang.String getBackLevelDeployerMessage(java.lang.String methodName, java.lang.String sinceVersion)
code
- String methodName
String
the earliest compatible version
the deployer.public java.lang.String getApplicationId()
String
public void setApplicationId(java.lang.String applicationId)
code
- String public java.lang.String getTaskId()
String
public void setTaskId(java.lang.String taskId)
code
- String public java.lang.String getVariableKeyword()
String
public void setVariableKeyword(java.lang.String variableKeyword)
code
- String public java.lang.String getWindowsDrive()
String
.public void setWindowsDrive(java.lang.String windowsDrive)
A backslash is appended if one is not present.
w
- String
.public java.lang.String getTargetFileName()
String
Returns the targetFileName.public void setTargetFileName(java.lang.String targetFileName)
If nothing is specified the original file name will be used.
String
- targetFileNamepublic boolean isLocalInteractive()
boolean
the isLocalInteractivepublic void setLocalInteractive(boolean isLocalInteractive)
code
- boolean isLocalInteractive the isLocalInteractive to setpublic java.lang.String getOriginalResponseFileName()
public void setOriginalResponseFileName(java.lang.String originalResponseFileName)
originalResponseFileName
- the originalResponseFileName to set
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |