com.ibm.websphere.management.metadata
Class ManagedObjectMetadataHelper
- java.lang.Object
com.ibm.websphere.management.metadata.ManagedObjectMetadataHelper
- public class ManagedObjectMetadataHelper
- extends java.lang.Object
Field Summary
Modifier and Type | Field and Description |
---|---|
|
BASE_WAS_APP_ACTIVATION_PLANS
Constant for the property name for the base application activation plans.
|
|
BASE_WAS_PRODUCT_SHORT_NAME
Constant for the property name for the base product's short name.
|
|
BASE_WAS_PRODUCT_VERSION
Constant for the property name for the base product version.
|
|
NODE_DEPLOYED_FEATURES
Constant for the property name for the node deployed features.
|
|
NODE_OS
Constant for the property name for the operating system of the node associated with
a set of metadata.
|
|
NODE_OS_AIX
Constant for the node operating system property value for AIX.
|
|
NODE_OS_AS400
Constant for the node operating system property value for OS/400.
|
|
NODE_OS_HPUX
Constant for the node operating system property value for HP-UX.
|
|
NODE_OS_LINUX
Constant for the node operating system property value for Linux.
|
|
NODE_OS_SOLARIS
Constant for the node operating system property value for Solaris.
|
|
NODE_OS_WINDOWS
Constant for the node operating system property value for Windows.
|
|
NODE_OS_ZOS
Constant for the node operating system property value for z/OS.
|
|
NODE_SYSPLEX_NAME
Constant for the property name for the node sysplex name.
|
|
PLUGGABLE_SDK_ATTR_BITS
|
|
PLUGGABLE_SDK_ATTR_LOCATION
|
|
PLUGGABLE_SDK_ATTR_PLATFORM
|
|
PLUGGABLE_SDK_ATTR_VERSION
|
|
PLUGGABLE_SDK_PREFIX
Constants for the property name for the pluggable SDK support.
|
Constructor Summary
Constructor and Description |
---|
ManagedObjectMetadataHelper(ManagedObjectMetadataAccessor metadataAccessor)
Constructs a ManagedObjectMetadataHelper instance.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
compareNodeVersion(java.lang.String nodeName,java.lang.String version)
Compares the WebSphere version for a node with the input version.
|
getAccessor()
This method returns the ManagedObjectMetadataAccessor instance used to
construct this helper.
|
|
|
getAvailableSDKsOnNode(java.lang.String nodeName)
This method lists names for all available SDKs.
|
|
getNodeBaseProductShortName(java.lang.String nodeName)
Returns the version of WebSphere Base product installation for a given node.
|
|
getNodeBaseProductVersion(java.lang.String nodeName)
Returns the version of WebSphere Base product installation for a given node.
|
|
getNodeDeployedFeatures(java.lang.String nodeName)
Returns the list of features for the given node.
|
|
getNodeMajorVersion(java.lang.String nodeName)
Returns the major version of WebSphere Base product installation for a given node.
|
|
getNodeMinorVersion(java.lang.String nodeName)
Returns the minor version of WebSphere installation for a given node.
|
|
getNodePlatformOS(java.lang.String nodeName)
Returns the operating system name for a given node.
|
|
getNodeProductsAndVersions(java.lang.String nodeName)
Obtains all products and versions for installed products on the
specified node (which can be a dmgr or a node).
|
|
getNodeProductVersions(java.lang.String nodeName)
This method combines all product name and product versions contained the set
of metadata properties for the specified node and stores them in the form of
a map from product name to product version such that the mapping is sorted by
product name.
|
|
getNodeServiceVersion(java.lang.String nodeName)
Returns the service version of WebSphere installation for a given node.
|
|
getNodeSysplexName(java.lang.String nodeName)
Returns the sysplex name for a given node.
|
|
getNodeUpdateVersion(java.lang.String nodeName)
Returns the update version of WebSphere installation for a given node.
|
|
getSDKBits(java.lang.String nodeName,java.lang.String sdkName)
This method obtains the location of a given SDK for a given node
The method throws MetadataNotAvailableException for a Pre-V8 node not on ZOS as
there is no SDK property available for such a node.
|
|
getSDKLocation(java.lang.String nodeName,java.lang.String sdkName)
This method obtains the location of a given SDK for a given node
The method throws MetadataNotAvailableException for a Pre-V8 node on OS400 as
there is no SDK property available for such a node.
|
|
getSDKPropertiesOnNode(java.lang.String nodeName,java.lang.String sdkName,java.lang.String[] sdkAttributes)
This method lists the properties for all available SDKs.
|
|
getSDKVersion(java.lang.String nodeName,java.lang.String sdkName)
This method obtains the location of a given SDK for a given node
The method throws MetadataNotAvailableException for a Pre-V8 node on OS400 as
there is no SDK property available for such a node.
|
|
isNodeOS400(java.lang.String nodeName)
Tests whether a given node is running on the OS/400 platform.
|
|
isNodeZOS(java.lang.String nodeName)
Tests whether a given node is running on the z/OS platform.
|
|
listRuntimeComponents(java.lang.String nodeName)
This method lists all runtime components of a set of node metadata properties
for all WebSphere Application Server Base and stack products for the specified
node and stores them in the form of ArrayList.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail
BASE_WAS_PRODUCT_VERSION
- public static final java.lang.String BASE_WAS_PRODUCT_VERSION
BASE_WAS_PRODUCT_SHORT_NAME
- public static final java.lang.String BASE_WAS_PRODUCT_SHORT_NAME
The value for this constant is "com.ibm.websphere.baseProductShortName".
BASE_WAS_APP_ACTIVATION_PLANS
- public static final java.lang.String BASE_WAS_APP_ACTIVATION_PLANS
The value for this constant is "com.ibm.websphere.baseRuntimeComponents".
NODE_OS
- public static final java.lang.String NODE_OS
The value for this constant is "com.ibm.websphere.nodeOperatingSystem".
NODE_OS_AS400
- public static final java.lang.String NODE_OS_AS400
The value for this constant is "os400".
NODE_OS_AIX
- public static final java.lang.String NODE_OS_AIX
The value for this constant is "aix".
NODE_OS_HPUX
- public static final java.lang.String NODE_OS_HPUX
The value for this constant is "hpux".
NODE_OS_LINUX
- public static final java.lang.String NODE_OS_LINUX
The value for this constant is "linux".
NODE_OS_SOLARIS
- public static final java.lang.String NODE_OS_SOLARIS
The value for this constant is "solaris".
NODE_OS_WINDOWS
- public static final java.lang.String NODE_OS_WINDOWS
The value for this constant is "windows".
NODE_OS_ZOS
- public static final java.lang.String NODE_OS_ZOS
The value for this constant is "os390".
NODE_SYSPLEX_NAME
- public static final java.lang.String NODE_SYSPLEX_NAME
The value for this constant is "com.ibm.websphere.nodeSysplexName".
NODE_DEPLOYED_FEATURES
- public static final java.lang.String NODE_DEPLOYED_FEATURES
The value for this constant is "com.ibm.websphere.deployed.features".
PLUGGABLE_SDK_PREFIX
- public static final java.lang.String PLUGGABLE_SDK_PREFIX
The value for this constant is "com.ibm.websphere.sdk.*".
PLUGGABLE_SDK_ATTR_VERSION
- public static final java.lang.String PLUGGABLE_SDK_ATTR_VERSION
PLUGGABLE_SDK_ATTR_BITS
- public static final java.lang.String PLUGGABLE_SDK_ATTR_BITS
PLUGGABLE_SDK_ATTR_LOCATION
- public static final java.lang.String PLUGGABLE_SDK_ATTR_LOCATION
PLUGGABLE_SDK_ATTR_PLATFORM
- public static final java.lang.String PLUGGABLE_SDK_ATTR_PLATFORM
Constructor Detail
ManagedObjectMetadataHelper
- public ManagedObjectMetadataHelper( ManagedObjectMetadataAccessor metadataAccessor)
- throws AdminException
metadataAccessor
- Managed object metadata accessor. AdminException
- Could not create a ManagedObjectMetadataHelper, most likely
due to an invalid argument. Method Detail
getAccessor
- public ManagedObjectMetadataAccessor getAccessor( )
- throws AdminException
AdminException
- Could not complete requested operation. getNodeMajorVersion
- public java.lang.String getNodeMajorVersion( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Either the base node version metadata does not
exist in the set of metadata properties for the specified node, or the
major version is not specified in the base node version metadata. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodeMinorVersion
- public java.lang.String getNodeMinorVersion( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Either the base node version metadata does not
exist in the set of metadata properties for the specified node, or the
minor version is not specified in the base node version metadata. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodeUpdateVersion
- public java.lang.String getNodeUpdateVersion( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Either the base node version metadata does not
exist in the set of metadata properties for the specified node, or the
update version is not specified in the base node version metadata. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodeServiceVersion
- public java.lang.String getNodeServiceVersion( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Either the base node version metadata does not
exist in the set of metadata properties for the specified node, or the
service version is not specified in the base node version metadata. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodeBaseProductVersion
- public java.lang.String getNodeBaseProductVersion( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodeBaseProductShortName
- public java.lang.String getNodeBaseProductShortName( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. compareNodeVersion
- public int compareNodeVersion(java.lang.String nodeName,
- java.lang.String version)
- throws AdminException
nodeName
- The name of the node for the metadata used by this method. version
- A String value of the WebSphere version to be compared. -1 if node version is smaller than the input version,
+1 is node version is higher than the input version.
com.ibm.websphere.management.exception.MetadataNotAvailableException
- Metadata required by this method does not exist
in the set of metadata properties for the specified node. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. isNodeZOS
- public boolean isNodeZOS(java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata used by this method. true
if node operating system is z/OS, false
otherwise. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Metadata required by this method does not exist
in the set of metadata properties for the specified node. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. isNodeOS400
- public boolean isNodeOS400(java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata used by this method. true
if node operating system is os400, false
otherwise. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Metadata required by this method does not exist
in the set of metadata properties for the specified node. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodePlatformOS
- public java.lang.String getNodePlatformOS( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodeSysplexName
- public java.lang.String getNodeSysplexName( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the metadata returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid. getNodeProductVersions
- public java.util.SortedMap getNodeProductVersions( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the version list returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the
set of metadata properties for the specified node. AdminException
- Metadata for the specified node could not be obtained or
an input value was invalid. getNodeDeployedFeatures
- public java.util.ArrayList getNodeDeployedFeatures( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the features list returned by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid. getNodeProductsAndVersions
- public java.util.Properties getNodeProductsAndVersions( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for which data is to be retrieved. AdminException
- Metadata for specified node could not be obtained listRuntimeComponents
- public java.util.ArrayList listRuntimeComponents( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the runtime components list returned
by this method. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid. getAvailableSDKsOnNode
- public java.lang.String[] getAvailableSDKsOnNode( java.lang.String nodeName)
- throws AdminException
nodeName
- The name of the node for the available SDKs properties returned
by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid. getSDKPropertiesOnNode
- public java.util.Properties getSDKPropertiesOnNode( java.lang.String nodeName,
- java.lang.String sdkName,
- java.lang.String[] sdkAttributes)
- throws AdminException
nodeName
- The name of the node for the available SDKs properties returned
by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid. getSDKLocation
- public java.lang.String getSDKLocation( java.lang.String nodeName,
- java.lang.String sdkName)
- throws AdminException
nodeName
- The name of the node for the available SDKs properties returned
by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid. getSDKVersion
- public java.lang.String getSDKVersion( java.lang.String nodeName,
- java.lang.String sdkName)
- throws AdminException
nodeName
- The version of the node for the available SDKs properties returned
by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid. getSDKBits
- public java.lang.String getSDKBits( java.lang.String nodeName,
- java.lang.String sdkName)
- throws AdminException
nodeName
- The version of the node for the available SDKs properties returned
by this method. com.ibm.websphere.management.exception.MetadataNotAvailableException
- Requested metadata does not exist in the set
of metadata properties for the specified node. AdminException
- The metadata for the specified node could not be obtained
or an input value was invalid.
The base product version should always contain at least the major version, but lesser versions may not be included if they are not known. A base product version which is not fully qualified is most likely to occur on version 5 nodes which are members of a cell which has been migrated to version 6.
The value for this constant is "com.ibm.websphere.baseProductVersion".