Package org.apache.commons.modeler

Class ManagedBean

java.lang.Object
org.apache.commons.modeler.ManagedBean
All Implemented Interfaces:
Serializable
public class ManagedBean extends Object implements 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:

  • Field Details

    • info

      transient ModelMBeanInfo info
      The ModelMBeanInfo object that corresponds to this ManagedBean instance.

    • attributes

      protected AttributeInfo[] attributes

    • className

      protected String className

    • constructors

      protected ConstructorInfo[] constructors

    • description

      protected String description

    • domain

      protected String domain

    • group

      protected String group

    • name

      protected String name

    • fields

      protected List fields

    • notifications

      protected NotificationInfo[] notifications

    • operations

      protected OperationInfo[] operations

    • type

      protected String type

  • Constructor Details

    • ManagedBean

      public ManagedBean()
      Constructor. Will add default attributes.

  • Method Details

    • getAttributes

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

    • getClassName

      public 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(String className)

    • getConstructors

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

    • getDescription

      public String getDescription()
      The human-readable description of this MBean.

    • setDescription

      public void setDescription(String description)

    • getDomain

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

    • setDomain

      public void setDomain(String domain)

    • getFields

      public 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 String getGroup()
      The (optional) group to which this MBean belongs.

    • setGroup

      public void setGroup(String group)

    • getName

      public 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(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 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(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 ModelMBean createMBean() throws InstanceNotFoundException, InvalidTargetObjectTypeException, MBeanException, 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:
      InstanceNotFoundException - if the managed resource object cannot be found
      InvalidTargetObjectTypeException - if our MBean cannot handle object references (should never happen)
      MBeanException - if a problem occurs instantiating the ModelMBean instance
      RuntimeOperationsException - if a JMX runtime error occurs

    • createMBean

      public ModelMBean createMBean(Object instance) throws InstanceNotFoundException, InvalidTargetObjectTypeException, MBeanException, 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:
      InstanceNotFoundException - if the managed resource object cannot be found
      InvalidTargetObjectTypeException - if our MBean cannot handle object references (should never happen)
      MBeanException - if a problem occurs instantiating the ModelMBean instance
      RuntimeOperationsException - if a JMX runtime error occurs

    • createMBeanInfo

      public ModelMBeanInfo createMBeanInfo()
      Create and return a ModelMBeanInfo object that describes this entire managed bean.

    • toString

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