Module org.glassfish.gmbal.api

Package org.glassfish.gmbal

Class AMXClient

java.lang.Object

org.glassfish.gmbal.AMXClient

All Implemented Interfaces:

AMXMBeanInterface

public class AMXClient
extends Object
implements AMXMBeanInterface

This class implements a generic AMXMBeanInterface MBean which is connected to a possibly remote MBeanServerConnection (note that MBeanServer isA MBeanServerConnection, so we can actually create an AMXClientImpl simply by using the MBeanServer from the mom: this is useful for testing).

Note that this version of the AMXMBeanInterface API provides a generic get/set API that is identical to DynamicMBean, except that it only throws unchecked exceptions. This is far more convenient in practice than the JMX-standard checked exceptions.

Author:

ken

Field Summary

Fields

Modifier and Type	Field	Description
static final ObjectName	NULL_OBJECTNAME	Special object name used to represent a NULL objectName result.

Constructor Summary

Constructors

Constructor	Description
AMXClient(MBeanServerConnection server, ObjectName oname)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	getAttribute(String attribute)
AttributeList	getAttributes(String[] attributes)
AMXClient[]	getChildren()	Containment hierarchy: Get all AMXMBeanInterface contained by this one, in no particular order.
MBeanInfo	getMBeanInfo()
Map<String,?>	getMeta()	Get all metadata about this MBean.
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.
AMXClient	getParent()	"go up one level": the MBean containing this one, can be null for root
int	hashCode()
Object	invoke(String actionName, Object[] params, String[] signature)
ObjectName	objectName()
void	setAttribute(String name, Object value)
void	setAttribute(Attribute attribute)
AttributeList	setAttributes(AttributeList attributes)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NULL_OBJECTNAME

public static final ObjectName NULL_OBJECTNAME

Special object name used to represent a NULL objectName result.

Constructor Details

AMXClient

public AMXClient(MBeanServerConnection server,
 ObjectName oname)

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: AMXMBeanInterface

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

Specified by:

getName in interface AMXMBeanInterface

getMeta

public Map<String,?> getMeta()

Description copied from interface: AMXMBeanInterface

Get all metadata about this MBean.

Specified by:

getMeta in interface AMXMBeanInterface

Returns:

The descriptor, which will be a ModelMBeanInfoSupport instance.

getParent

public AMXClient getParent()

Description copied from interface: AMXMBeanInterface

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

Specified by:

getParent in interface AMXMBeanInterface

Returns:

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

getChildren

public AMXClient[] getChildren()

Description copied from interface: AMXMBeanInterface

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

Specified by:

getChildren in interface AMXMBeanInterface

Returns:

All children of this AMXMBeanInterface MBean.

getAttribute

public Object getAttribute(String attribute)

setAttribute

public void setAttribute(String name,
 Object value)

setAttribute

public void setAttribute(Attribute attribute)

getAttributes

public AttributeList getAttributes(String[] attributes)

setAttributes

public AttributeList setAttributes(AttributeList attributes)

invoke

public Object invoke(String actionName,
 Object[] params,
 String[] signature)
              throws MBeanException,
ReflectionException

Throws:

MBeanException

ReflectionException

getMBeanInfo

public MBeanInfo getMBeanInfo()

objectName

public ObjectName objectName()