ModelMBeanImpl

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> mortbay >> util >> [ jmx overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.mortbay.util.jmx.ModelMBeanImpl

SOURCE |

Download org.mortbay.util.jmx.ModelMBeanImpl

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.mortbay.util.jmx
Class ModelMBeanImpl

java.lang.Object
  org.mortbay.util.jmx.ModelMBeanImpl

All Implemented Interfaces:: javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.modelmbean.ModelMBean, javax.management.modelmbean.ModelMBeanNotificationBroadcaster, javax.management.NotificationBroadcaster, javax.management.PersistentMBean

Direct Known Subclasses:: CodeMBean, LifeCycleMBean, LogMBean, TestModelMBean

public class ModelMBeanImpl
extends java.lang.Object
implements javax.management.modelmbean.ModelMBean, javax.management.MBeanRegistration

Model MBean Implementation. This implementation of the JMX Model MBean API is designed to allow easy creation of Model MBeans. From minimal descriptions of operations and attributes, reflection is used to determine the full signature and ResourceBundles are used to determine other meta data. This class is normally used in one of the following patterns:

As a base class for a real MBean that contains the actual attributes and operations of the MBean. Such an Object is only usable in a JMX environment.
As a proxy MBean to another non-JMX object. The attributes and operations of the proxied object are defined in the MBean. This pattern is used when an existing non-JMX objects API is to be exposed as an MBean.
As a base class for a proxy MBean. The attributes and oepration of the MBean are implemented by the derived class but delegate to one or more other objects. This pattern is used if existing objects are to be managed by JMX, but a new management API needs to be defined.

Version:: $Revision: 1.8 $

Field Detail

log

private static org.apache.commons.logging.Log log

IMPACT_ACTION

public static final int IMPACT_ACTION

See Also:: Constant Field Values

IMPACT_ACTION_INFO

public static final int IMPACT_ACTION_INFO

See Also:: Constant Field Values

IMPACT_INFO

public static final int IMPACT_INFO

See Also:: Constant Field Values

IMPACT_UNKOWN

public static final int IMPACT_UNKOWN

See Also:: Constant Field Values

STRING

public static final java.lang.String STRING

See Also:: Constant Field Values

OBJECT

public static final java.lang.String OBJECT

See Also:: Constant Field Values

INT

public static final java.lang.String INT

See Also:: Constant Field Values

NO_PARAMS

public static final java.lang.String[] NO_PARAMS

READ_WRITE

public static final boolean READ_WRITE

See Also:: Constant Field Values

READ_ONLY

public static final boolean READ_ONLY

See Also:: Constant Field Values

ON_MBEAN

public static final boolean ON_MBEAN

See Also:: Constant Field Values

ON_OBJECT

public static final boolean ON_OBJECT

See Also:: Constant Field Values

__objectId

private static java.util.HashMap __objectId

__defaultDomain

private static java.lang.String __defaultDomain

_beanInfo

protected javax.management.modelmbean.ModelMBeanInfoSupport _beanInfo

_mBeanServer

private javax.management.MBeanServer _mBeanServer

_object

private java.lang.Object _object

_objectName

private javax.management.ObjectName _objectName

_dirty

private boolean _dirty

_getter

private java.util.HashMap _getter

_setter

private java.util.HashMap _setter

_method

private java.util.HashMap _method

_attributes

private java.util.ArrayList _attributes

_operations

private java.util.ArrayList _operations

_notifications

private java.util.ArrayList _notifications

_baseObjectName

private java.lang.String _baseObjectName

_components

private java.util.Map _components

Constructor Detail

ModelMBeanImpl

public ModelMBeanImpl()

MBean Constructor. No proxy object is defined. Attributes and operations are defined on this instance.

ModelMBeanImpl

public ModelMBeanImpl(java.lang.Object proxyObject)

Proxy MBean Constructor.

Method Detail

mbeanFor

public static javax.management.modelmbean.ModelMBean mbeanFor(java.lang.Object o)

Create MBean for Object. Attempts to create an MBean for the object by searching the package and class name space. For example an object of the type

   class com.acme.MyClass extends com.acme.util.BaseClass

Then this method would look for the following classes:

com.acme.MyClassMBean
com.acme.jmx.MyClassMBean
com.acme.util.BaseClassMBean
com.acme.util.jmx.BaseClassMBean

getDefaultDomain

public static java.lang.String getDefaultDomain()

setDefaultDomain

public static void setDefaultDomain(java.lang.String d)

getMBeanServer

public javax.management.MBeanServer getMBeanServer()

getObjectName

public javax.management.ObjectName getObjectName()

getManagedResource

public java.lang.Object getManagedResource()

setManagedResource

public void setManagedResource(java.lang.Object proxyObject,
                               java.lang.String type)
                        throws javax.management.MBeanException,
                               javax.management.RuntimeOperationsException,
                               javax.management.InstanceNotFoundException,
                               javax.management.modelmbean.InvalidTargetObjectTypeException

Specified by:: setManagedResource in interface javax.management.modelmbean.ModelMBean

defineManagedResource

protected void defineManagedResource()

Define the Managed Resource. This method is called the first time setManagedResource is called with a non-null object. It should be implemented by a derived ModelMBean to define the attributes and operations after an initial object has been set.

setModelMBeanInfo

public void setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo info)
                       throws javax.management.MBeanException,
                              javax.management.RuntimeOperationsException

Not Supported. Use RequiredModelMBean for this style of MBean creation.

Specified by:: setModelMBeanInfo in interface javax.management.modelmbean.ModelMBean

defineAttribute

public void defineAttribute(java.lang.String name)

Define an attribute on the managed object. The meta data is defined by looking for standard getter and setter methods. Descriptions are obtained with a call to findDescription with the attribute name.

defineAttribute

public void defineAttribute(java.lang.String name,
                            boolean writable)

defineAttribute

public void defineAttribute(java.lang.String name,
                            boolean writable,
                            boolean onMBean)

defineAttribute

public void defineAttribute(javax.management.modelmbean.ModelMBeanAttributeInfo attrInfo)

Define an attribute. Explicit definition of an attribute. Reflection is used to locate the actual getter and setter methods.

defineOperation

public void defineOperation(java.lang.String name,
                            int impact)

Define an operation on the managed object. Defines an operation with no parameters. Refection is used to determine the return type and the description is found with a call to findDescription on "name()".

defineOperation

public void defineOperation(java.lang.String name,
                            java.lang.String[] signature,
                            int impact)

Define an operation on the managed object. Defines an operation with parameters. Refection is used to determine find the method and it's return type. The description of the method is found with a call to findDescription on "name(signature)". The name and description of each parameter is found with a call to findDescription with "name(partialSignature", the returned description is for the last parameter of the partial signature and is assumed to start with the parameter name, followed by a colon.

defineOperation

public void defineOperation(javax.management.modelmbean.ModelMBeanOperationInfo opInfo)

Define an operation. Explicit definition of an operation. Reflection is used to locate method called.