Top Description Methods
org.glassfish.gmbal

public Interface AMXMBeanInterface

Known Direct Implementers
org.glassfish.gmbal.AMXClient
Annotations
@ManagedObject
@Description:Base interface for any MBean that works in the AMX framework
Imports
java.util.Map, org.glassfish.external.amx.AMX
Base interface supported by all AMXMBeanInterface MBeans. All MBeans generated by gmbal comply with this interface, which means that the attributes and operations defined in this Java interface all appear in each MBean generated by calling ManagedObjectManager.register.
Authors
LLoyd Chambers, Ken Cavanaugh

Method Summary

Modifier and TypeMethod and Description
public AMXMBeanInterface[]

Returns:

All children of this AMXMBeanInterface MBean.
getChildren()

Containment hierarchy: Get all AMXMBeanInterface contained by this one, in no particular order.

public Map<String, ?>

Returns:

The descriptor, which will be a ModelMBeanInfoSupport instance.
getMeta()

Get all metadata about this MBean.

public String
getName()

Usually the same as the ObjectName 'name' property, but can differ if the actual name contains characters that must be escaped for an ObjectName and/or if the MBean has a mutable name attribute.

public AMXMBeanInterface

Returns:

The container of this MBean (null if already at root).
getParent()

"go up one level": the MBean containing this one, can be null for root

Method Detail

getChildrenback to summary
public AMXMBeanInterface[] getChildren()

Containment hierarchy: Get all AMXMBeanInterface contained by this one, in no particular order. Valid only if isContainer(). Note that using an array sidesteps Map/Set/OpenType issues

Returns:AMXMBeanInterface[]

All children of this AMXMBeanInterface MBean.

Annotations
@ManagedAttribute
id:Children
@Description:All children of this AMX MBean
getMetaback to summary
public Map<String, ?> getMeta()

Get all metadata about this MBean.

Returns:Map<String, ?>

The descriptor, which will be a ModelMBeanInfoSupport instance.

getNameback to summary
public String getName()

Usually the same as the ObjectName 'name' property, but can differ if the actual name contains characters that must be escaped for an ObjectName and/or if the MBean has a mutable name attribute. The type property can be obtained from the ObjectName

Annotations
@ManagedAttribute
id:Name
@Description:Return the name of this MBean.
getParentback to summary
public AMXMBeanInterface getParent()

"go up one level": the MBean containing this one, can be null for root

Returns:AMXMBeanInterface

The container of this MBean (null if already at root).

Annotations
@ManagedAttribute
id:Parent
@Description:The container that contains this MBean