com.ibm.jsdt.support.installedproduct
Class ERConsoleInstalledProduct

java.lang.Object
  extended by com.ibm.jsdt.support.installedproduct.InstalledProduct
      extended by com.ibm.jsdt.support.installedproduct.ERConsoleInstalledProduct

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

public class ERConsoleInstalledProduct
extends InstalledProduct

Performs Express Runtime Console functionality on an installed instance of the product.


Field Summary
static java.lang.String AGENT_CONNECTION_ERROR
          Deprecated.  
static java.lang.String HOSTNAME_PORT_ENTRY
          Deprecated.  
static java.lang.String INST_PATH_REQ_PREFIX_MISSING
          Deprecated.  
static java.lang.String INVALID_CHAR_FOR_INST_PATH
          Deprecated.  
static java.lang.String INVALID_OS_FOR_GIVEN_HOST
          Deprecated.  
static java.lang.String ISC_RUNTIME_BASE_DIR
          Deprecated.  
static java.lang.String LOG_FILE_ME_DEPLOYMENT_DID_NOT_START_STRING
          Deprecated.  
static java.lang.String LOG_FILE_ME_FAILURE_STRING
          Deprecated.  
static java.lang.String LOG_FILE_ME_SUCCESS_STRING
          Deprecated.  
static java.lang.String LOG_FILE_ME_USERID_PASSWORD_INVALID
          Deprecated.  
static java.lang.String NO_MIDDLEWARE_INSTALLED
          Deprecated.  
static java.lang.String PRODUCT_VPD_PROPERTY_NAME
          Deprecated.  
static java.lang.String SOLUTION_ENABLER_DIR
          Deprecated.  
static java.lang.String WIN_DRIVE_LETTER_DOES_NOT_EXIST
          Deprecated.  
 
Constructor Summary
protected ERConsoleInstalledProduct(java.lang.String version, java.lang.String location)
          Deprecated. Constructs a new ERConsoleInstalledProduct containing the version and the location of the installed product.
 
Method Summary
 void addLeaveFilesOptionForManagementExtensionDeployments()
          Deprecated. Add the option to leave deployment files on the target machine for debugging purposes.
 int deployModuleIntoISC(java.lang.String moduleDirectoryName, java.lang.String iscAdminId, java.lang.String iscAdminPassword)
          Deprecated. Deploys modules into Integrated Solutions Console.
 boolean doThirdPartyModulesExistInISC()
          Deprecated. Searches for third party modules within the ISC installed by Express Runtime.
 java.lang.String getConsoleAgentPortNumberForLastDeployment()
          Deprecated. Searches the deployment wizard log file for the entry that displays the target host along with the console agent port number used.
 java.lang.String getConsoleSubDirectory()
          Deprecated. Returns The Express Runtime Console sub directory.
 java.lang.String getDeploymentWizardLog()
          Deprecated. Returns the absolute location of the deployment wizard log.
 java.lang.String getHttpPort()
          Deprecated. Get the http port.
 java.lang.String[] getInstallationLogFiles()
          Deprecated. Gets the installation log files.
 java.lang.String getInstalledLocation()
          Deprecated. Overrides super.getInstallationLocation() so that trailing slash is not returned.
static ERConsoleInstalledProduct getInstalledProduct(java.lang.String location)
          Deprecated. Returns an instance of ERConsoleInstalledProduct, if Express Runtime Console is installed on the system in the given location.
static ERConsoleInstalledProduct getInstalledProduct(SupportBase callerBase, java.lang.String location)
          Deprecated. Returns an instance of ERConsoleInstalledProduct if Express Runtime Console is installed on the system in the given location.
static ERConsoleInstalledProduct[] getInstalledProducts()
          Deprecated. Returns an instance of ERConsoleInstalledProduct if Express Runtime Console is installed on the system.
static ERConsoleInstalledProduct[] getInstalledProducts(SupportBase callerBase)
          Deprecated. Returns an instance of ERConsoleInstalledProduct if Express Runtime Console is installed on the system.
 java.lang.String getManagementExtensionDeploymentScript()
          Deprecated. Returns the absolute location of the script file used to deploy the management extension.
 java.lang.String getMESolutionName()
          Deprecated. Returns the absolute location of the solution name used to deploy the management extensions.
 java.lang.String getTaskFileNameForDeployment()
          Deprecated. Returns the absolute location of the task file used to deploy the management extensions.
 boolean isISCInstalledByER()
          Deprecated. Determines if the ISC installed was performed by the Express Runtime Console installation.
 boolean isManagementExtensionDeploymentSuccessful()
          Deprecated. Determines if the management extension deployment was successful.
 boolean isManagementExtensionDeploymentSuccessful(int startSearchingPosition)
          Deprecated. Determines if the management extension deployment was successful.
 void removeLeaveFilesOptionForManagementExtensionDeployments()
          Deprecated. Remove the option to leave deployment files on the target machine for debugging purposes.
 boolean restartConsole()
          Deprecated. Controls the restart of the ER Console.
 int runMEDeployment()
          Deprecated. Runs the management extension install.
 boolean searchForStringInDeploymentWizardLog(java.lang.String searchString)
          Deprecated. Searches the deployment wizard log file for a given string.
 boolean searchForStringInDeploymentWizardLog(java.lang.String searchString, int startSearchingPosition)
          Deprecated. Searches the deployment wizard log file for a given string.
 boolean startConsole(java.lang.String commandDir)
          Deprecated. Starts the ER Console server, if it is currently not running.
 boolean statusConsole()
          Deprecated. Determines whether the ER Console is currently running.
 boolean stopConsole(java.lang.String commandDir)
          Deprecated. Stops the ER Console server, if it is currently running.
 
Methods inherited from class com.ibm.jsdt.support.installedproduct.InstalledProduct
compareVersion, getActualSupportBase, getInstalledProduct, getInstalledProducts, getInstalledVersion, getSupportBase, grepRPM, setInstalledLocation, setInstalledVersion, setSupportBase, trimVersionToNVersionPlaces
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ISC_RUNTIME_BASE_DIR

public static final java.lang.String ISC_RUNTIME_BASE_DIR
Deprecated. 

PRODUCT_VPD_PROPERTY_NAME

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

SOLUTION_ENABLER_DIR

public static final java.lang.String SOLUTION_ENABLER_DIR
Deprecated. 

LOG_FILE_ME_SUCCESS_STRING

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

LOG_FILE_ME_FAILURE_STRING

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

LOG_FILE_ME_DEPLOYMENT_DID_NOT_START_STRING

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

LOG_FILE_ME_USERID_PASSWORD_INVALID

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

WIN_DRIVE_LETTER_DOES_NOT_EXIST

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

INST_PATH_REQ_PREFIX_MISSING

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

INVALID_CHAR_FOR_INST_PATH

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

INVALID_OS_FOR_GIVEN_HOST

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

AGENT_CONNECTION_ERROR

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

HOSTNAME_PORT_ENTRY

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

NO_MIDDLEWARE_INSTALLED

public static final java.lang.String NO_MIDDLEWARE_INSTALLED
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

ERConsoleInstalledProduct

protected ERConsoleInstalledProduct(java.lang.String version,
                                    java.lang.String location)
Deprecated. 
Constructs a new ERConsoleInstalledProduct containing the version and the location of the installed product.

Parameters:
version - The version of Express Runtime Console installed.
location - The installation location of Express Runtime Console.
Method Detail

getInstalledProduct

public static ERConsoleInstalledProduct getInstalledProduct(java.lang.String location)
Deprecated. 
Returns an instance of ERConsoleInstalledProduct, if Express Runtime Console is installed on the system in the given location.

Parameters:
location - The install location of Express Runtime console.
Returns:
The instance of Express Runtime console found on the system.

getInstalledProduct

public static ERConsoleInstalledProduct getInstalledProduct(SupportBase callerBase,
                                                            java.lang.String location)
Deprecated. 
Returns an instance of ERConsoleInstalledProduct if Express Runtime Console is installed on the system in the given location.

Parameters:
callerBase - The instance of SupportBase to use.
location - The install location of Express Runtime console.
Returns:
The instance of Express Runtime console found on the system.

getInstalledProducts

public static ERConsoleInstalledProduct[] getInstalledProducts()
Deprecated. 
Returns an instance of ERConsoleInstalledProduct if Express Runtime Console is installed on the system.

Returns:
The instance of Express Runtime console found on the system.

getInstalledProducts

public static ERConsoleInstalledProduct[] getInstalledProducts(SupportBase callerBase)
Deprecated. 
Returns an instance of ERConsoleInstalledProduct if Express Runtime Console is installed on the system.

Parameters:
callerBase - The instance of SupportBase to use.
Returns:
The instance of Express Runtime console found on the system.

getConsoleSubDirectory

public java.lang.String getConsoleSubDirectory()
Deprecated. 
Returns The Express Runtime Console sub directory.

Returns:
The sub directory based on the version of the product installed.

isISCInstalledByER

public boolean isISCInstalledByER()
Deprecated. 
Determines if the ISC installed was performed by the Express Runtime Console installation.

Returns:
True if ISC was laid down by Express Runtime. False if ISC was not laid down by Express Runtime.

doThirdPartyModulesExistInISC

public boolean doThirdPartyModulesExistInISC()
Deprecated. 
Searches for third party modules within the ISC installed by Express Runtime. This method is currently only supported if Express Runtime Console version is 2.1.

Returns:
Return true if third party modules exist in ER 2.1 ISC Return false if third party modules do not exist.

getInstallationLogFiles

public java.lang.String[] getInstallationLogFiles()
Deprecated. 
Gets the installation log files. Currently this method is only supported for Express Runtime Console version 2.2.x

Returns:
A string array of absolute paths of the log files.

getHttpPort

public java.lang.String getHttpPort()
Deprecated. 
Get the http port. This method is currently supported for Express Runtime Console version 2.2.x only.

Returns:
The port number.

deployModuleIntoISC

public int deployModuleIntoISC(java.lang.String moduleDirectoryName,
                               java.lang.String iscAdminId,
                               java.lang.String iscAdminPassword)
Deprecated. 
Deploys modules into Integrated Solutions Console. Currently this method is supported for Express Runtime Console version 2.2.x only.

Parameters:
moduleDirectoryName - The directory name of the module to deploy.
iscAdminId - ISC administrator ID
iscAdminPassword - ISC password
Returns:
The return code from running the ISCDeploy command.

getTaskFileNameForDeployment

public java.lang.String getTaskFileNameForDeployment()
Deprecated. 
Returns the absolute location of the task file used to deploy the management extensions. Currently this method is supported for Express Runtime Console version 2.2.x only.

Returns:
The absolute location with the task file name.

getMESolutionName

public java.lang.String getMESolutionName()
Deprecated. 
Returns the absolute location of the solution name used to deploy the management extensions. Currently this method is supported for Express Runtime Console version 2.2.x only.

Returns:
The absolute location with the solution name.

getDeploymentWizardLog

public java.lang.String getDeploymentWizardLog()
Deprecated. 
Returns the absolute location of the deployment wizard log. Currently this method is supported for Express Runtime Console version 2.2.x only.

Returns:
The absolute location with the solution name.

getManagementExtensionDeploymentScript

public java.lang.String getManagementExtensionDeploymentScript()
Deprecated. 
Returns the absolute location of the script file used to deploy the management extension.

Returns:
The absolute location with the script name.

runMEDeployment

public int runMEDeployment()
Deprecated. 
Runs the management extension install. Currently this method is supported for Express Runtime Console version 2.2.x only.

Returns:
-1 If the script is not run or an integer code indicating that the script was run.

getInstalledLocation

public java.lang.String getInstalledLocation()
Deprecated. 
Overrides super.getInstallationLocation() so that trailing slash is not returned.

Overrides:
getInstalledLocation in class InstalledProduct
Returns:
The installed location of Express Runtime Console.

isManagementExtensionDeploymentSuccessful

public boolean isManagementExtensionDeploymentSuccessful()
Deprecated. 
Determines if the management extension deployment was successful. The determination is made by searching in the deployment wizard log for any errors.

Returns:
True if the deployment is successful, otherwise false.

isManagementExtensionDeploymentSuccessful

public boolean isManagementExtensionDeploymentSuccessful(int startSearchingPosition)
Deprecated. 
Determines if the management extension deployment was successful. The determination is made by searching in the deployment wizard log for any errors.

Parameters:
startSearchingPosition - The start position of the log file to begin searching.
Returns:
True if the deployment is successful, otherwise false.

searchForStringInDeploymentWizardLog

public boolean searchForStringInDeploymentWizardLog(java.lang.String searchString)
Deprecated. 
Searches the deployment wizard log file for a given string.

Parameters:
searchString - The string to search for.
Returns:
True if the string is found, otherwise false.

searchForStringInDeploymentWizardLog

public boolean searchForStringInDeploymentWizardLog(java.lang.String searchString,
                                                    int startSearchingPosition)
Deprecated. 
Searches the deployment wizard log file for a given string.

Parameters:
searchString - The string to search for.
startSearchingPosition - The position of the log file to begin search
Returns:
True if the string is found, otherwise false.

getConsoleAgentPortNumberForLastDeployment

public java.lang.String getConsoleAgentPortNumberForLastDeployment()
Deprecated. 
Searches the deployment wizard log file for the entry that displays the target host along with the console agent port number used. Returns the last entry port number.

Returns:
The console agent port number for the last deployment.

addLeaveFilesOptionForManagementExtensionDeployments

public void addLeaveFilesOptionForManagementExtensionDeployments()
Deprecated. 
Add the option to leave deployment files on the target machine for debugging purposes.


removeLeaveFilesOptionForManagementExtensionDeployments

public void removeLeaveFilesOptionForManagementExtensionDeployments()
Deprecated. 
Remove the option to leave deployment files on the target machine for debugging purposes.


restartConsole

public boolean restartConsole()
Deprecated. 
Controls the restart of the ER Console.

Returns:
True if ER Console is successfully restarted, else return False.

statusConsole

public boolean statusConsole()
Deprecated. 
Determines whether the ER Console is currently running.

Returns:
True if the ER Console is running. False if the ER Console is not running.

stopConsole

public boolean stopConsole(java.lang.String commandDir)
Deprecated. 
Stops the ER Console server, if it is currently running.

Parameters:
commandDir - The directory path in which the command to run can be found.
Returns:
True if the ER Console has stopped running. False if the ER Console has not stopped running.

startConsole

public boolean startConsole(java.lang.String commandDir)
Deprecated. 
Starts the ER Console server, if it is currently not running.

Parameters:
commandDir - The directory path in which the command to run can be found.
Returns:
True if the ER Console was started successfully. False if the ER Console was not started successfully.