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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected AttributeInfo[]
attributes
protected String
className
protected ConstructorInfo[]
constructors
protected String
description
protected String
domain
protected List
fields
protected String
group
protected String
name
protected NotificationInfo[]
notifications
protected OperationInfo[]
operations
protected String
type
-
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.ModelMBean
createMBean()
Create and return aModelMBean
that has been preconfigured with theModelMBeanInfo
information for this managed bean, but is not associated with any particular managed resource.ModelMBean
createMBean(Object instance)
Create and return aModelMBean
that has been preconfigured with theModelMBeanInfo
information for this managed bean, and is associated with the specified managed object instance.ModelMBeanInfo
createMBeanInfo()
Create and return aModelMBeanInfo
object that describes this entire managed bean.AttributeInfo[]
getAttributes()
The collection of attributes for this MBean.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.String
getDescription()
The human-readable description of this MBean.String
getDomain()
The (optional)ObjectName
domain in which this MBean should be registered in the MBeanServer.List
getFields()
Return aList
of theFieldInfo
objects for the name/value pairs that should be added to the Descriptor created from this metadata.String
getGroup()
The (optional) group to which this MBean belongs.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.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(String className)
void
setDescription(String description)
void
setDomain(String domain)
void
setGroup(String group)
void
setName(String name)
void
setType(String type)
String
toString()
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
-
group
protected String group
-
name
protected String name
-
fields
protected List fields
-
notifications
protected NotificationInfo[] notifications
-
operations
protected OperationInfo[] operations
-
type
protected String type
-
-
Method Detail
-
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 theFieldInfo
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 aModelMBean
that has been preconfigured with theModelMBeanInfo
information for this managed bean, but is not associated with any particular managed resource. The returnedModelMBean
will NOT have been registered with ourMBeanServer
.- Throws:
InstanceNotFoundException
- if the managed resource object cannot be foundInvalidTargetObjectTypeException
- if our MBean cannot handle object references (should never happen)MBeanException
- if a problem occurs instantiating theModelMBean
instanceRuntimeOperationsException
- if a JMX runtime error occurs
-
createMBean
public ModelMBean createMBean(Object instance) throws InstanceNotFoundException, InvalidTargetObjectTypeException, MBeanException, RuntimeOperationsException
Create and return aModelMBean
that has been preconfigured with theModelMBeanInfo
information for this managed bean, and is associated with the specified managed object instance. The returnedModelMBean
will NOT have been registered with ourMBeanServer
.- Parameters:
instance
- Instanced of the managed object, ornull
for no associated instance- Throws:
InstanceNotFoundException
- if the managed resource object cannot be foundInvalidTargetObjectTypeException
- if our MBean cannot handle object references (should never happen)MBeanException
- if a problem occurs instantiating theModelMBean
instanceRuntimeOperationsException
- if a JMX runtime error occurs
-
createMBeanInfo
public ModelMBeanInfo createMBeanInfo()
Create and return aModelMBeanInfo
object that describes this entire managed bean.
-
-