IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.product
Class WASSystem

java.lang.Object
  extended by com.ibm.websphere.product.WASSystem

public class WASSystem
extends java.lang.Object

This class provides an interface into the WebSphere family product install location information.

Version:
8.0

Method Summary
 java.lang.String[] getAllInstallPackageLocations()
          Returns all cached Websphere family product install locations.
 java.lang.String[] getInstallPackageLocationsByProductID(java.lang.String sProductID)
          Returns cached install locations based on product ID.
 java.lang.String getNIFRegistryFile()
          IBM WEBSPHERE INTERNAL USE ONLY.
 java.lang.String[] getNonCachedAllInstallPackageLocations()
          Returns all Websphere family product install locations.
 java.lang.String[] getNonCachedInstallPackageLocationsByProductID(java.lang.String sProductID)
          Returns Websphere family product install locations by product ID.
 java.lang.String[] getNonCachedWASLocations()
          Returns IBM Websphere Application Server install locations.
 java.lang.String[] getWASLocations()
          Returns all IBM WebSphere Application Server install locations.
 java.lang.String getWASRegistryFile()
          IBM WEBSPHERE INTERNAL USE ONLY.
static WASSystem getWASSystemInstance()
          Gets an instance of WASSystem.
static WASSystem getWASSystemInstance(java.lang.String sRegistryFile)
          Gets an instance of WASSystem, depending on the registry file supplied.
protected  java.lang.String getWindowsSystemEnv(java.lang.String sEnvName)
          IBM WEBSPHERE INTERNAL USE ONLY.
static java.lang.String normalizePathNoEndingSlash(java.lang.String sPath)
          IBM WEBSPHERE INTERNAL USE ONLY.
 void print()
          Print cached install locations of all IBM Websphere family product from the WASSystem instance.
 void setNIFRegistryFile(java.lang.String sNIFRegistryFile)
          IBM WEBSPHERE INTERNAL USE ONLY.
 void setWASLocations(java.lang.String[] saWASLocations)
          IBM WEBSPHERE INTERNAL USE ONLY.
 void setWASRegistryFile(java.lang.String sWASRegistryFile)
          IBM WEBSPHERE INTERNAL USE ONLY.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getWASSystemInstance

public static WASSystem getWASSystemInstance()
Gets an instance of WASSystem. This instance contains information from all IBM WebSphere Application Server install registries.

Returns:
The instance of the WASSystem.

getWASSystemInstance

public static WASSystem getWASSystemInstance(java.lang.String sRegistryFile)
Gets an instance of WASSystem, depending on the registry file supplied.

Parameters:
sRegistryFile - The IBM WebSphere Application Server install registry file location.

Returns:
The instance of the WASSystem.

getNIFRegistryFile

public java.lang.String getNIFRegistryFile()
IBM WEBSPHERE INTERNAL USE ONLY. Gets the NIF registry file full path.

Returns:
the NIF registry file full path.

setNIFRegistryFile

public void setNIFRegistryFile(java.lang.String sNIFRegistryFile)
IBM WEBSPHERE INTERNAL USE ONLY. Sets the NIF registry file full path.

Parameters:
sNIFRegistryFile - The WAS registry file full path.

getWASRegistryFile

public java.lang.String getWASRegistryFile()
IBM WEBSPHERE INTERNAL USE ONLY. Gets the WAS registry file full path.

Returns:
the WAS registry file full path.

setWASRegistryFile

public void setWASRegistryFile(java.lang.String sWASRegistryFile)
IBM WEBSPHERE INTERNAL USE ONLY. Sets the WAS registry file full path.

Parameters:
sWASRegistryFile - The WAS registry file full path.

getWASLocations

public java.lang.String[] getWASLocations()
Returns all IBM WebSphere Application Server install locations.

Returns:
The install locations of IBM WebSphere Application Server.

setWASLocations

public void setWASLocations(java.lang.String[] saWASLocations)
IBM WEBSPHERE INTERNAL USE ONLY. This method is a no-op.


getAllInstallPackageLocations

public java.lang.String[] getAllInstallPackageLocations()
Returns all cached Websphere family product install locations.

Returns:
The cached install locations of all Websphere family products.

getInstallPackageLocationsByProductID

public java.lang.String[] getInstallPackageLocationsByProductID(java.lang.String sProductID)
Returns cached install locations based on product ID.

Returns:
The cached install locations based on product ID.

getNonCachedAllInstallPackageLocations

public java.lang.String[] getNonCachedAllInstallPackageLocations()
Returns all Websphere family product install locations.

Returns:
all Websphere family product install locations.

getNonCachedInstallPackageLocationsByProductID

public java.lang.String[] getNonCachedInstallPackageLocationsByProductID(java.lang.String sProductID)
Returns Websphere family product install locations by product ID.

Parameters:
sProductID - the product ID of the product of interest.

Returns:
Websphere family product install locations by product ID.

getNonCachedWASLocations

public java.lang.String[] getNonCachedWASLocations()
Returns IBM Websphere Application Server install locations.

Returns:
IBM Websphere Application Server install locations.

print

public void print()
Print cached install locations of all IBM Websphere family product from the WASSystem instance.


getWindowsSystemEnv

protected java.lang.String getWindowsSystemEnv(java.lang.String sEnvName)
IBM WEBSPHERE INTERNAL USE ONLY. Return the windows system environment variable values based on the input environment variable name.

Parameters:
sEnvName - The input environmental variable name.

Returns:
The windows system environment variable values based on the input environment variable name.

normalizePathNoEndingSlash

public static java.lang.String normalizePathNoEndingSlash(java.lang.String sPath)
IBM WEBSPHERE INTERNAL USE ONLY. Normalize the input path by replacing back slashes by forward slashes. The returning path does not ends with forward slash.

Parameters:
sPath - The input path.

Returns:
The normalized path which does not ends with forward slash.

IBM WebSphere Application ServerTM
Release 8