Class ManagedBean

  • All Implemented Interfaces:
    java.io.Serializable

    public class ManagedBean
    extends java.lang.Object
    implements java.io.Serializable

    Internal configuration information for a managed bean (MBean) descriptor.

    Version:
    $Revision: 480402 $ $Date: 2006-11-29 04:43:23 +0000 (Wed, 29 Nov 2006) $
    Author:
    Craig R. McClanahan
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      ManagedBean()
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAttribute​(AttributeInfo attribute)
      Add a new attribute to the set of attributes for this MBean.
      void addConstructor​(ConstructorInfo constructor)
      Add a new constructor to the set of constructors for this MBean.
      void addField​(FieldInfo field)
      Add a new field to the fields associated with the Descriptor that will be created from this metadata.
      void addNotification​(NotificationInfo notification)
      Add a new notification to the set of notifications for this MBean.
      void addOperation​(OperationInfo operation)
      Add a new operation to the set of operations for this MBean.
      javax.management.modelmbean.ModelMBean createMBean()
      Create and return a ModelMBean that has been preconfigured with the ModelMBeanInfo information for this managed bean, but is not associated with any particular managed resource.
      javax.management.modelmbean.ModelMBean createMBean​(java.lang.Object instance)
      Create and return a ModelMBean that has been preconfigured with the ModelMBeanInfo information for this managed bean, and is associated with the specified managed object instance.
      javax.management.modelmbean.ModelMBeanInfo createMBeanInfo()
      Create and return a ModelMBeanInfo object that describes this entire managed bean.
      AttributeInfo[] getAttributes()
      The collection of attributes for this MBean.
      java.lang.String getClassName()
      The fully qualified name of the Java class of the MBean described by this descriptor.
      ConstructorInfo[] getConstructors()
      The collection of constructors for this MBean.
      java.lang.String getDescription()
      The human-readable description of this MBean.
      java.lang.String getDomain()
      The (optional) ObjectName domain in which this MBean should be registered in the MBeanServer.
      java.util.List getFields()
      Return a List of the FieldInfo objects for the name/value pairs that should be added to the Descriptor created from this metadata.
      java.lang.String getGroup()
      The (optional) group to which this MBean belongs.
      java.lang.String getName()
      The name of this managed bean, which must be unique among all MBeans managed by a particular MBeans server.
      NotificationInfo[] getNotifications()
      The collection of notifications for this MBean.
      OperationInfo[] getOperations()
      The collection of operations for this MBean.
      java.lang.String getType()
      The fully qualified name of the Java class of the resource implementation class described by the managed bean described by this descriptor.
      void setClassName​(java.lang.String className)  
      void setDescription​(java.lang.String description)  
      void setDomain​(java.lang.String domain)  
      void setGroup​(java.lang.String group)  
      void setName​(java.lang.String name)  
      void setType​(java.lang.String type)  
      java.lang.String toString()
      Return a string representation of this managed bean.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • info

        transient javax.management.modelmbean.ModelMBeanInfo info
        The ModelMBeanInfo object that corresponds to this ManagedBean instance.
      • className

        protected java.lang.String className
      • description

        protected java.lang.String description
      • domain

        protected java.lang.String domain
      • group

        protected java.lang.String group
      • name

        protected java.lang.String name
      • fields

        protected java.util.List fields
      • type

        protected java.lang.String type
    • Constructor Detail

      • ManagedBean

        public ManagedBean()
        Constructor. Will add default attributes.
    • Method Detail

      • getAttributes

        public AttributeInfo[] getAttributes()
        The collection of attributes for this MBean.
      • getClassName

        public java.lang.String getClassName()
        The fully qualified name of the Java class of the MBean described by this descriptor. If not specified, the standard JMX class (javax.management.modelmbean.RequiredModeLMBean) will be utilized.
      • setClassName

        public void setClassName​(java.lang.String className)
      • getConstructors

        public ConstructorInfo[] getConstructors()
        The collection of constructors for this MBean.
      • getDescription

        public java.lang.String getDescription()
        The human-readable description of this MBean.
      • setDescription

        public void setDescription​(java.lang.String description)
      • getDomain

        public java.lang.String getDomain()
        The (optional) ObjectName domain in which this MBean should be registered in the MBeanServer.
      • setDomain

        public void setDomain​(java.lang.String domain)
      • getFields

        public java.util.List getFields()

        Return a List of the FieldInfo objects for the name/value pairs that should be added to the Descriptor created from this metadata.

      • getGroup

        public java.lang.String getGroup()
        The (optional) group to which this MBean belongs.
      • setGroup

        public void setGroup​(java.lang.String group)
      • getName

        public java.lang.String getName()
        The name of this managed bean, which must be unique among all MBeans managed by a particular MBeans server.
      • setName

        public void setName​(java.lang.String name)
      • getNotifications

        public NotificationInfo[] getNotifications()
        The collection of notifications for this MBean.
      • getOperations

        public OperationInfo[] getOperations()
        The collection of operations for this MBean.
      • getType

        public java.lang.String getType()
        The fully qualified name of the Java class of the resource implementation class described by the managed bean described by this descriptor.
      • setType

        public void setType​(java.lang.String type)
      • addAttribute

        public void addAttribute​(AttributeInfo attribute)
        Add a new attribute to the set of attributes for this MBean.
        Parameters:
        attribute - The new attribute descriptor
      • addConstructor

        public void addConstructor​(ConstructorInfo constructor)
        Add a new constructor to the set of constructors for this MBean.
        Parameters:
        constructor - The new constructor descriptor
      • addField

        public void addField​(FieldInfo field)

        Add a new field to the fields associated with the Descriptor that will be created from this metadata.

        Parameters:
        field - The field to be added
      • addNotification

        public void addNotification​(NotificationInfo notification)
        Add a new notification to the set of notifications for this MBean.
        Parameters:
        notification - The new notification descriptor
      • addOperation

        public void addOperation​(OperationInfo operation)
        Add a new operation to the set of operations for this MBean.
        Parameters:
        operation - The new operation descriptor
      • createMBean

        public javax.management.modelmbean.ModelMBean createMBean()
                                                           throws javax.management.InstanceNotFoundException,
                                                                  javax.management.modelmbean.InvalidTargetObjectTypeException,
                                                                  javax.management.MBeanException,
                                                                  javax.management.RuntimeOperationsException
        Create and return a ModelMBean that has been preconfigured with the ModelMBeanInfo information for this managed bean, but is not associated with any particular managed resource. The returned ModelMBean will NOT have been registered with our MBeanServer.
        Throws:
        javax.management.InstanceNotFoundException - if the managed resource object cannot be found
        javax.management.modelmbean.InvalidTargetObjectTypeException - if our MBean cannot handle object references (should never happen)
        javax.management.MBeanException - if a problem occurs instantiating the ModelMBean instance
        javax.management.RuntimeOperationsException - if a JMX runtime error occurs
      • createMBean

        public javax.management.modelmbean.ModelMBean createMBean​(java.lang.Object instance)
                                                           throws javax.management.InstanceNotFoundException,
                                                                  javax.management.modelmbean.InvalidTargetObjectTypeException,
                                                                  javax.management.MBeanException,
                                                                  javax.management.RuntimeOperationsException
        Create and return a ModelMBean that has been preconfigured with the ModelMBeanInfo information for this managed bean, and is associated with the specified managed object instance. The returned ModelMBean will NOT have been registered with our MBeanServer.
        Parameters:
        instance - Instanced of the managed object, or null for no associated instance
        Throws:
        javax.management.InstanceNotFoundException - if the managed resource object cannot be found
        javax.management.modelmbean.InvalidTargetObjectTypeException - if our MBean cannot handle object references (should never happen)
        javax.management.MBeanException - if a problem occurs instantiating the ModelMBean instance
        javax.management.RuntimeOperationsException - if a JMX runtime error occurs
      • createMBeanInfo

        public javax.management.modelmbean.ModelMBeanInfo createMBeanInfo()
        Create and return a ModelMBeanInfo object that describes this entire managed bean.
      • toString

        public java.lang.String toString()
        Return a string representation of this managed bean.
        Overrides:
        toString in class java.lang.Object