From 0bd0c35629204cc3a55342d744b04a2635af951a Mon Sep 17 00:00:00 2001 From: Andrew John Hughes Date: Thu, 15 Jun 2006 21:18:53 +0000 Subject: 2006-06-15 Andrew John Hughes * javax/management/AttributeList.java: Add serialization UID. * javax/management/DynamicMBean.java: New file. * javax/management/JMRuntimeException.java: Add serialization UID and correct name of serialized field. * javax/management/MBeanInfo.java: New file. --- ChangeLog | 11 ++ javax/management/AttributeList.java | 5 + javax/management/DynamicMBean.java | 162 +++++++++++++++++++++++ javax/management/MBeanInfo.java | 152 +++++++++++++++++++++ javax/management/RuntimeOperationsException.java | 17 ++- 5 files changed, 341 insertions(+), 6 deletions(-) create mode 100644 javax/management/DynamicMBean.java create mode 100644 javax/management/MBeanInfo.java diff --git a/ChangeLog b/ChangeLog index df1cc67d3..5d7d83290 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2006-06-15 Andrew John Hughes + + * javax/management/AttributeList.java: + Add serialization UID. + * javax/management/DynamicMBean.java: + New file. + * javax/management/JMRuntimeException.java: + Add serialization UID and correct name + of serialized field. + * javax/management/MBeanInfo.java: New file. + 2006-06-15 Andrew John Hughes * javax/management/AttributeList.java, diff --git a/javax/management/AttributeList.java b/javax/management/AttributeList.java index fb4adbca2..6823df3f2 100644 --- a/javax/management/AttributeList.java +++ b/javax/management/AttributeList.java @@ -52,6 +52,11 @@ public class AttributeList extends ArrayList { + /** + * Compatible with JDK 1.5 + */ + private static final long serialVersionUID = -4077085769279709076L; + /** * Constructs an empty list with an initial capacity of ten. * diff --git a/javax/management/DynamicMBean.java b/javax/management/DynamicMBean.java new file mode 100644 index 000000000..b13baefb4 --- /dev/null +++ b/javax/management/DynamicMBean.java @@ -0,0 +1,162 @@ +/* DynamicMBean.java -- A management bean with a dynamic interface. + Copyright (C) 2006 Free Software Foundation, Inc. + +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +02110-1301 USA. + +Linking this library statically or dynamically with other modules is +making a combined work based on this library. Thus, the terms and +conditions of the GNU General Public License cover the whole +combination. + +As a special exception, the copyright holders of this library give you +permission to link this library with independent modules to produce an +executable, regardless of the license terms of these independent +modules, and to copy and distribute the resulting executable under +terms of your choice, provided that you also meet, for each linked +independent module, the terms and conditions of the license of that +module. An independent module is a module which is not derived from +or based on this library. If you modify this library, you may extend +this exception to your version of the library, but you are not +obligated to do so. If you do not wish to do so, delete this +exception statement from your version. */ + +package javax.management; + +/** + * Represents a management bean that provides a + * dynamic interface. Users of a {@link DynamicMBean} + * may retrieve information about its attributes at + * runtime and use this information to dynamically + * obtain the corresponding values of these attributes. + * + * @author Andrew John Hughes (gnu_andrew@member.fsf.org) + * @since 1.5 + */ +public interface DynamicMBean +{ + + /** + * Obtains the value of the specified attribute of the + * management bean. The management bean should perform + * a lookup for the named attribute, and return its value + * by calling the appropriate getter method, if possible. + * + * @param name the name of the attribute to retrieve. + * @return the value of the specified attribute. + * @throws AttributeNotFoundException if the name does not + * correspond to an attribute + * of the bean. + * @throws MBeanException if retrieving the attribute causes + * the bean to throw an exception (which + * becomes the cause of this exception). + * @throws ReflectionException if an exception occurred in trying + * to use the reflection interface + * to lookup the attribute. The + * thrown exception is the cause of + * this exception. + * @see #setAttribute(String) + */ + Object getAttribute(String name) + throws AttributeNotFoundException, MBeanException, + ReflectionException; + + /** + * Obtains the values of each of the specified attributes + * of the management bean. The returned list includes + * those attributes that were retrieved and their + * corresponding values. + * + * @param names the names of the attributes to retrieve. + * @return a list of the retrieved attributes. + * @see #setAttributes(AttributeList) + */ + AttributeList getAttributes(String[] names); + + /** + * Returns an information object which lists the attributes + * and actions associated with the management bean. + * + * @return a description of the management bean, including + * all exposed attributes and actions. + */ + MBeanInfo getMBeanInfo(); + + /** + * Invokes the specified action on the management bean using + * the supplied parameters. The signature of the action is + * specified by a {@link String} array, which lists the classes + * corresponding to each parameter. The class loader used to + * load these classes is the same as that used for loading the + * management bean itself. + * + * @param name the name of the action to invoke. + * @param params the parameters used to call the action. + * @param signature the signature of the action. + * @return the return value of the action. + * @throws MBeanException if the action throws an exception. The + * thrown exception is the cause of this + * exception. + * @throws ReflectionException if an exception occurred in trying + * to use the reflection interface + * to invoke the action. The + * thrown exception is the cause of + * this exception. + */ + Object invoke(String name, Object[] params, String[] signature) + throws MBeanException, ReflectionException; + + /** + * Sets the value of the specified attribute of the + * management bean. The management bean should perform + * a lookup for the named attribute, and sets its value + * using the associated setter method, if possible. + * + * @param attribute the attribute to set. + * @throws AttributeNotFoundException if the attribute does not + * correspond to an attribute + * of the bean. + * @throws InvalidAttributeValueException if the value is invalid + * for this particular + * attribute of the bean. + * @throws MBeanException if setting the attribute causes + * the bean to throw an exception (which + * becomes the cause of this exception). + * @throws ReflectionException if an exception occurred in trying + * to use the reflection interface + * to lookup the attribute. The + * thrown exception is the cause of + * this exception. + * @see #getAttribute(String) + */ + Object setAttribute(Attribute attribute) + throws AttributeNotFoundException, InvalidAttributeValueException, + MBeanException, ReflectionException; + + /** + * Sets the value of each of the specified attributes + * to that supplied by the {@link Attribute} object. + * The returned list contains the attributes that were + * set and their new values. + * + * @param attributes the attributes to set. + * @return a list of the changed attributes. + * @see #getAttributes(AttributeList) + */ + AttributeList setAttributes(AttributeList attributes); + +} diff --git a/javax/management/MBeanInfo.java b/javax/management/MBeanInfo.java new file mode 100644 index 000000000..3aad20e31 --- /dev/null +++ b/javax/management/MBeanInfo.java @@ -0,0 +1,152 @@ +/* MBeanInfo.java -- Information about a management bean. + Copyright (C) 2006 Free Software Foundation, Inc. + +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +02110-1301 USA. + +Linking this library statically or dynamically with other modules is +making a combined work based on this library. Thus, the terms and +conditions of the GNU General Public License cover the whole +combination. + +As a special exception, the copyright holders of this library give you +permission to link this library with independent modules to produce an +executable, regardless of the license terms of these independent +modules, and to copy and distribute the resulting executable under +terms of your choice, provided that you also meet, for each linked +independent module, the terms and conditions of the license of that +module. An independent module is a module which is not derived from +or based on this library. If you modify this library, you may extend +this exception to your version of the library, but you are not +obligated to do so. If you do not wish to do so, delete this +exception statement from your version. */ + +package javax.management; + +import java.io.Serializable; + +/** + *

+ * Describes the interface of a management bean. This allows + * the user to access the bean dynamically, without knowing + * the details of any of its attributes, operations, + * constructors or notifications beforehand. The information + * is immutable as standard. Of course, subclasses may change + * this, but this behaviour is not recommended. + *

+ *

+ * The contents of this class, for standard management beans, + * are dynamically compiled using reflection. + * {@link #getClassName()} and {@link #getConstructors()} + * return the name of the class and its constructors, respectively. + * This is much the same as could be obtained by reflection on the + * bean. {@link #getAttributes()} and {@link #getOperations()}, + * however, do something more in splitting the methods of the + * class into two sets. Those of the form, getXXX, + * setXXX and isXXX are taken to be + * the accessors and mutators of a series of attributes, with + * XXX being the attribute name. These are returned + * by {@link getAttributes()} and the {@link Attribute} class can + * be used to manipulate them. The remaining methods are classified + * as operations and returned by {@link getOperations()}. + *

+ *

+ * Beans can also broadcast notifications. If the bean provides this + * facility, by implementing the {@link NotificationBroadcaster} + * interface, then an array of {@link MBeanNotificationInfo} objects + * may be obtained from {@link #getNotifications()}, which describe + * the notifications emitted. + *

+ *

+ * Model management beans and open management beans also supply an + * instance of this class, as part of implementing the + * {@link DynamicMBean#getMBeanInfo()} method of {@link DynamicMBean}. + *

+ * + * @author Andrew John Hughes (gnu_andrew@member.fsf.org) + * @since 1.5 + */ +public class MBeanInfo + implements Cloneable, Serializable +{ + + /** + * Compatible with JDK 1.5 + */ + private static final long serialVersionUID = -6451021435135161911L; + + /** + * A description of the bean. + * + * @serial The bean's description. + */ + private String description; + + /** + * The class name of the management bean. + * + * @serial The bean's class name. + */ + private String className; + + /** + * Returns a shallow clone of the information. This is + * simply a new copy of each string and a clone + * of each array, which still references the same objects, + * as obtained by the {@link Object} implementation of + * {@link Object#clone()}. As the fields can not be + * changed, this method is only really of interest to + * subclasses which may add new mutable fields or make + * the existing ones mutable. + * + * @return a shallow clone of this {@link MBeanInfo}. + */ + public Object clone() + { + MBeanInfo clone = null; + try + { + clone = (MBeanInfo) super.clone(); + } + catch (CloneNotSupportedException e) + { + /* This won't happen as we implement Cloneable */ + } + return clone; + } + + /** + * Returns the class name of the management bean. + * + * @return the bean's class name. + */ + public String getClassName() + { + return className; + } + + /** + * Returns a description of the management bean. + * + * @return the bean's description. + */ + public String getDescription() + { + return description; + } + +} diff --git a/javax/management/RuntimeOperationsException.java b/javax/management/RuntimeOperationsException.java index c830dd3b7..8a830a5e7 100644 --- a/javax/management/RuntimeOperationsException.java +++ b/javax/management/RuntimeOperationsException.java @@ -52,7 +52,12 @@ package javax.management; public class RuntimeOperationsException extends JMRuntimeException { - + + /** + * Compatible with JDK 1.5 + */ + private static final long serialVersionUID = -8408923047489133588L; + /* Sun re-implemented causality -- don't know why, but serialization demands we do too... */ @@ -61,7 +66,7 @@ public class RuntimeOperationsException * * @serial the target exception. */ - private RuntimeException exception; + private RuntimeException runtimeException; /** * Constructs a new RuntimeOperationsException @@ -72,7 +77,7 @@ public class RuntimeOperationsException public RuntimeOperationsException(RuntimeException e) { super(); - exception = e; + runtimeException = e; } /** @@ -87,7 +92,7 @@ public class RuntimeOperationsException String message) { super(message); - exception = e; + runtimeException = e; } /** @@ -98,7 +103,7 @@ public class RuntimeOperationsException */ public Throwable getCause() { - return exception; + return runtimeException; } /** @@ -109,7 +114,7 @@ public class RuntimeOperationsException */ public RuntimeException getTargetException() { - return exception; + return runtimeException; } } -- cgit v1.2.1