org.apache.commons.modeler

Class ManagedBean

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

Field Summary
protected AttributeInfo[]attributes
protected StringclassName
protected ConstructorInfo[]constructors
protected Stringdescription
protected Stringdomain
protected Listfields
protected Stringgroup
protected Stringname
protected NotificationInfo[]notifications
protected OperationInfo[]operations
protected Stringtype
Constructor Summary
ManagedBean()
Constructor.
Method Summary
voidaddAttribute(AttributeInfo attribute)
Add a new attribute to the set of attributes for this MBean.
voidaddConstructor(ConstructorInfo constructor)
Add a new constructor to the set of constructors for this MBean.
voidaddField(FieldInfo field)

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

voidaddNotification(NotificationInfo notification)
Add a new notification to the set of notifications for this MBean.
voidaddOperation(OperationInfo operation)
Add a new operation to the set of operations for this MBean.
ModelMBeancreateMBean()
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.
ModelMBeancreateMBean(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.
ModelMBeanInfocreateMBeanInfo()
Create and return a ModelMBeanInfo object that describes this entire managed bean.
AttributeInfo[]getAttributes()
The collection of attributes for this MBean.
StringgetClassName()
The fully qualified name of the Java class of the MBean described by this descriptor.
ConstructorInfo[]getConstructors()
The collection of constructors for this MBean.
StringgetDescription()
The human-readable description of this MBean.
StringgetDomain()
The (optional) ObjectName domain in which this MBean should be registered in the MBeanServer.
ListgetFields()

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

StringgetGroup()
The (optional) group to which this MBean belongs.
StringgetName()
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.
StringgetType()
The fully qualified name of the Java class of the resource implementation class described by the managed bean described by this descriptor.
voidsetClassName(String className)
voidsetDescription(String description)
voidsetDomain(String domain)
voidsetGroup(String group)
voidsetName(String name)
voidsetType(String type)
StringtoString()
Return a string representation of this managed bean.

Field Detail

attributes

protected AttributeInfo[] attributes

className

protected String className

constructors

protected ConstructorInfo[] constructors

description

protected String description

domain

protected String domain

fields

protected List fields

group

protected String group

name

protected String name

notifications

protected NotificationInfo[] notifications

operations

protected OperationInfo[] operations

type

protected String type

Constructor Detail

ManagedBean

public ManagedBean()
Constructor. Will add default attributes.

Method Detail

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()
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)
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.

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.

getConstructors

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

getDescription

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

getDomain

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

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.

getName

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

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.

setClassName

public void setClassName(String className)

setDescription

public void setDescription(String description)

setDomain

public void setDomain(String domain)

setGroup

public void setGroup(String group)

setName

public void setName(String name)

setType

public void setType(String type)

toString

public String toString()
Return a string representation of this managed bean.
Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.