Home » openjdk-7 » javax » management » modelmbean » [javadoc | source]
javax.management.modelmbean
public class: ModelMBeanInfoSupport [javadoc | source]
java.lang.Object
   javax.management.MBeanInfo
      javax.management.modelmbean.ModelMBeanInfoSupport

All Implemented Interfaces:
    ModelMBeanInfo, Cloneable, DescriptorRead, java$io$Serializable

This class represents the meta data for ModelMBeans. Descriptors have been added on the meta data objects.

Java resources wishing to be manageable instantiate the ModelMBean using the MBeanServer's createMBean method. The resource then sets the ModelMBeanInfo and Descriptors for the ModelMBean instance. The attributes and operations exposed via the ModelMBeanInfo for the ModelMBean are accessible from MBeans, connectors/adaptors like other MBeans. Through the Descriptors, values and methods in the managed application can be defined and mapped to attributes and operations of the ModelMBean. This mapping can be defined during development in a file or dynamically and programmatically at runtime.

Every ModelMBean which is instantiated in the MBeanServer becomes manageable: its attributes and operations become remotely accessible through the connectors/adaptors connected to that MBeanServer. A Java object cannot be registered in the MBeanServer unless it is a JMX compliant MBean. By instantiating a ModelMBean, resources are guaranteed that the MBean is valid. MBeanException and RuntimeOperationsException must be thrown on every public method. This allows for wrapping exceptions from distributed communications (RMI, EJB, etc.)

The serialVersionUID of this class is -1935722590756516193L.

Fields inherited from javax.management.MBeanInfo:
serialVersionUID
Constructor:
 public ModelMBeanInfoSupport(ModelMBeanInfo mbi) 
    Constructs a ModelMBeanInfoSupport which is a duplicate of the given ModelMBeanInfo. The returned object is a shallow copy of the given object. Neither the Descriptor nor the contained arrays ({@code ModelMBeanAttributeInfo[]} etc) are cloned. This method is chiefly of interest to modify the Descriptor of the returned instance via setDescriptor without affecting the Descriptor of the original object.
    Parameters:
    mbi - the ModelMBeanInfo instance from which the ModelMBeanInfo being created is initialized.
 public ModelMBeanInfoSupport(String className,
    String description,
    ModelMBeanAttributeInfo[] attributes,
    ModelMBeanConstructorInfo[] constructors,
    ModelMBeanOperationInfo[] operations,
    ModelMBeanNotificationInfo[] notifications) 
    Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default. The default descriptor is: name=className, descriptorType="mbean", displayName=className, persistPolicy="never", log="F", visibility="1"
    Parameters:
    className - classname of the MBean
    description - human readable description of the ModelMBean
    attributes - array of ModelMBeanAttributeInfo objects which have descriptors
    constructors - array of ModelMBeanConstructorInfo objects which have descriptors
    operations - array of ModelMBeanOperationInfo objects which have descriptors
    notifications - array of ModelMBeanNotificationInfo objects which have descriptors
 public ModelMBeanInfoSupport(String className,
    String description,
    ModelMBeanAttributeInfo[] attributes,
    ModelMBeanConstructorInfo[] constructors,
    ModelMBeanOperationInfo[] operations,
    ModelMBeanNotificationInfo[] notifications,
    Descriptor mbeandescriptor) 
    Creates a ModelMBeanInfoSupport with the provided information and the descriptor given in parameter.
    Parameters:
    className - classname of the MBean
    description - human readable description of the ModelMBean
    attributes - array of ModelMBeanAttributeInfo objects which have descriptors
    constructors - array of ModelMBeanConstructorInfo objects which have descriptor
    operations - array of ModelMBeanOperationInfo objects which have descriptor
    notifications - array of ModelMBeanNotificationInfo objects which have descriptor
    mbeandescriptor - descriptor to be used as the MBeanDescriptor containing MBean wide policy. If the descriptor is null, a default descriptor will be constructed. The default descriptor is: name=className, descriptorType="mbean", displayName=className, persistPolicy="never", log="F", visibility="1". If the descriptor does not contain all of these fields, the missing ones are added with these default values.
    Throws:
    RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor passed in parameter. (see getMBeanDescriptor for the definition of a valid MBean descriptor.)
    exception: RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor passed in parameter. (see getMBeanDescriptor for the definition of a valid MBean descriptor.)
Method from javax.management.modelmbean.ModelMBeanInfoSupport Summary:
clone,   getAttribute,   getConstructor,   getDescriptor,   getDescriptor,   getDescriptor,   getDescriptors,   getMBeanDescriptor,   getNotification,   getOperation,   setDescriptor,   setDescriptors,   setMBeanDescriptor
Methods from javax.management.MBeanInfo:
arrayGettersSafe,   clone,   equals,   getAttributes,   getClassName,   getConstructors,   getDescription,   getDescriptor,   getNotifications,   getOperations,   hashCode,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.management.modelmbean.ModelMBeanInfoSupport Detail:
 public Object clone() 
    Returns a shallow clone of this instance. Neither the Descriptor nor the contained arrays ({@code ModelMBeanAttributeInfo[]} etc) are cloned. This method is chiefly of interest to modify the Descriptor of the clone via setDescriptor without affecting the Descriptor of the original object.
 public ModelMBeanAttributeInfo getAttribute(String inName) throws MBeanException, RuntimeOperationsException 
 public ModelMBeanConstructorInfo getConstructor(String inName) throws MBeanException, RuntimeOperationsException 
    Returns the ModelMBeanConstructorInfo requested by name. If no ModelMBeanConstructorInfo exists for this name null is returned.
 public Descriptor getDescriptor() 
 public Descriptor getDescriptor(String inDescriptorName) throws MBeanException, RuntimeOperationsException 
    Returns a Descriptor requested by name.
 public Descriptor getDescriptor(String inDescriptorName,
    String inDescriptorType) throws MBeanException, RuntimeOperationsException 
 public Descriptor[] getDescriptors(String inDescriptorType) throws MBeanException, RuntimeOperationsException 
 public Descriptor getMBeanDescriptor() throws MBeanException 
 public ModelMBeanNotificationInfo getNotification(String inName) throws MBeanException, RuntimeOperationsException 
 public ModelMBeanOperationInfo getOperation(String inName) throws MBeanException, RuntimeOperationsException 
 public  void setDescriptor(Descriptor inDescriptor,
    String inDescriptorType) throws MBeanException, RuntimeOperationsException 
 public  void setDescriptors(Descriptor[] inDescriptors) throws MBeanException, RuntimeOperationsException 
 public  void setMBeanDescriptor(Descriptor inMBeanDescriptor) throws MBeanException, RuntimeOperationsException