Package org.apache.tomcat.util.modeler

Class BaseModelMBean

  • All Implemented Interfaces:
    javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.modelmbean.ModelMBeanNotificationBroadcaster, javax.management.NotificationBroadcaster
    Direct Known Subclasses:
    BaseCatalinaMBean, DataSourceUserDatabaseMBean, GroupMBean, NamingResourcesMBean, RequestGroupInfo, RoleMBean, SparseUserDatabaseMBean, UpgradeGroupInfo, UserMBean
    public class BaseModelMBean
extends java.lang.Object
implements javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.modelmbean.ModelMBeanNotificationBroadcaster

    Basic implementation of the DynamicMBean interface, which supports the minimal requirements of the interface contract.

    This can be used directly to wrap an existing java bean, or inside an mlet or anywhere an MBean would be used. Limitations:

    • Only managed resources of type objectReference are supported.
    • Caching of attribute values and operation results is not supported. All calls to invoke() are immediately executed.
    • Persistence of MBean attributes and operations is not supported.
    • All classes referenced as attribute types, operation parameters, or operation return values must be one of the following:
      • One of the Java primitive types (boolean, byte, char, double, float, integer, long, short). Corresponding value will be wrapped in the appropriate wrapper class automatically.
      • Operations that return no value should declare a return type of void.
    • Attribute caching is not supported
    Author:
    Craig R. McClanahan, Costin Manolache

    • Constructor Summary

      Constructors 
      Constructor Description
      BaseModelMBean()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAttributeChangeNotificationListener​(javax.management.NotificationListener listener, java.lang.String name, java.lang.Object handback)
      Add an attribute change notification event listener to this MBean.
      void addNotificationListener​(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback)
      Add a notification event listener to this MBean.
      java.lang.Object getAttribute​(java.lang.String name)
      Obtain and return the value of a specific attribute of this MBean.
      javax.management.AttributeList getAttributes​(java.lang.String[] names)
      Obtain and return the values of several attributes of this MBean.
      java.lang.String getClassName()  
      javax.management.ObjectName getJmxName()  
      java.lang.Object getManagedResource()
      Get the instance handle of the object against which we execute all methods in this ModelMBean management interface.
      javax.management.MBeanInfo getMBeanInfo()
      Return the MBeanInfo object for this MBean.
      java.lang.String getModelerType()  
      javax.management.MBeanNotificationInfo[] getNotificationInfo()
      Return an MBeanNotificationInfo object describing the notifications sent by this MBean.
      java.lang.String getObjectName()  
      java.lang.Object invoke​(java.lang.String name, java.lang.Object[] params, java.lang.String[] signature)
      Invoke a particular method on this MBean, and return any returned value.
      void postDeregister()  
      void postRegister​(java.lang.Boolean registrationDone)  
      void preDeregister()  
      javax.management.ObjectName preRegister​(javax.management.MBeanServer server, javax.management.ObjectName name)  
      void removeAttributeChangeNotificationListener​(javax.management.NotificationListener listener, java.lang.String name)
      Remove an attribute change notification event listener from this MBean.
      void removeNotificationListener​(javax.management.NotificationListener listener)
      Remove a notification event listener from this MBean.
      void sendAttributeChangeNotification​(javax.management.AttributeChangeNotification notification)
      Send an AttributeChangeNotification to all registered listeners.
      void sendAttributeChangeNotification​(javax.management.Attribute oldValue, javax.management.Attribute newValue)
      Send an AttributeChangeNotification to all registered listeners.
      void sendNotification​(java.lang.String message)
      Send a Notification which contains the specified string as a jmx.modelmbean.generic notification.
      void sendNotification​(javax.management.Notification notification)
      Send a Notification to all registered listeners as a jmx.modelmbean.general notification.
      void setAttribute​(javax.management.Attribute attribute)
      Set the value of a specific attribute of this MBean.
      javax.management.AttributeList setAttributes​(javax.management.AttributeList attributes)
      Set the values of several attributes of this MBean.
      void setManagedBean​(ManagedBean managedBean)  
      void setManagedResource​(java.lang.Object resource, java.lang.String type)
      Set the instance handle of the object against which we will execute all methods in this ModelMBean management interface.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • oname

        protected javax.management.ObjectName oname

      • managedBean

        protected ManagedBean managedBean
        Metadata for the mbean instance.

      • resource

        protected java.lang.Object resource
        The managed resource this MBean is associated with (if any).

      • resourceType

        protected java.lang.String resourceType

    • Constructor Detail

      • BaseModelMBean

        public BaseModelMBean()

    • Method Detail

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)
                              throws javax.management.AttributeNotFoundException,
                                     javax.management.MBeanException,
                                     javax.management.ReflectionException
        Obtain and return the value of a specific attribute of this MBean.
        Specified by:
        getAttribute in interface javax.management.DynamicMBean
        Parameters:
        name - Name of the requested attribute
        Throws:
        javax.management.AttributeNotFoundException - if this attribute is not supported by this MBean
        javax.management.MBeanException - if the initializer of an object throws an exception
        javax.management.ReflectionException - if a Java reflection exception occurs when invoking the getter

      • getAttributes

        public javax.management.AttributeList getAttributes​(java.lang.String[] names)
        Obtain and return the values of several attributes of this MBean.
        Specified by:
        getAttributes in interface javax.management.DynamicMBean
        Parameters:
        names - Names of the requested attributes

      • setManagedBean

        public void setManagedBean​(ManagedBean managedBean)

      • getMBeanInfo

        public javax.management.MBeanInfo getMBeanInfo()
        Return the MBeanInfo object for this MBean.
        Specified by:
        getMBeanInfo 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.MBeanException,
                               javax.management.ReflectionException
        Invoke a particular method on this MBean, and return any returned value.

        IMPLEMENTATION NOTE - This implementation will attempt to invoke this method on the MBean itself, or (if not available) on the managed resource object associated with this MBean.

        Specified by:
        invoke in interface javax.management.DynamicMBean
        Parameters:
        name - Name of the operation to be invoked
        params - Array containing the method parameters of this operation
        signature - Array containing the class names representing the signature of this operation
        Throws:
        javax.management.MBeanException - if the initializer of an object throws an exception
        javax.management.ReflectionException - if a Java reflection exception occurs when invoking a method

      • setAttribute

        public void setAttribute​(javax.management.Attribute attribute)
                  throws javax.management.AttributeNotFoundException,
                         javax.management.MBeanException,
                         javax.management.ReflectionException
        Set the value of a specific attribute of this MBean.
        Specified by:
        setAttribute in interface javax.management.DynamicMBean
        Parameters:
        attribute - The identification of the attribute to be set and the new value
        Throws:
        javax.management.AttributeNotFoundException - if this attribute is not supported by this MBean
        javax.management.MBeanException - if the initializer of an object throws an exception
        javax.management.ReflectionException - if a Java reflection exception occurs when invoking the getter

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • setAttributes

        public javax.management.AttributeList setAttributes​(javax.management.AttributeList attributes)
        Set the values of several attributes of this MBean.
        Specified by:
        setAttributes in interface javax.management.DynamicMBean
        Parameters:
        attributes - THe names and values to be set
        Returns:
        The list of attributes that were set and their new values

      • getManagedResource

        public java.lang.Object getManagedResource()
                                    throws javax.management.InstanceNotFoundException,
                                           javax.management.modelmbean.InvalidTargetObjectTypeException,
                                           javax.management.MBeanException,
                                           javax.management.RuntimeOperationsException
        Get the instance handle of the object against which we execute all methods in this ModelMBean management interface.
        Returns:
        the backend managed object
        Throws:
        javax.management.InstanceNotFoundException - if the managed resource object cannot be found
        javax.management.modelmbean.InvalidTargetObjectTypeException - if the managed resource object is of the wrong type
        javax.management.MBeanException - if the initializer of the object throws an exception
        javax.management.RuntimeOperationsException - if the managed resource or the resource type is null or invalid

      • setManagedResource

        public void setManagedResource​(java.lang.Object resource,
                               java.lang.String type)
                        throws javax.management.InstanceNotFoundException,
                               javax.management.MBeanException,
                               javax.management.RuntimeOperationsException
        Set the instance handle of the object against which we will execute all methods in this ModelMBean management interface. The caller can provide the mbean instance or the object name to the resource, if needed.
        Parameters:
        resource - The resource object to be managed
        type - The type of reference for the managed resource ("ObjectReference", "Handle", "IOR", "EJBHandle", or "RMIReference")
        Throws:
        javax.management.InstanceNotFoundException - if the managed resource object cannot be found
        javax.management.MBeanException - if the initializer of the object throws an exception
        javax.management.RuntimeOperationsException - if the managed resource or the resource type is null or invalid

      • addAttributeChangeNotificationListener

        public void addAttributeChangeNotificationListener​(javax.management.NotificationListener listener,
                                                   java.lang.String name,
                                                   java.lang.Object handback)
                                            throws java.lang.IllegalArgumentException
        Add an attribute change notification event listener to this MBean.
        Specified by:
        addAttributeChangeNotificationListener in interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster
        Parameters:
        listener - Listener that will receive event notifications
        name - Name of the attribute of interest, or null to indicate interest in all attributes
        handback - Handback object to be sent along with event notifications
        Throws:
        java.lang.IllegalArgumentException - if the listener parameter is null

      • removeAttributeChangeNotificationListener

        public void removeAttributeChangeNotificationListener​(javax.management.NotificationListener listener,
                                                      java.lang.String name)
                                               throws javax.management.ListenerNotFoundException
        Remove an attribute change notification event listener from this MBean.
        Specified by:
        removeAttributeChangeNotificationListener in interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster
        Parameters:
        listener - The listener to be removed
        name - The attribute name for which no more events are required
        Throws:
        javax.management.ListenerNotFoundException - if this listener is not registered in the MBean

      • sendAttributeChangeNotification

        public void sendAttributeChangeNotification​(javax.management.AttributeChangeNotification notification)
                                     throws javax.management.MBeanException,
                                            javax.management.RuntimeOperationsException
        Send an AttributeChangeNotification to all registered listeners.
        Specified by:
        sendAttributeChangeNotification in interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster
        Parameters:
        notification - The AttributeChangeNotification that will be passed
        Throws:
        javax.management.MBeanException - if an object initializer throws an exception
        javax.management.RuntimeOperationsException - wraps IllegalArgumentException when the specified notification is null or invalid

      • sendAttributeChangeNotification

        public void sendAttributeChangeNotification​(javax.management.Attribute oldValue,
                                            javax.management.Attribute newValue)
                                     throws javax.management.MBeanException,
                                            javax.management.RuntimeOperationsException
        Send an AttributeChangeNotification to all registered listeners.
        Specified by:
        sendAttributeChangeNotification in interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster
        Parameters:
        oldValue - The original value of the Attribute
        newValue - The new value of the Attribute
        Throws:
        javax.management.MBeanException - if an object initializer throws an exception
        javax.management.RuntimeOperationsException - wraps IllegalArgumentException when the specified notification is null or invalid

      • sendNotification

        public void sendNotification​(javax.management.Notification notification)
                      throws javax.management.MBeanException,
                             javax.management.RuntimeOperationsException
        Send a Notification to all registered listeners as a jmx.modelmbean.general notification.
        Specified by:
        sendNotification in interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster
        Parameters:
        notification - The Notification that will be passed
        Throws:
        javax.management.MBeanException - if an object initializer throws an exception
        javax.management.RuntimeOperationsException - wraps IllegalArgumentException when the specified notification is null or invalid

      • sendNotification

        public void sendNotification​(java.lang.String message)
                      throws javax.management.MBeanException,
                             javax.management.RuntimeOperationsException
        Send a Notification which contains the specified string as a jmx.modelmbean.generic notification.
        Specified by:
        sendNotification in interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster
        Parameters:
        message - The message string to be passed
        Throws:
        javax.management.MBeanException - if an object initializer throws an exception
        javax.management.RuntimeOperationsException - wraps IllegalArgumentException when the specified notification is null or invalid

      • addNotificationListener

        public void addNotificationListener​(javax.management.NotificationListener listener,
                                    javax.management.NotificationFilter filter,
                                    java.lang.Object handback)
                             throws java.lang.IllegalArgumentException
        Add a notification event listener to this MBean.
        Specified by:
        addNotificationListener in interface javax.management.NotificationBroadcaster
        Parameters:
        listener - Listener that will receive event notifications
        filter - Filter object used to filter event notifications actually delivered, or null for no filtering
        handback - Handback object to be sent along with event notifications
        Throws:
        java.lang.IllegalArgumentException - if the listener parameter is null

      • getNotificationInfo

        public javax.management.MBeanNotificationInfo[] getNotificationInfo()
        Return an MBeanNotificationInfo object describing the notifications sent by this MBean.
        Specified by:
        getNotificationInfo in interface javax.management.NotificationBroadcaster

      • removeNotificationListener

        public void removeNotificationListener​(javax.management.NotificationListener listener)
                                throws javax.management.ListenerNotFoundException
        Remove a notification event listener from this MBean.
        Specified by:
        removeNotificationListener in interface javax.management.NotificationBroadcaster
        Parameters:
        listener - The listener to be removed (any and all registrations for this listener will be eliminated)
        Throws:
        javax.management.ListenerNotFoundException - if this listener is not registered in the MBean

      • getModelerType

        public java.lang.String getModelerType()

      • getClassName

        public java.lang.String getClassName()

      • getJmxName

        public javax.management.ObjectName getJmxName()

      • getObjectName

        public java.lang.String getObjectName()

      • preRegister

        public javax.management.ObjectName preRegister​(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception
        Specified by:
        preRegister in interface javax.management.MBeanRegistration
        Throws:
        java.lang.Exception

      • postRegister

        public void postRegister​(java.lang.Boolean registrationDone)
        Specified by:
        postRegister in interface javax.management.MBeanRegistration

      • preDeregister

        public void preDeregister()
                   throws java.lang.Exception
        Specified by:
        preDeregister in interface javax.management.MBeanRegistration
        Throws:
        java.lang.Exception

      • postDeregister

        public void postDeregister()
        Specified by:
        postDeregister in interface javax.management.MBeanRegistration