Package org.apache.tomcat.util.modeler
Class BaseModelMBean
- java.lang.Object
-
- org.apache.tomcat.util.modeler.BaseModelMBean
-
- All Implemented Interfaces:
DynamicMBean,MBeanRegistration,ModelMBeanNotificationBroadcaster,NotificationBroadcaster
- Direct Known Subclasses:
BaseCatalinaMBean,GroupMBean,MemoryUserDatabaseMBean,NamingResourcesMBean,RoleMBean,UpgradeGroupInfo,UserMBean
public class BaseModelMBean extends Object implements DynamicMBean, MBeanRegistration, ModelMBeanNotificationBroadcaster
Basic implementation of the
DynamicMBeaninterface, 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
objectReferenceare 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
-
-
Field Summary
Fields Modifier and Type Field Description protected BaseNotificationBroadcasterattributeBroadcasterNotification broadcaster for attribute changes.protected BaseNotificationBroadcastergeneralBroadcasterNotification broadcaster for general notifications.protected ManagedBeanmanagedBeanMetadata for the mbean instance.protected ObjectNameonameprotected ObjectresourceThe managed resource this MBean is associated with (if any).protected StringresourceType
-
Constructor Summary
Constructors Constructor Description BaseModelMBean()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAttributeChangeNotificationListener(NotificationListener listener, String name, Object handback)Add an attribute change notification event listener to this MBean.voidaddNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)Add a notification event listener to this MBean.ObjectgetAttribute(String name)Obtain and return the value of a specific attribute of this MBean.AttributeListgetAttributes(String[] names)Obtain and return the values of several attributes of this MBean.StringgetClassName()ObjectNamegetJmxName()ObjectgetManagedResource()Get the instance handle of the object against which we execute all methods in this ModelMBean management interface.MBeanInfogetMBeanInfo()Return theMBeanInfoobject for this MBean.StringgetModelerType()MBeanNotificationInfo[]getNotificationInfo()Return anMBeanNotificationInfoobject describing the notifications sent by this MBean.StringgetObjectName()Objectinvoke(String name, Object[] params, String[] signature)Invoke a particular method on this MBean, and return any returned value.voidpostDeregister()voidpostRegister(Boolean registrationDone)voidpreDeregister()ObjectNamepreRegister(MBeanServer server, ObjectName name)voidremoveAttributeChangeNotificationListener(NotificationListener listener, String name)Remove an attribute change notification event listener from this MBean.voidremoveNotificationListener(NotificationListener listener)Remove a notification event listener from this MBean.voidsendAttributeChangeNotification(AttributeChangeNotification notification)Send anAttributeChangeNotificationto all registered listeners.voidsendAttributeChangeNotification(Attribute oldValue, Attribute newValue)Send anAttributeChangeNotificationto all registered listeners.voidsendNotification(String message)Send aNotificationwhich contains the specified string as ajmx.modelmbean.genericnotification.voidsendNotification(Notification notification)Send aNotificationto all registered listeners as ajmx.modelmbean.generalnotification.voidsetAttribute(Attribute attribute)Set the value of a specific attribute of this MBean.AttributeListsetAttributes(AttributeList attributes)Set the values of several attributes of this MBean.voidsetManagedBean(ManagedBean managedBean)voidsetManagedResource(Object resource, String type)Set the instance handle of the object against which we will execute all methods in this ModelMBean management interface.StringtoString()
-
-
-
Field Detail
-
oname
protected ObjectName oname
-
attributeBroadcaster
protected BaseNotificationBroadcaster attributeBroadcaster
Notification broadcaster for attribute changes.
-
generalBroadcaster
protected BaseNotificationBroadcaster generalBroadcaster
Notification broadcaster for general notifications.
-
managedBean
protected ManagedBean managedBean
Metadata for the mbean instance.
-
resource
protected Object resource
The managed resource this MBean is associated with (if any).
-
resourceType
protected String resourceType
-
-
Method Detail
-
getAttribute
public Object getAttribute(String name) throws AttributeNotFoundException, MBeanException, ReflectionException
Obtain and return the value of a specific attribute of this MBean.- Specified by:
getAttributein interfaceDynamicMBean- Parameters:
name- Name of the requested attribute- Throws:
AttributeNotFoundException- if this attribute is not supported by this MBeanMBeanException- if the initializer of an object throws an exceptionReflectionException- if a Java reflection exception occurs when invoking the getter
-
getAttributes
public AttributeList getAttributes(String[] names)
Obtain and return the values of several attributes of this MBean.- Specified by:
getAttributesin interfaceDynamicMBean- Parameters:
names- Names of the requested attributes
-
setManagedBean
public void setManagedBean(ManagedBean managedBean)
-
getMBeanInfo
public MBeanInfo getMBeanInfo()
Return theMBeanInfoobject for this MBean.- Specified by:
getMBeanInfoin interfaceDynamicMBean
-
invoke
public Object invoke(String name, Object[] params, String[] signature) throws MBeanException, 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:
invokein interfaceDynamicMBean- Parameters:
name- Name of the operation to be invokedparams- Array containing the method parameters of this operationsignature- Array containing the class names representing the signature of this operation- Throws:
MBeanException- if the initializer of an object throws an exceptionReflectionException- if a Java reflection exception occurs when invoking a method
-
setAttribute
public void setAttribute(Attribute attribute) throws AttributeNotFoundException, MBeanException, ReflectionException
Set the value of a specific attribute of this MBean.- Specified by:
setAttributein interfaceDynamicMBean- Parameters:
attribute- The identification of the attribute to be set and the new value- Throws:
AttributeNotFoundException- if this attribute is not supported by this MBeanMBeanException- if the initializer of an object throws an exceptionReflectionException- if a Java reflection exception occurs when invoking the getter
-
setAttributes
public AttributeList setAttributes(AttributeList attributes)
Set the values of several attributes of this MBean.- Specified by:
setAttributesin interfaceDynamicMBean- Parameters:
attributes- THe names and values to be set- Returns:
- The list of attributes that were set and their new values
-
getManagedResource
public Object getManagedResource() throws InstanceNotFoundException, InvalidTargetObjectTypeException, MBeanException, 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:
InstanceNotFoundException- if the managed resource object cannot be foundInvalidTargetObjectTypeException- if the managed resource object is of the wrong typeMBeanException- if the initializer of the object throws an exceptionRuntimeOperationsException- if the managed resource or the resource type isnullor invalid
-
setManagedResource
public void setManagedResource(Object resource, String type) throws InstanceNotFoundException, MBeanException, 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 managedtype- The type of reference for the managed resource ("ObjectReference", "Handle", "IOR", "EJBHandle", or "RMIReference")- Throws:
InstanceNotFoundException- if the managed resource object cannot be foundMBeanException- if the initializer of the object throws an exceptionRuntimeOperationsException- if the managed resource or the resource type isnullor invalid
-
addAttributeChangeNotificationListener
public void addAttributeChangeNotificationListener(NotificationListener listener, String name, Object handback) throws IllegalArgumentException
Add an attribute change notification event listener to this MBean.- Specified by:
addAttributeChangeNotificationListenerin interfaceModelMBeanNotificationBroadcaster- Parameters:
listener- Listener that will receive event notificationsname- Name of the attribute of interest, ornullto indicate interest in all attributeshandback- Handback object to be sent along with event notifications- Throws:
IllegalArgumentException- if the listener parameter is null
-
removeAttributeChangeNotificationListener
public void removeAttributeChangeNotificationListener(NotificationListener listener, String name) throws ListenerNotFoundException
Remove an attribute change notification event listener from this MBean.- Specified by:
removeAttributeChangeNotificationListenerin interfaceModelMBeanNotificationBroadcaster- Parameters:
listener- The listener to be removedname- The attribute name for which no more events are required- Throws:
ListenerNotFoundException- if this listener is not registered in the MBean
-
sendAttributeChangeNotification
public void sendAttributeChangeNotification(AttributeChangeNotification notification) throws MBeanException, RuntimeOperationsException
Send anAttributeChangeNotificationto all registered listeners.- Specified by:
sendAttributeChangeNotificationin interfaceModelMBeanNotificationBroadcaster- Parameters:
notification- TheAttributeChangeNotificationthat will be passed- Throws:
MBeanException- if an object initializer throws an exceptionRuntimeOperationsException- wraps IllegalArgumentException when the specified notification isnullor invalid
-
sendAttributeChangeNotification
public void sendAttributeChangeNotification(Attribute oldValue, Attribute newValue) throws MBeanException, RuntimeOperationsException
Send anAttributeChangeNotificationto all registered listeners.- Specified by:
sendAttributeChangeNotificationin interfaceModelMBeanNotificationBroadcaster- Parameters:
oldValue- The original value of theAttributenewValue- The new value of theAttribute- Throws:
MBeanException- if an object initializer throws an exceptionRuntimeOperationsException- wraps IllegalArgumentException when the specified notification isnullor invalid
-
sendNotification
public void sendNotification(Notification notification) throws MBeanException, RuntimeOperationsException
Send aNotificationto all registered listeners as ajmx.modelmbean.generalnotification.- Specified by:
sendNotificationin interfaceModelMBeanNotificationBroadcaster- Parameters:
notification- TheNotificationthat will be passed- Throws:
MBeanException- if an object initializer throws an exceptionRuntimeOperationsException- wraps IllegalArgumentException when the specified notification isnullor invalid
-
sendNotification
public void sendNotification(String message) throws MBeanException, RuntimeOperationsException
Send aNotificationwhich contains the specified string as ajmx.modelmbean.genericnotification.- Specified by:
sendNotificationin interfaceModelMBeanNotificationBroadcaster- Parameters:
message- The message string to be passed- Throws:
MBeanException- if an object initializer throws an exceptionRuntimeOperationsException- wraps IllegalArgumentException when the specified notification isnullor invalid
-
addNotificationListener
public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) throws IllegalArgumentException
Add a notification event listener to this MBean.- Specified by:
addNotificationListenerin interfaceNotificationBroadcaster- Parameters:
listener- Listener that will receive event notificationsfilter- Filter object used to filter event notifications actually delivered, ornullfor no filteringhandback- Handback object to be sent along with event notifications- Throws:
IllegalArgumentException- if the listener parameter is null
-
getNotificationInfo
public MBeanNotificationInfo[] getNotificationInfo()
Return anMBeanNotificationInfoobject describing the notifications sent by this MBean.- Specified by:
getNotificationInfoin interfaceNotificationBroadcaster
-
removeNotificationListener
public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException
Remove a notification event listener from this MBean.- Specified by:
removeNotificationListenerin interfaceNotificationBroadcaster- Parameters:
listener- The listener to be removed (any and all registrations for this listener will be eliminated)- Throws:
ListenerNotFoundException- if this listener is not registered in the MBean
-
getModelerType
public String getModelerType()
-
getClassName
public String getClassName()
-
getJmxName
public ObjectName getJmxName()
-
getObjectName
public String getObjectName()
-
preRegister
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception
- Specified by:
preRegisterin interfaceMBeanRegistration- Throws:
Exception
-
postRegister
public void postRegister(Boolean registrationDone)
- Specified by:
postRegisterin interfaceMBeanRegistration
-
preDeregister
public void preDeregister() throws Exception- Specified by:
preDeregisterin interfaceMBeanRegistration- Throws:
Exception
-
postDeregister
public void postDeregister()
- Specified by:
postDeregisterin interfaceMBeanRegistration
-
-