org.apache.commons.modeler

Class ManagedBean

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: 1.9 $ $Date: 2003/07/20 07:35:13 $
Author:
Craig R. McClanahan
See Also:
Serialized Form

Field Summary

protected AttributeInfo[]
attributes
protected String
className
protected ConstructorInfo[]
constructors
protected String
description
protected String
domain
protected List
fields
protected String
group
(package private) ModelMBeanInfo
info
The ModelMBeanInfo object that corresponds to this ManagedBean instance.
protected String
name
protected NotificationInfo[]
notifications
protected OperationInfo[]
operations
protected String
type

Constructor Summary

ManagedBean()
Constructor.

Method Summary

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 a ModelMBean that has been preconfigured with the ModelMBeanInfo information for this managed bean, but is not associated with any particular managed resource.
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.
ModelMBeanInfo
createMBeanInfo()
Create and return a ModelMBeanInfo 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 a List of the FieldInfo 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 Details

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

info

(package private)  ModelMBeanInfo info
The ModelMBeanInfo object that corresponds to this ManagedBean instance.

name

protected String name

notifications

protected NotificationInfo[] notifications

operations

protected OperationInfo[] operations

type

protected String type

Constructor Details

ManagedBean

public ManagedBean()
Constructor. Will add default attributes.

Method Details

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.

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

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 (c) 2001-2003 - Apache Software Foundation