javax.management
Class MBeanInfo
- Cloneable, 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.
getClassName() and
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.
getAttributes() and
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
getAttributes() and the
Attribute class can
be used to manipulate them. The remaining methods are classified
as operations and returned by
getOperations().
Beans can also broadcast notifications. If the bean provides this
facility, by implementing the
NotificationBroadcaster
interface, then an array of
MBeanNotificationInfo objects
may be obtained from
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
DynamicMBean.getMBeanInfo() method of
DynamicMBean.
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait |
MBeanInfo
public MBeanInfo(String name,
String desc,
MBeanAttributeInfo[] attribs,
MBeanConstructorInfo[] cons,
MBeanOperationInfo[] ops,
MBeanNotificationInfo[] notifs) Constructs a new
MBeanInfo using the supplied
class name and description with the given attributes,
operations, constructors and notifications. The class
name does not have to actually specify a valid class that
can be loaded by the MBean server or class loader; it merely
has to be a syntactically correct class name. Any of the
arrays may be
null; this will be treated as if
an empty array was supplied. A copy of the arrays is
taken, so later changes have no effect.
name - the name of the class this instance describes.desc - a description of the bean.attribs - the attribute descriptions for the bean,
or null.cons - the constructor descriptions for the bean,
or null.ops - the operation descriptions for the bean,
or null.notifs - the notification descriptions for the bean,
or null.
clone
public Object clone()
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
Object implementation of
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.
- clone in interface Object
equals
public boolean equals(Object obj)
Compares this feature with the supplied object. This returns
true iff the object is an instance of
MBeanInfo and
Object.equals() returns true for a comparison of the
class name and description, and the arrays each contain the same
elements in the same order (but one may be longer than the
other).
- equals in interface Object
obj - the object to compare.
- true if the object is a
MBeanInfo
instance,
className.equals(object.getClassName()),
description.equals(object.getDescription())
and the corresponding elements of the arrays are
equal.
getAttributes
public MBeanAttributeInfo[] getAttributes()
Returns descriptions of each of the attributes provided
by this management bean. The returned value is a shallow
copy of the attribute array maintained by this instance.
Hence, changing the elements of the returned array will not
affect the attribute array, and the elements (instances
of the
MBeanAttributeInfo class) are immutable.
- an array of
MBeanAttributeInfo objects,
representing the attributes emitted by this
management bean.
getConstructors
public MBeanConstructorInfo[] getConstructors()
Returns descriptions of each of the constructors provided
by this management bean. The returned value is a shallow
copy of the constructor array maintained by this instance.
Hence, changing the elements of the returned array will not
affect the constructor array, and the elements (instances
of the
MBeanConstructorInfo class) are immutable.
- an array of
MBeanConstructorInfo objects,
representing the constructors emitted by this
management bean.
getNotifications
public MBeanNotificationInfo[] getNotifications()
Returns descriptions of each of the notifications emitted
by this management bean. The returned value is a shallow
copy of the notification array maintained by this instance.
Hence, changing the elements of the returned array will not
affect the notification array, and the elements (instances
of the
MBeanNotificationInfo class) are immutable.
- an array of
MBeanNotificationInfo objects,
representing the notifications emitted by this
management bean.
getOperations
public MBeanOperationInfo[] getOperations()
Returns descriptions of each of the operations provided
by this management bean. The returned value is a shallow
copy of the operation array maintained by this instance.
Hence, changing the elements of the returned array will not
affect the operation array, and the elements (instances
of the
MBeanOperationInfo class) are immutable.
- an array of
MBeanOperationInfo objects,
representing the operations emitted by this
management bean.
hashCode
public int hashCode()
Returns the hashcode of the information as the sum of the
hashcode of the classname, description and each array.
- hashCode in interface Object
- the hashcode of the information.
toString
public String toString()
Returns a textual representation of this instance. This
is constructed using the class name
(
javax.management.MBeanInfo),
the name and description of the bean and the contents
of the four arrays.
As instances of this class are immutable, the return value
is computed just once for each instance and reused
throughout its life.
- toString in interface Object
- a @link{java.lang.String} instance representing
the instance in textual form.
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.