wt.jmx.core.mbeans
Interface InfoMBean

All Superinterfaces:

SelfEmailingMBean

All Known Subinterfaces:

NotificationHandlerMBean, SummaryMBean

All Known Implementing Classes:

Info

public interface InfoMBean
extends SelfEmailingMBean

Allows a set of MBean object names and attribute names to be specified for purposes of obtaining these later, e.g. to output to logs, e-mail, etc.

Supported API: true

Extendable: true

Method Summary

void	addInfoItem(ObjectName mbeanObjectName, String mbeanAttributeName, String displayName) Add item to end of list of those to be obtained Supported API: true
void	changeInfoItemDisplayName(int infoItemIdx, String displayName) Add item to end of list of those to be obtained Supported API: true
TabularData	getInfoItemsAsOpenData() Structured representation of items to be obtained; see InfoItemsAsStrings for alternate string representation
String[]	getInfoItemsAsStrings() String representation of items to be obtained; format is: [index] mbeanObjectName mbeanAttributeName (displayName) Supported API: true
String[]	getInfoItemsPreview() String preview representation of data currently selected by info items Supported API: true
void	insertInfoItem(int infoItemIdx, ObjectName mbeanObjectName, String mbeanAttributeName, String displayName) Insert item into list of those to be obtained Supported API: true
void	removeInfoItem(int infoItemIdx) Remove item from list of those to be obtained Supported API: true
void	removeInfoItems() Remove all items from list of those to be obtained Supported API: true

Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

emailThisMBean

Method Detail

getInfoItemsAsOpenData

TabularData getInfoItemsAsOpenData()
                                   throws OpenDataException

Structured representation of items to be obtained; see InfoItemsAsStrings for alternate string representation

An array of CompositeData would make more sense here, but JMX consoles seem to fail to interpret this properly for display purposes when outside the context of a CompositeData or TabularData.

Supported API: true

Throws:

OpenDataException

getInfoItemsAsStrings

String[] getInfoItemsAsStrings()

String representation of items to be obtained; format is: [index] mbeanObjectName mbeanAttributeName (displayName)

Supported API: true

getInfoItemsPreview

String[] getInfoItemsPreview()

String preview representation of data currently selected by info items

Supported API: true

addInfoItem

void addInfoItem(ObjectName mbeanObjectName,
                 String mbeanAttributeName,
                 String displayName)

Add item to end of list of those to be obtained

Supported API: true

Parameters:

mbeanObjectName - ObjectName (or ObjectNamePattern) of MBean(s) from which to obtain data

mbeanAttributeName - Name of attribute in 'mbeanObjectName' to obtain; can use .itemName-style suffixes to select CompositeData fields

displayName - Display name to use for this item; used when UseShortFormat is false and FormatString is unspecified

insertInfoItem

void insertInfoItem(int infoItemIdx,
                    ObjectName mbeanObjectName,
                    String mbeanAttributeName,
                    String displayName)

Insert item into list of those to be obtained

Supported API: true

Parameters:

infoItemIdx - Index of item to insert in front of

mbeanObjectName - ObjectName (or ObjectNamePattern) of MBean(s) from which to obtain data

mbeanAttributeName - Name of attribute in 'mbeanObjectName' to obtain; can use .itemName-style suffixes to select CompositeData fields

displayName - Display name to use for this item; used when UseShortFormat is false and FormatString is unspecified

changeInfoItemDisplayName

void changeInfoItemDisplayName(int infoItemIdx,
                               String displayName)

Add item to end of list of those to be obtained

Supported API: true

Parameters:

infoItemIdx - Index of item to change

displayName - Display name to use for this item; used when UseShortFormat is false and FormatString is unspecified

removeInfoItem

void removeInfoItem(int infoItemIdx)

Remove item from list of those to be obtained

Supported API: true

Parameters:

infoItemIdx - Index of item to remove

removeInfoItems

void removeInfoItems()

Remove all items from list of those to be obtained

Supported API: true