com.ibm.websphere.management

Interface JMXManageable

All Known Implementing Classes:

JMXManageableSupport

public interface JMXManageable

The JMXManageable interface is a marker interface that a CustomService implementation may choose to implement in order to indicate that it can be managed as a JMX MBean. By implementing this interface the CustomService marks itself as manageable by the WebSphere JMX administration system. The WebSphere admin system will create an MBean and activate it on behalf of the CustomService.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Properties	getMBeanProperties() Provides additional customer-defined key properties to be added to the key property list of the ObjectName for the MBean.
java.lang.String	getType() Returns the MBean type for the MBean instance to be created.

Method Detail

getType

java.lang.String getType()

Returns the MBean type for the MBean instance to be created.

This type information is used by the WebSphere admin system to load the proper MBean Descriptor in order to define the attributes, operations, and notifications for the MBean.

The WebSphere admin system will first check whether this type is one of the predefined types shipped with the WebSphere product. If the type is one of the predefined ones, the MBean Descriptor shipped with WebSphere is loaded and used. Otherwise, the admin system will attempt to locate an MBeanExtensionProvider configured to support this type of MBean and will load the MBean Descriptor from that MBeanExtensionProvider configuration.

If the JMXManageable implementation returns null from this method, the class name of the implementation will be used as the type.

getMBeanProperties

java.util.Properties getMBeanProperties()

Provides additional customer-defined key properties to be added to the key property list of the ObjectName for the MBean.

Note that in distributed environment, all ObjectNames have at least cell, node, process, type and mbeanIdentifier key properties.

See Also:

javax.management.ObjectName