com.ibm.websphere.management.metadata

Interface ManagedObjectMetadataAccessor

public interface ManagedObjectMetadataAccessor

Provides runtime access to the set of all features for many objects within the cell. Use the class ManagedObjectMetadataAccessorFactory to obtain an instance of ManagedObjectMetadataAccessor.

See Also:

ManagedObjectMetadataAccessorFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CELL_NAME Constant for the property name which is used to specify the cell name from which the ManagedObjectMetaDataAccessor instance being created is to obtain metadata.
static java.lang.String	WAS_REPOSITORY_ROOT Constant for the property name which is used to specify the WebSphere repository root.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Properties	getMetadataProperties(java.lang.String nodeName) Obtains all metadata for the specified node.
java.lang.String	getMetadataProperty(java.lang.String nodeName, java.lang.String propertyName) Obtains metadata with the specified key for the specified node.

Field Detail

WAS_REPOSITORY_ROOT

static final java.lang.String WAS_REPOSITORY_ROOT

Constant for the property name which is used to specify the WebSphere repository root. This value is required in order for the metadata accessor to obtain metadata stored in the configuration repository.

To specify the WebSphere repository root directory, include this property setting in the java.util.Properties instance passed to the factory method ManagedObjectMetadataAccessorFactory.createAccessor(Properties). in order to create a ManagedObjectMetadataAccessor instance.

This constant is set to ConfigRepository.REPOSITORY_ROOT_DIR_KEY and is defined in this class as a convenience. The actual value for this constant is "was.repository.root".

See Also:

ManagedObjectMetadataAccessorFactory, ConfigRepository.REPOSITORY_ROOT_DIR_KEY, Constant Field Values

CELL_NAME

static final java.lang.String CELL_NAME

Constant for the property name which is used to specify the cell name from which the ManagedObjectMetaDataAccessor instance being created is to obtain metadata.

This property must exist in the set of properties passed to the factory method ManagedObjectMetadataAccessorFactory.createAccessor(Properties) in order to create a ManagedObjectMetadataAccessor instance.

The value of this constant is "local.cell".

See Also:

ManagedObjectMetadataAccessorFactory, Constant Field Values

Method Detail

getMetadataProperties

java.util.Properties getMetadataProperties(java.lang.String nodeName)
                                           throws AdminException

Obtains all metadata for the specified node.

Parameters:

nodeName - The name of the node for which data is to be retreived.

Returns:

Managed object metadata properties for a node, immutable.

Throws:

AdminException - Metadata for the specified node could not be obtained or an input value was invalid.

getMetadataProperty

java.lang.String getMetadataProperty(java.lang.String nodeName,
                                   java.lang.String propertyName)
                                     throws AdminException

Obtains metadata with the specified key for the specified node.

Parameters:

nodeName - The name of the node for which data is to be retreived.

propertyName - Metadata property name.

Returns:

Managed object metadata value for the given property name.

Throws:

AdminException - Specified metadata could not be obtained or an input value was invalid.