com.ibm.websphere.product
Class WASProduct
- java.lang.Object
com.ibm.websphere.product.WASProduct
Deprecated. As of WAS 8.0, replaced by com.ibm.websphere.product.WASDirectory.
- public class WASProduct
- extends java.lang.Object
Field Summary
Modifier and Type | Field and Description |
---|---|
|
BACKUP_DIR_NAME
Deprecated. Default names for product directories.
|
|
BACKUP_DIR_PROPERTY_NAME
Deprecated. Constants for providing product directories.
|
|
backupDir
Deprecated.
|
|
backupDirName
Deprecated.
|
|
boundExceptions
Deprecated.
|
|
bundleIdMsg
Deprecated. The id of the message bundle use by WASProduct.
|
|
bundleIdText
Deprecated.
|
|
COMPONENT_TYPE
Deprecated. Typing constants for loading version info.
|
|
componentNames
Deprecated.
|
|
components
Deprecated.
|
|
CURRENT_VERSION_DIR_NAME
Deprecated. Default names for product directories.
|
|
DEFAULT_TMP_DIR_NAME
Deprecated. Default names for product directories.
|
|
DTD_DIR_NAME
Deprecated. Default names for product directories.
|
|
DTD_DIR_PROPERTY_NAME
Deprecated. Constants for providing product directories.
|
|
dtdDir
Deprecated.
|
|
dtdDirName
Deprecated.
|
|
EFIX_TYPE
Deprecated. Typing constants for loading version info.
|
|
efixes
Deprecated.
|
|
efixNames
Deprecated.
|
|
EXTENSION_TYPE
Deprecated. Typing constants for loading version info.
|
|
extensionNames
Deprecated.
|
|
extensions
Deprecated.
|
|
FULL_INSTALL_DIR_NAME
Deprecated. Default names for product directories.
|
|
INSTALL_ROOT_PROPERTY_NAME
Deprecated. Constants for providing product directories.
|
|
JAVA_TMP_DIR_PROPERTY_NAME
Deprecated. Constants for providing product directories.
|
|
LOG_DIR_NAME
Deprecated. Default names for product directories.
|
|
LOG_DIR_PROPERTY_NAME
Deprecated. Constants for providing product directories.
|
|
logDir
Deprecated.
|
|
logDirName
Deprecated.
|
|
msgs
Deprecated. The initialized resource bundle.
|
|
NIF_DIR_NAME
Deprecated. Default names for product directories.
|
|
pgmUpdate
Deprecated. Constants holding CMVC version information.
|
|
pgmVersion
Deprecated. Constants holding CMVC version information.
|
|
PRODUCT_IDS
Deprecated. The array of known product ids.
|
|
PRODUCT_TYPE
Deprecated. Typing constants for loading version info.
|
|
productDir
Deprecated.
|
|
productDirName
Deprecated.
|
|
PRODUCTID_BASE
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_CLIENT
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_EMBEDDED_EXPRESS
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_EXPRESS
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_JDK
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_ND
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_PME
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_WXD
Deprecated. Constants for the known product ids.
|
|
PRODUCTID_XD
Deprecated. Constants for the known product ids.
|
|
productNames
Deprecated.
|
|
products
Deprecated.
|
|
PROPERTIES_DIR_NAME
Deprecated. Default names for product directories.
|
|
PTF_TYPE
Deprecated. Typing constants for loading version info.
|
|
ptfNames
Deprecated.
|
|
ptfs
Deprecated.
|
|
recoverableErrors
Deprecated.
|
|
REGISTRARID_ADD
Deprecated. Constants for the known registrar ids.
|
|
REGISTRARID_BASE
Deprecated. Constants for the known registrar ids.
|
|
registrarNames
Deprecated.
|
|
registrars
Deprecated.
|
|
texts
Deprecated.
|
|
TMP_DIR_PROPERTY_NAME
Deprecated. Constants for providing product directories.
|
|
UPDATE_DIR_NAME
Deprecated. Default names for product directories.
|
|
VERSION_DIR_NAME
Deprecated. Default names for product directories.
|
|
VERSION_DIR_PROPERTY_NAME
Deprecated. Constants for providing product directories.
|
|
versionDir
Deprecated.
|
|
versionDirName
Deprecated.
|
|
versionInfo
Deprecated.
|
|
warnings
Deprecated.
|
Constructor Summary
Constructor and Description |
---|
WASProduct()
Deprecated. As of WAS 8.0.
|
WASProduct(java.lang.String productDirName)
Deprecated. As of WAS 8.0.
|
WASProduct(java.lang.String productDirName,java.lang.String versionDirName,java.lang.String dtdDirName,java.lang.String logDirName,java.lang.String backupDirName)
Deprecated. As of WAS 8.0
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
addComponent(com.ibm.websphere.product.xml.component.component aComponent)
Deprecated. As of WAS 8.0.
|
|
addComponentName(java.lang.String componentName)
Deprecated. As of V8.0
|
|
addEFix(com.ibm.websphere.product.xml.efix.efix anEFix)
Deprecated. As of WAS 8.0.
|
|
addEFixName(java.lang.String efixName)
Deprecated. As of WAS 8.0.
|
|
addException(java.lang.String msgKey)
Deprecated. As of V8.0
|
|
addException(java.lang.String msgKey,java.lang.Exception e)
Deprecated. As of V8.0
|
|
addException(java.lang.String msgKey,java.lang.Object[] msgArgs,java.lang.Exception e)
Deprecated. As of V8.0
|
|
addException(com.ibm.websphere.product.WASProductException e)
Deprecated. As of V8.0
|
|
addProductName(java.lang.String productName)
Deprecated. As of V8.0
|
|
addPTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
Deprecated. As of V8.0
|
|
addPTFName(java.lang.String ptfName)
Deprecated. As of V8.0
|
|
addRecoverableError(org.xml.sax.SAXParseException e)
Deprecated. As of V8.0
|
|
addWarning(org.xml.sax.SAXParseException e)
Deprecated. As of V8.0
|
|
basicAddComponent(com.ibm.websphere.product.xml.component.component aComponent)
Deprecated. As of V8.0
|
|
basicAddProduct(com.ibm.websphere.product.product aProduct)
Deprecated. As of V8.0
|
|
basicGetComponentNames()
Deprecated. As of V8.0
|
|
basicGetComponents()
Deprecated. As of V8.0
|
|
basicGetEFixes()
Deprecated. As of WAS 8.0.
|
|
basicGetEFixNames()
Deprecated. As of WAS 8.0.
|
|
basicGetExtensionNames()
Deprecated. As of WAS 8.0.
|
|
basicGetExtensions()
Deprecated. As of WAS 8.0.
|
|
basicGetProductNames()
Deprecated. As of V8.0
|
|
basicGetProducts()
Deprecated. As of V8.0
|
|
basicGetPTFNames()
Deprecated. As of V8.0
|
|
basicGetPTFs()
Deprecated. As of V8.0
|
|
basicGetRegistrarNames()
Deprecated.
|
|
basicGetRegistrars()
Deprecated.
|
|
basicRemoveComponent(com.ibm.websphere.product.xml.component.component aComponent)
Deprecated. As of V8.0
|
|
basicRemoveEFix(com.ibm.websphere.product.xml.efix.efix anEFix)
Deprecated. As of WAS 8.0.
|
|
basicRemoveProduct(com.ibm.websphere.product.product aProduct)
Deprecated. As of V8.0
|
|
basicRemovePTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
Deprecated. As of V8.0
|
|
clearExceptions()
Deprecated. As of V8.0
|
|
collectVersionInfo(java.util.Iterator names)
Deprecated. As of V8.0
|
|
componentPresent(java.lang.String name)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.isComponentInstalled(String componentName)
|
|
computeBackupDirName(java.lang.String versionDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getBackupDirPath(String installRoot)
|
|
computeDTDDirName(java.lang.String versionDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getDTDDirPath(String installRoot)
|
|
computeLogDirName(java.lang.String productDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getLogDirPath(String installRoot)
|
|
computeVersionDirName(java.lang.String productDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getVersionDirPath(String installRoot)
|
|
createException(java.lang.String msgKey,java.lang.Object[] msgArgs,java.lang.Exception e)
Deprecated. As of V8.0
|
|
efixPresent(java.lang.String id)
Deprecated. As of WAS 8.0.
|
|
extensionPresent(java.lang.String name)
Deprecated. As of WAS 8.0.
|
|
getBackupDirName()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectoryHelper.getBackupDirPath(String installRoot).
|
|
getBackupDirName(java.lang.String versionDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getBackupDirPath(String installRoot)
|
|
getComponentByFilename(java.lang.String basename)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getComponentByName(String componentName)
|
|
getComponentByName(java.lang.String name)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getComponentByName(String componentName)
|
|
getComponentNames()
Deprecated. As of WAS 8.0.
|
|
getComponents()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getInstalledComponentList()
|
|
getDTDDirName()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectoryHelper.getDTDDirPath(String installRoot).
|
|
getDTDDirName(java.lang.String versionDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getDTDDirPath(String installRoot)
|
|
getEFixByFilename(java.lang.String basename)
Deprecated. As of WAS 8.0.
|
|
getEFixById(java.lang.String id)
Deprecated. As of WAS 8.0.
|
|
getEFixCount()
Deprecated. As of WAS 8.0.
|
|
getEFixes()
Deprecated. As of WAS 8.0.
|
|
getEFixNames()
Deprecated. As of WAS 8.0.
|
|
getExceptions()
Deprecated. As of WAS 8.0.
|
|
getExtensionByFilename(java.lang.String basename)
Deprecated. As of WAS 8.0.
|
|
getExtensionByName(java.lang.String name)
Deprecated. As of WAS 8.0.
|
|
getExtensionNames()
Deprecated. As of WAS 8.0.
|
|
getExtensions()
Deprecated. As of WAS 8.0.
|
|
getLogDirName()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectoryHelper.getLogDirPath(String installRoot).
|
|
getLogDirName(java.lang.String productDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getLogDirPath(String installRoot)
|
|
getPlatform()
Deprecated. As of WAS 8.0. Replaced by WASDirectory.getWASProductInfo(String productID)
|
|
getProductDir()
Deprecated. As of WAS 8.0.
|
|
getProductDirName()
Deprecated.
|
|
getPTFByFilename(java.lang.String basename)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getInstalledMaintenancePackageByID(String maintenancePackageID)
|
|
getPTFById(java.lang.String id)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getInstalledMaintenancePackageByID(String maintenancePackageID)
|
|
getPTFNames()
Deprecated. As of WAS 8.0.
|
|
getPTFs()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getInstalledMaintenancePackageList()
|
|
getRecoverableErrors()
Deprecated. As of WAS 8.0.
|
|
getRegistrarById(java.lang.String id)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getRegistrarById(String id)
|
|
getRegistrarNames()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getRegistrarFileNames()
|
|
getRegistrars()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.getRegistrarInstances()
|
|
getString(java.lang.String msgCode)
Deprecated. As of V8.0
|
|
getString(java.lang.String msgCode,java.lang.Object arg)
Deprecated. As of V8.0
|
|
getString(java.lang.String msgCode,java.lang.Object[] msgArgs)
Deprecated. As of V8.0
|
|
getString(java.lang.String msgCode,java.lang.Object arg1,java.lang.Object arg2)
Deprecated. As of V8.0
|
|
getTmpDirName()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getTmpDirPath()
|
|
getVersionDir()
Deprecated. As of WAS 8.0.
|
|
getVersionDirName()
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectoryHelper.getVersionDirPath(String installRoot).
|
|
getVersionDirName(java.lang.String productDirName)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.getVersionDirPath(String installRoot)
|
|
getVersionFileName(java.lang.String baseName)
Deprecated. As of WAS 8.0.
|
|
getVersionInfo(java.lang.String filename)
Deprecated. As of V8.0
|
|
getWarnings()
Deprecated. As of WAS 8.0.
|
|
initialize(java.lang.String useProductDirName,java.lang.String useVersionDirName,java.lang.String useDTDDirName,java.lang.String useLogDirName,java.lang.String useBackupDirName)
Deprecated. As of V8.0
|
|
initializeLogAndBackup()
Deprecated. As of WAS 8.0.
|
|
initMetadataInstance()
Deprecated. Init the WASMetadata instance if it's not initialized yet.
|
|
InitResourceBundle()
Deprecated. As of WAS 8.0.
|
|
listFileNames(java.io.File[] files)
Deprecated. As of WAS V8.0
|
|
listFileNames(java.io.FilenameFilter filter)
Deprecated. As of WAS V8.0
|
|
listFiles(java.io.FilenameFilter filter)
Deprecated. As of WAS V8.0
|
|
loadAllVersionInfoByType(java.lang.String type)
Deprecated. This method is not the recommended way to retrieve version information of
installed products by parsing product XML files. As of WAS 8.0 this method is
deprecated.
|
|
loadFile(java.io.File file,java.lang.String fileName)
Deprecated. As of WAS 8.0.
|
|
loadVersionInfo(java.lang.String filename)
Deprecated. As of V8.0
|
|
loadVersionInfoAsXMLString(java.lang.String filename,boolean doXSLTransform)
Deprecated. As of V8.0
|
|
numExceptions()
Deprecated. As of WAS 8.0.
|
|
numRecoverableErrors()
Deprecated. As of WAS 8.0.
|
|
numWarnings()
Deprecated. As of WAS 8.0.
|
|
preparePath(java.lang.String path,boolean trailSeparator)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.utils.WASDirectoryHelper.normalizeLocationAccordingToPlatform(String location, boolean trailSeparator)
|
|
ptfPresent(java.lang.String id)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.isMaintenancePackageInstalled(String maintenancePackageID)
|
|
registrarPresent(java.lang.String id)
Deprecated. As of WAS 8.0, replaced by
com.ibm.websphere.product.WASDirectory.isRegistrarPresent(String id)
|
|
removeComponent(com.ibm.websphere.product.xml.component.component aComponent)
Deprecated. As of WAS 8.0.
|
|
removeComponentName(java.lang.String componentName)
Deprecated. As of V8.0
|
|
removeEFix(com.ibm.websphere.product.xml.efix.efix anEFix)
Deprecated. As of WAS 8.0.
|
|
removeEFixName(java.lang.String efixName)
Deprecated. As of WAS 8.0.
|
|
removeProductName(java.lang.String productName)
Deprecated. As of V8.0
|
|
removePTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
Deprecated. As of WAS 8.0.
|
|
removePTFName(java.lang.String ptfName)
Deprecated. As of V8.0
|
|
saveEFix(com.ibm.websphere.product.xml.efix.efix anEFix)
Deprecated. As of WAS 8.0.
|
|
savePTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
Deprecated. As of WAS 8.0.
|
|
toString()
Deprecated. As of WAS 8.0.
|
|
transferErrors(com.ibm.websphere.product.xml.BaseFactory factory)
Deprecated. As of V8.0
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail
pgmVersion
- public static final java.lang.String pgmVersion
pgmUpdate
- public static final java.lang.String pgmUpdate
PRODUCTID_EMBEDDED_EXPRESS
- public static final java.lang.String PRODUCTID_EMBEDDED_EXPRESS
PRODUCTID_EXPRESS
- public static final java.lang.String PRODUCTID_EXPRESS
PRODUCTID_BASE
- public static final java.lang.String PRODUCTID_BASE
PRODUCTID_ND
- public static final java.lang.String PRODUCTID_ND
PRODUCTID_XD
- public static final java.lang.String PRODUCTID_XD
PRODUCTID_WXD
- public static final java.lang.String PRODUCTID_WXD
PRODUCTID_PME
- public static final java.lang.String PRODUCTID_PME
PRODUCTID_CLIENT
- public static final java.lang.String PRODUCTID_CLIENT
PRODUCTID_JDK
- public static final java.lang.String PRODUCTID_JDK
PRODUCT_IDS
- public static final java.lang.String[] PRODUCT_IDS
REGISTRARID_BASE
- public static final java.lang.String REGISTRARID_BASE
REGISTRARID_ADD
- public static final java.lang.String REGISTRARID_ADD
bundleIdMsg
- public static final java.lang.String bundleIdMsg
bundleIdText
- public static final java.lang.String bundleIdText
msgs
- public static java.util.ResourceBundle msgs
texts
- public static java.util.ResourceBundle texts
boundExceptions
- protected java.util.ArrayList boundExceptions
recoverableErrors
- protected java.util.ArrayList recoverableErrors
warnings
- protected java.util.ArrayList warnings
INSTALL_ROOT_PROPERTY_NAME
- public static final java.lang.String INSTALL_ROOT_PROPERTY_NAME
VERSION_DIR_PROPERTY_NAME
- public static final java.lang.String VERSION_DIR_PROPERTY_NAME
DTD_DIR_PROPERTY_NAME
- public static final java.lang.String DTD_DIR_PROPERTY_NAME
LOG_DIR_PROPERTY_NAME
- public static final java.lang.String LOG_DIR_PROPERTY_NAME
BACKUP_DIR_PROPERTY_NAME
- public static final java.lang.String BACKUP_DIR_PROPERTY_NAME
TMP_DIR_PROPERTY_NAME
- public static final java.lang.String TMP_DIR_PROPERTY_NAME
JAVA_TMP_DIR_PROPERTY_NAME
- public static final java.lang.String JAVA_TMP_DIR_PROPERTY_NAME
PROPERTIES_DIR_NAME
- public static final java.lang.String PROPERTIES_DIR_NAME
VERSION_DIR_NAME
- public static final java.lang.String VERSION_DIR_NAME
DTD_DIR_NAME
- public static final java.lang.String DTD_DIR_NAME
LOG_DIR_NAME
- public static final java.lang.String LOG_DIR_NAME
UPDATE_DIR_NAME
- public static final java.lang.String UPDATE_DIR_NAME
BACKUP_DIR_NAME
- public static final java.lang.String BACKUP_DIR_NAME
DEFAULT_TMP_DIR_NAME
- public static final java.lang.String DEFAULT_TMP_DIR_NAME
FULL_INSTALL_DIR_NAME
- public static final java.lang.String FULL_INSTALL_DIR_NAME
CURRENT_VERSION_DIR_NAME
- public static final java.lang.String CURRENT_VERSION_DIR_NAME
NIF_DIR_NAME
- public static final java.lang.String NIF_DIR_NAME
products
- protected java.util.ArrayList products
productNames
- protected java.util.ArrayList productNames
components
- protected java.util.ArrayList components
componentNames
- protected java.util.ArrayList componentNames
efixes
- protected java.util.ArrayList efixes
efixNames
- protected java.util.ArrayList efixNames
ptfs
- protected java.util.ArrayList ptfs
ptfNames
- protected java.util.ArrayList ptfNames
extensions
- protected java.util.ArrayList extensions
extensionNames
- protected java.util.ArrayList extensionNames
registrars
- protected java.util.ArrayList registrars
registrarNames
- protected java.util.ArrayList registrarNames
versionInfo
- protected java.util.HashMap versionInfo
PRODUCT_TYPE
- public static final java.lang.String PRODUCT_TYPE
Typing constants for loading version info.
COMPONENT_TYPE
- public static final java.lang.String COMPONENT_TYPE
Typing constants for loading version info.
EFIX_TYPE
- public static final java.lang.String EFIX_TYPE
Typing constants for loading version info.
PTF_TYPE
- public static final java.lang.String PTF_TYPE
Typing constants for loading version info.
EXTENSION_TYPE
- public static final java.lang.String EXTENSION_TYPE
Typing constants for loading version info.
productDir
- protected java.io.File productDir
productDirName
- protected java.lang.String productDirName
versionDir
- protected java.io.File versionDir
versionDirName
- protected java.lang.String versionDirName
dtdDir
- protected java.io.File dtdDir
dtdDirName
- protected java.lang.String dtdDirName
logDir
- protected java.io.File logDir
logDirName
- protected java.lang.String logDirName
backupDir
- protected java.io.File backupDir
backupDirName
- protected java.lang.String backupDirName
Constructor Detail
WASProduct
- public WASProduct()
Default constructor. The new instance is initialized wholly from system properties. Exceptions may be registed in the new instance.
WASProduct
- public WASProduct(java.lang.String productDirName)
Parameterized constructor. The product directories are computed from the specified directory. No system properties are used. Exceptions may be registed in the new instance.
productDirName
- The base product directory. WASProduct
- public WASProduct(java.lang.String productDirName,
- java.lang.String versionDirName,
- java.lang.String dtdDirName,
- java.lang.String logDirName,
- java.lang.String backupDirName)
Parameterized constructor. All product directories are assigned directly from arguments. No system properties are used. Exceptions may be registed in the new instance.
productDirName
- The product directory for use. versionDirName
- The version directory for use. dtdDirName
- The DTD directory for use. logDirName
- The log directory for use. backupDirName
- The backup directory for use. Method Detail
InitResourceBundle
- public static void InitResourceBundle( )
getString
- protected static java.lang.String getString( java.lang.String msgCode)
getString
- protected static java.lang.String getString( java.lang.String msgCode,
- java.lang.Object arg)
getString
- protected static java.lang.String getString( java.lang.String msgCode,
- java.lang.Object arg1,
- java.lang.Object arg2)
getString
- protected static java.lang.String getString( java.lang.String msgCode,
- java.lang.Object[] msgArgs)
addException
- protected void addException(com.ibm.websphere.product.WASProductException e)
numExceptions
- public int numExceptions()
Answer the number of exceptions which were registered within the last operation.
getExceptions
- public java.util.Iterator getExceptions( )
Answer an iterator across the registered exceptions.
addRecoverableError
- protected void addRecoverableError( org.xml.sax.SAXParseException e)
numRecoverableErrors
- public int numRecoverableErrors( )
Answer the number of recoverable errors which were registered within the last operation.
getRecoverableErrors
- public java.util.Iterator getRecoverableErrors( )
Answer an iterator across the registered recoverable errors.
addWarning
- protected void addWarning(org.xml.sax.SAXParseException e)
numWarnings
- public int numWarnings()
Answer the number of warnings which were registered within the last operation.
getWarnings
- public java.util.Iterator getWarnings( )
Answer an iterator across the registered warnings.
transferErrors
- protected void transferErrors(com.ibm.websphere.product.xml.BaseFactory factory)
clearExceptions
- protected void clearExceptions( )
addException
- protected void addException(java.lang.String msgKey)
addException
- protected void addException(java.lang.String msgKey,
- java.lang.Exception e)
addException
- protected void addException(java.lang.String msgKey,
- java.lang.Object[] msgArgs,
- java.lang.Exception e)
createException
- protected static com.ibm.websphere.product.WASProductException createException( java.lang.String msgKey,
- java.lang.Object[] msgArgs,
- java.lang.Exception e)
computeVersionDirName
- public static java.lang.String computeVersionDirName( java.lang.String productDirName)
Determine and return the version directory from system properties. The argument product directory will be used, with adjustment, if no version directory property is set. An exception is thrown if the version directory cannot be determined.
productDirName
- The base directory from which to compute
the version directory, used in case no
version directory property is set. getVersionDirName
- public static java.lang.String getVersionDirName( java.lang.String productDirName)
Answer a version directory based on the argument product directory.
computeDTDDirName
- public static java.lang.String computeDTDDirName( java.lang.String versionDirName)
- throws com.ibm.websphere.product.WASProductException
Determine and return the DTD directory from system properties. The argument version directory will be used, with adjustment, if no DTD directory property is set. An exception is thrown if the DTD directory cannot be determined.
versionDirName
- The base directory from which to compute
the DTD directory, used in case no
DTD directory property is set. WASProductException
- An exception which is thrown
if the DTD directory cannot
be determined. getDTDDirName
- public static java.lang.String getDTDDirName( java.lang.String versionDirName)
Answer a DTD directory based on the argument version directory.
computeLogDirName
- public static java.lang.String computeLogDirName( java.lang.String productDirName)
- throws com.ibm.websphere.product.WASProductException
Determine and return the log directory from system properties. The argument version directory will be used, with adjustment, if no log directory property is set. An exception is thrown if the log directory cannot be determined.
productDirName
- The base directory from which to compute
the log directory, used in case no
log directory property is set. WASProductException
- An exception which is thrown
if the log directory cannot
be determined. getLogDirName
- public static java.lang.String getLogDirName( java.lang.String productDirName)
Answer a log directory based on the argument version directory.
computeBackupDirName
- public static java.lang.String computeBackupDirName( java.lang.String versionDirName)
- throws com.ibm.websphere.product.WASProductException
Determine and return the backup directory from system properties. The argument version directory will be used, with adjustment, if no backup directory property is set. An exception is thrown if the backup directory cannot be determined.
versionDirName
- The base directory from which to compute
the backup directory, used in case no
backup directory property is set. WASProductException
- An exception which is thrown
if the backup directory cannot
be determined. getBackupDirName
- public static java.lang.String getBackupDirName( java.lang.String versionDirName)
Answer a backup directory based on the argument version directory.
getTmpDirName
- public static java.lang.String getTmpDirName( )
Determine and return the TMP directory from system properties. The TMP_DIR_PROPERTY_NAME system property is tested, then the JAVA_TMP_DIR_PROPERTY_NAME is tested. If neither is set, then DEFAULT_TMP_DIR_NAME is used.
preparePath
- public static java.lang.String preparePath( java.lang.String path,
- boolean trailSeparator)
Utility method for replacing slashes in the argument path with the file separator character. Optionally, a trailing separator is added to (or kept off of) the result path.
path
- The argument path to be processed. trailSeparator
- A flag specifying if the result path is to
have a trailing separator character. initialize
- protected void initialize(java.lang.String useProductDirName,
- java.lang.String useVersionDirName,
- java.lang.String useDTDDirName,
- java.lang.String useLogDirName,
- java.lang.String useBackupDirName)
initializeLogAndBackup
- public boolean initializeLogAndBackup( )
Initialize the log and backup directories associated with the receiver. If necessary, these directories are created, and are verified to exist as directories.
This method clears and will register new exceptions, as needed.
The result indicates whether the log and backup directories were successfully initialized.
getPlatform
- public com.ibm.websphere.product.xml.websphere.websphere getPlatform( )
Answer the websphere object, which is representative of a websphere installation.
getComponentByFilename
- public com.ibm.websphere.product.xml.component.component getComponentByFilename( java.lang.String basename)
Answer the component stored in the named component file. Answer null if the named file does not exist or cannot be loaded.
basename
- The name of the file holding a
component object. getComponentByName
- public com.ibm.websphere.product.xml.component.component getComponentByName( java.lang.String name)
Answer the component having the specified name. Answer null if no matching component is available.
name
- The name of the component to be returned. componentPresent
- public boolean componentPresent( java.lang.String name)
Answer true or false, telling if a component having the specified name is present.
name
- The name of the component which is tested. addComponent
- public boolean addComponent(com.ibm.websphere.product.xml.component.component aComponent)
Save the argument component into the bound component directory. Answer true or false, telling if the component was successfully saved.
aComponent
- A component to be saved. removeComponent
- public boolean removeComponent( com.ibm.websphere.product.xml.component.component aComponent)
Remove the argument component from the bound component directory. Answer true or false, telling if the component was successfully removed.
aComponent
- A component to be removed. getEFixByFilename
- public com.ibm.websphere.product.xml.efix.efix getEFixByFilename( java.lang.String basename)
Answer the efix stored in the named efix file. Answer null if the named file does not exist or cannot be loaded.
basename
- The name of the file holding an efix
object. getEFixById
- public com.ibm.websphere.product.xml.efix.efix getEFixById( java.lang.String id)
Answer the efix having the specified id. Answer null if no matching efix is available.
id
- The id of the efix to be returned. efixPresent
- public boolean efixPresent(java.lang.String id)
Answer true or false, telling if a efix having the specified name is present.
id
- The id of the efix which is tested. getPTFByFilename
- public com.ibm.websphere.product.xml.efix.ptf getPTFByFilename( java.lang.String basename)
Answer the PTF stored in the named PTF file. Answer null if the named file does not exist or cannot be loaded.
basename
- The name of the file holding an PTF
object. getPTFById
- public com.ibm.websphere.product.xml.efix.ptf getPTFById( java.lang.String id)
Answer the PTF having the specified id. Answer null if no matching PTF is available.
id
- The id of the PTF to be returned. ptfPresent
- public boolean ptfPresent(java.lang.String id)
Answer true or false, telling if a PTF having the specified name is present.
id
- The id of the PTF which is tested. getExtensionByFilename
- public com.ibm.websphere.product.xml.extension.extension getExtensionByFilename( java.lang.String basename)
Answer the extension stored in the named extension file. Answer null if the named file does not exist or cannot be loaded.
basename
- The name of the file holding an extension
object. getExtensionByName
- public com.ibm.websphere.product.xml.extension.extension getExtensionByName( java.lang.String name)
Answer the extension having the specified name. Answer null if no matching extension is available.
name
- The name of the extension to be returned. extensionPresent
- public boolean extensionPresent( java.lang.String name)
Answer true or false, telling if an extension having the specified name is present.
name
- The name of the extension which is tested. getRegistrarById
- public com.ibm.websphere.product.xml.registrar.registrar getRegistrarById( java.lang.String id)
id
- The id of the registrar to be returned. registrarPresent
- public boolean registrarPresent( java.lang.String id)
id
- The id of the registrar which is tested. basicGetProducts
- protected java.util.ArrayList basicGetProducts( )
basicAddProduct
- protected void basicAddProduct( com.ibm.websphere.product.product aProduct)
basicRemoveProduct
- protected void basicRemoveProduct( com.ibm.websphere.product.product aProduct)
basicGetProductNames
- protected java.util.ArrayList basicGetProductNames( )
addProductName
- protected void addProductName(java.lang.String productName)
removeProductName
- protected void removeProductName( java.lang.String productName)
getComponents
- public java.util.Iterator getComponents( )
Answer an iterator across the components in the associated product directory.
basicAddComponent
- protected void basicAddComponent( com.ibm.websphere.product.xml.component.component aComponent)
basicRemoveComponent
- protected void basicRemoveComponent( com.ibm.websphere.product.xml.component.component aComponent)
basicGetComponents
- protected java.util.ArrayList basicGetComponents( )
getComponentNames
- public java.util.Iterator getComponentNames( )
Answer an iterator across the names of the components in the associated product directory.
basicGetComponentNames
- protected java.util.ArrayList basicGetComponentNames( )
addComponentName
- protected void addComponentName( java.lang.String componentName)
removeComponentName
- protected void removeComponentName( java.lang.String componentName)
saveEFix
- public boolean saveEFix(com.ibm.websphere.product.xml.efix.efix anEFix)
Save the argument efix into the bound product directory. Answer true or false, telling if the efix was successfully saved.
anEFix
- A efix to be saved. removeEFix
- public boolean removeEFix(com.ibm.websphere.product.xml.efix.efix anEFix)
Remove the argument efix from the bound product directory. Answer true or false, telling if the efix was successfully removed.
anEFix
- A efix to be removed. addEFix
- protected void addEFix(com.ibm.websphere.product.xml.efix.efix anEFix)
basicRemoveEFix
- protected void basicRemoveEFix( com.ibm.websphere.product.xml.efix.efix anEFix)
getEFixes
- public java.util.Iterator getEFixes( )
Answer an iterator across the efixes in the associated product directory.
getEFixCount
- public int getEFixCount()
Answer the count of efixes in the bound product directory.
basicGetEFixes
- protected java.util.ArrayList basicGetEFixes( )
addEFixName
- protected void addEFixName(java.lang.String efixName)
removeEFixName
- protected void removeEFixName(java.lang.String efixName)
getEFixNames
- public java.util.Iterator getEFixNames( )
Answer an iterator across the ids of the efixes in the associated product directory.
basicGetEFixNames
- protected java.util.ArrayList basicGetEFixNames( )
savePTF
- public boolean savePTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
Save the argument PTF into the bound product directory. Answer true or false, telling if the PTF was successfully saved.
aPTF
- A PTF to be saved. removePTF
- public boolean removePTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
Remove the argument PTF from the bound product directory. Answer true or false, telling if the PTF was successfully removed.
aPTF
- A PTF to be removed. addPTF
- protected void addPTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
basicRemovePTF
- protected void basicRemovePTF(com.ibm.websphere.product.xml.efix.ptf aPTF)
getPTFs
- public java.util.Iterator getPTFs( )
Answer an iterator across the PTFs in the associated product directory.
basicGetPTFs
- protected java.util.ArrayList basicGetPTFs( )
addPTFName
- protected void addPTFName(java.lang.String ptfName)
removePTFName
- protected void removePTFName(java.lang.String ptfName)
getPTFNames
- public java.util.Iterator getPTFNames( )
Answer an iterator across the ids of the PTFs in the associated product directory.
basicGetPTFNames
- protected java.util.ArrayList basicGetPTFNames( )
getExtensions
- public java.util.Iterator getExtensions( )
Answer an iterator across the extensions in the associated product directory.
basicGetExtensions
- protected java.util.ArrayList basicGetExtensions( )
getExtensionNames
- public java.util.Iterator getExtensionNames( )
Answer an iterator across the names of the extensions in the associated product directory.
basicGetExtensionNames
- protected java.util.ArrayList basicGetExtensionNames( )
getRegistrars
- public java.util.Iterator getRegistrars( )
basicGetRegistrars
- protected java.util.ArrayList basicGetRegistrars( )
getRegistrarNames
- public java.util.Iterator getRegistrarNames( )
basicGetRegistrarNames
- protected java.util.ArrayList basicGetRegistrarNames( )
collectVersionInfo
- protected java.util.ArrayList collectVersionInfo( java.util.Iterator names)
getVersionInfo
- protected java.lang.Object getVersionInfo( java.lang.String filename)
loadVersionInfo
- protected java.lang.Object loadVersionInfo( java.lang.String filename)
loadAllVersionInfoByType
- public java.lang.String[] loadAllVersionInfoByType( java.lang.String type)
Answer a string array containing the contents of all files in the bound product directory having the specified type.
type
- The type of file to load; see the constants
'PRODUCT_TYPE', and others. loadVersionInfoAsXMLString
- protected java.lang.String loadVersionInfoAsXMLString( java.lang.String filename,
- boolean doXSLTransform)
loadFile
- protected java.lang.String loadFile( java.io.File file,
- java.lang.String fileName)
- throws java.io.FileNotFoundException
- java.io.IOException
java.io.FileNotFoundException
java.io.IOException
getProductDir
- protected java.io.File getProductDir( )
getProductDirName
- public java.lang.String getProductDirName( )
getVersionDir
- protected java.io.File getVersionDir( )
getVersionDirName
- public java.lang.String getVersionDirName( )
Answer the version directory name bound into the receiver.
getVersionFileName
- public java.lang.String getVersionFileName( java.lang.String baseName)
Answer the name of the argument file qualified to be within the bound version directory.
baseName
- The base file name, to be qualified. getDTDDirName
- public java.lang.String getDTDDirName( )
Answer the DTD directory name bound into the receiver.
getLogDirName
- public java.lang.String getLogDirName( )
Answer the log directory name bound into the receiver.
getBackupDirName
- public java.lang.String getBackupDirName( )
Answer the backup directory name bound into the receiver.
listFileNames
- protected java.util.ArrayList listFileNames( java.io.FilenameFilter filter)
listFileNames
- protected java.util.ArrayList listFileNames( java.io.File[] files)
listFiles
- protected java.io.File[] listFiles( java.io.FilenameFilter filter)
toString
- public java.lang.String toString( )
Answer a string representation of the receiver. This representation currently displays the bound product directory name and the bound version directory name.
toString
in class java.lang.Object
initMetadataInstance
- protected boolean initMetadataInstance( )
true
if the instance is initialized properly.
Else return false
.
true
if the instance is initialized properly.
Else return false
.