org.eclipse.jetty.jmx

Class ObjectMBean

java.lang.Object

org.eclipse.jetty.jmx.ObjectMBean

All Implemented Interfaces:

javax.management.DynamicMBean

Direct Known Subclasses:

AbstractConnectorMBean, AbstractHandlerMBean, DeploymentManagerMBean, FilterMappingMBean, HolderMBean, HttpClientMBean, LogMBean, ServerMBean, ServletMappingMBean

public class ObjectMBean
extends java.lang.Object
implements javax.management.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 and Description
protected java.lang.Object	_managed

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String name)
javax.management.AttributeList	getAttributes(java.lang.String[] names)
java.lang.Object	getManagedObject()
MBeanContainer	getMBeanContainer()
javax.management.MBeanInfo	getMBeanInfo()
java.lang.String	getObjectContextBasis() Allows to customize the ObjectName property context.
javax.management.ObjectName	getObjectName() Allows to customize the ObjectName of this MBean.
java.lang.String	getObjectNameBasis() Allows to customize the ObjectName property name.
java.lang.Object	invoke(java.lang.String name, java.lang.Object[] params, java.lang.String[] signature)
static java.lang.Object	mbeanFor(java.lang.Object o) Deprecated. Use MBeanContainer.mbeanFor(Object) instead
void	setAttribute(javax.management.Attribute attribute)
javax.management.AttributeList	setAttributes(javax.management.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 Detail

_managed

protected final java.lang.Object _managed

Constructor Detail

ObjectMBean

public ObjectMBean(java.lang.Object managedObject)

Creates a new ObjectMBean wrapping the given managedObject.

Parameters:

managedObject - the object to manage

Method Detail

getManagedObject

public java.lang.Object getManagedObject()

Returns:

the managed object

getObjectName

public javax.management.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 java.lang.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 java.lang.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()

mbeanFor

@Deprecated
public static java.lang.Object mbeanFor(java.lang.Object o)

Deprecated. Use MBeanContainer.mbeanFor(Object) instead

Parameters:

o - the object to wrap as MBean

Returns:

a new instance of an MBean for the object or null if the MBean cannot be created

getMBeanInfo

public javax.management.MBeanInfo getMBeanInfo()

Specified by:

getMBeanInfo in interface javax.management.DynamicMBean

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
                              throws javax.management.AttributeNotFoundException,
                                     javax.management.ReflectionException,
                                     javax.management.MBeanException

Specified by:

getAttribute in interface javax.management.DynamicMBean

Throws:

javax.management.AttributeNotFoundException

javax.management.ReflectionException

javax.management.MBeanException

getAttributes

public javax.management.AttributeList getAttributes(java.lang.String[] names)

Specified by:

getAttributes in interface javax.management.DynamicMBean

setAttribute

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

Specified by:

setAttribute in interface javax.management.DynamicMBean

Throws:

javax.management.AttributeNotFoundException

javax.management.ReflectionException

javax.management.MBeanException

setAttributes

public javax.management.AttributeList setAttributes(javax.management.AttributeList attributes)

Specified by:

setAttributes in interface javax.management.DynamicMBean

invoke

public java.lang.Object invoke(java.lang.String name,
                               java.lang.Object[] params,
                               java.lang.String[] signature)
                        throws javax.management.ReflectionException,
                               javax.management.MBeanException

Specified by:

invoke in interface javax.management.DynamicMBean

Throws:

javax.management.ReflectionException

javax.management.MBeanException