Package org.eclipse.jetty.jmx

Class ObjectMBean

java.lang.Object

org.eclipse.jetty.jmx.ObjectMBean

All Implemented Interfaces:

DynamicMBean

Direct Known Subclasses:

AbstractConnectorMBean, AbstractHandlerMBean, ConnectionStatisticsMBean, DeploymentManagerMBean, FilterMappingMBean, HolderMBean, HttpClientMBean, ServerMBean, ServletMappingMBean, WebAppProviderMBean

public class ObjectMBean
extends Object
implements DynamicMBean

A dynamic MBean that can wrap an arbitrary Object instance.

The attributes and operations exposed by this bean are controlled by the merge of annotations discovered in all superclasses and all superinterfaces.

Given class com.acme.Foo, then com.acme.jmx.FooMBean is searched; if found, it is instantiated with the com.acme.Foo instance passed to the constructor.

Class com.acme.jmx.FooMBean can then override the default behavior of ObjectMBean and provide a custom ObjectName, or custom ObjectName properties name and context, etc.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Object	_managed

Constructor Summary

Constructors

Constructor	Description
ObjectMBean(Object managedObject)	Creates a new ObjectMBean wrapping the given managedObject.

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(String name)
AttributeList	getAttributes(String[] names)
Object	getManagedObject()
MBeanContainer	getMBeanContainer()
MBeanInfo	getMBeanInfo()
String	getObjectContextBasis()	Allows to customize the ObjectName property context.
ObjectName	getObjectName()	Allows to customize the ObjectName of this MBean.
String	getObjectNameBasis()	Allows to customize the ObjectName property name.
Object	invoke(String name, Object[] params, String[] signature)
void	setAttribute(Attribute attribute)
AttributeList	setAttributes(AttributeList attributes)
protected void	setMBeanContainer(MBeanContainer container)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_managed

protected final Object _managed

Constructor Details

ObjectMBean

public ObjectMBean(Object managedObject)

Creates a new ObjectMBean wrapping the given managedObject.

Parameters:

managedObject - the object to manage

Method Details

getManagedObject

public Object getManagedObject()

Returns:

the managed object

getObjectName

public ObjectName getObjectName()

Allows to customize the ObjectName of this MBean.

Returns:

a custom ObjectName, or null to indicate to MBeanContainer to create a default ObjectName

getObjectContextBasis

public String getObjectContextBasis()

Allows to customize the ObjectName property context.

When MBeanContainer creates default ObjectNames, the context property is "inherited" recursively by MBeans that are children of this MBean; this allows to "group" descendant MBeans so that it is clear who is the ancestor they belong to.

For example, if object A has a child component B which has children components C, then AMBean can override this method to return "alpha", and then the ObjectNames will be:

• domain:type=a,context=alpha,id=0
• domain:type=b,context=alpha,id=0
• domain:type=c,context=alpha,id=0
• domain:type=c,context=alpha,id=1

Returns:

a custom value for the property context

getObjectNameBasis

public String getObjectNameBasis()

Allows to customize the ObjectName property name.

Certain components have a natural name and returning it from this method allows it to be part of the ObjectName.

Returns:

a custom value for the property name

setMBeanContainer

protected void setMBeanContainer(MBeanContainer container)

getMBeanContainer

public MBeanContainer getMBeanContainer()

getMBeanInfo

public MBeanInfo getMBeanInfo()

Specified by:

getMBeanInfo in interface DynamicMBean

getAttribute

public Object getAttribute(String name)
                    throws AttributeNotFoundException,
ReflectionException,
MBeanException

Specified by:

getAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

ReflectionException

MBeanException

getAttributes

public AttributeList getAttributes(String[] names)

Specified by:

getAttributes in interface DynamicMBean

setAttribute

public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
ReflectionException,
MBeanException

Specified by:

setAttribute in interface DynamicMBean

Throws:

AttributeNotFoundException

ReflectionException

MBeanException

setAttributes

public AttributeList setAttributes(AttributeList attributes)

Specified by:

setAttributes in interface DynamicMBean

invoke

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

Specified by:

invoke in interface DynamicMBean

Throws:

ReflectionException

MBeanException