|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.management.MBeanInfo | +--javax.management.modelmbean.ModelMBeanInfoSupport
This class represents the meta data for ModelMBeans. Descriptors have been added on the meta data objects.
Java resources wishing to be manageable instatiate the ModelMBean using the MBeanServer's createMBean method. The resource then sets the ModelMBeanInfo and Descriptors for the ModelMBean instance. The attributes and operations exposed via the ModelMBeanInfo for the ModelMBean are accessible from Mbeans, connectors/adapters like other MBeans. Through the Descriptors, values and methods in the managed application can be defined and mapped to attributes and operations of the ModelMBean. This mapping can be defined during development in a file or dynamically and programmatically at runtime.
Every ModelMBean which is instantiated in the MBeanServer becomes manageable: its attributes and operations become remotely accessible through the connectors/adaptors connected to that MBeanServer. A Java object cannot be registered in the MBeanServer unless it is a JMX compliant MBean. By instantiating a ModelMBean, resources are guaranteed that the MBean is valid. MBeanException and RuntimeOperationsException must be thrown on every public method. This allows for wrappering exceptions from distributed communications (RMI, EJB, etc.)
Constructor Summary | |
ModelMBeanInfoSupport(ModelMBeanInfo mbi)
Constructs a ModelMBeanInfoSupport which is a duplicate of the one passed in. |
|
ModelMBeanInfoSupport(java.lang.String className,
java.lang.String description,
ModelMBeanAttributeInfo[] attributes,
ModelMBeanConstructorInfo[] constructors,
ModelMBeanOperationInfo[] operations,
ModelMBeanNotificationInfo[] notifications)
Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default. |
|
ModelMBeanInfoSupport(java.lang.String className,
java.lang.String description,
ModelMBeanAttributeInfo[] attributes,
ModelMBeanConstructorInfo[] constructors,
ModelMBeanOperationInfo[] operations,
ModelMBeanNotificationInfo[] notifications,
Descriptor mbeandescriptor)
Creates a ModelMBeanInfoSupport with the provided information |
Method Summary | |
java.lang.Object |
clone()
To clone this ModelMBeanInfo implementation object as ModelMBeanInfoSupport object. |
ModelMBeanAttributeInfo |
getAttribute(java.lang.String inName)
Returns a ModelMBeanAttributeInfo requested by name. |
MBeanAttributeInfo[] |
getAttributes()
Gets the attributes info of the ModelMBean targetted object. |
java.lang.String |
getClassName()
Returns the name of the Java class of the MBean described by this ModelMBeanInfo. |
ModelMBeanConstructorInfo |
getConstructor(java.lang.String inName)
Returns a ModelMBeanConstructorInfo requested by name. |
MBeanConstructorInfo[] |
getConstructors()
Gets the constructors info of the ModelMBean targetted object. |
java.lang.String |
getDescription()
Returns a human readable description of the MBean. |
Descriptor |
getDescriptor(java.lang.String inDescriptorName)
Returns a Descriptor requested by name |
Descriptor |
getDescriptor(java.lang.String inDescriptorName,
java.lang.String inDescriptorType)
Returns a Descriptor requested by name and descriptorType. |
Descriptor[] |
getDescriptors(java.lang.String inDescriptorType)
Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo including the MBean Descriptor, attribute Descriptors, operation Descriptors, constructor Descriptors, and notification Descriptors. |
Descriptor |
getMBeanDescriptor()
Returns a MBean's descriptor. |
ModelMBeanNotificationInfo |
getNotification(java.lang.String inName)
Returns a ModelMBeanNotificationInfo requested by name. |
MBeanNotificationInfo[] |
getNotifications()
Gets the notifications info emitted by the ModelMBean targetted object. |
ModelMBeanOperationInfo |
getOperation(java.lang.String inName)
Returns a ModelMBeanOperationInfo requested by name. |
MBeanOperationInfo[] |
getOperations()
Gets the operations info of the ModelMBean targetted object. |
void |
setDescriptor(Descriptor inDescriptor,
java.lang.String inDescriptorType)
Adds or replaces descriptors in all the info arrays for the ModelMBean. |
void |
setDescriptors(Descriptor[] inDescriptors)
Adds or replaces descriptors in the ModelMBeanInfo. |
void |
setMBeanDescriptor(Descriptor inDescriptor)
Sets the ModelMBean's descriptor (fully replace). |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ModelMBeanInfoSupport(ModelMBeanInfo mbi)
mbi
- the ModelMBeanInfo instance from which the ModelMBeanInfo
being created is initializedpublic ModelMBeanInfoSupport(java.lang.String className, java.lang.String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications)
className
- classname of ModelMBeanInfodescription
- human readable description of the ModelMBeanattributes
- array of ModelMBeanAttributeInfo objects which have descriptorsconstructors
- array of ModelMBeanConstructorInfo objects which have descriptoroperations
- array of ModelMBeanOperationInfo objects which have descriptornotifications
- array of ModelMBeanNotificationInfo objects which have descriptorpublic ModelMBeanInfoSupport(java.lang.String className, java.lang.String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications, Descriptor mbeandescriptor)
className
- classname of ModelMBeanInfodescription
- human readable description of the ModelMBeanattributes
- array of ModelMBeanAttributeInfo objects which have descriptorsconstructors
- array of ModelMBeanConstructorInfo objects which have descriptoroperations
- array of ModelMBeanOperationInfo objects which have descriptornotifications
- array of ModelMBeanNotificationInfo objects which have descriptormbeandescriptor
- the descriptor to be used as the MBeanDescriptor
containing mbean wide policy. If the descriptor is invalid
or null, a default descriptor will be constructed.
The default descriptor is:
name=mbeanName,
descriptorType=mbean,
displayName=this.getClassName(),
persistPolicy=never,
log=F,
export=F,
visiblity=1.
If the descriptor does not contain all these fields,
they will be added with these default values.Method Detail |
public java.lang.String getClassName()
getClassName
in interface ModelMBeanInfo
getClassName
in class MBeanInfo
public java.lang.String getDescription()
getDescription
in interface ModelMBeanInfo
getDescription
in class MBeanInfo
public java.lang.Object clone()
clone
in interface ModelMBeanInfo
clone
in class MBeanInfo
public MBeanAttributeInfo[] getAttributes()
getAttributes
in interface ModelMBeanInfo
getAttributes
in class MBeanInfo
public MBeanConstructorInfo[] getConstructors()
getConstructors
in interface ModelMBeanInfo
getConstructors
in class MBeanInfo
public MBeanNotificationInfo[] getNotifications()
getNotifications
in interface ModelMBeanInfo
getNotifications
in class MBeanInfo
public MBeanOperationInfo[] getOperations()
getOperations
in interface ModelMBeanInfo
getOperations
in class MBeanInfo
public Descriptor[] getDescriptors(java.lang.String inDescriptorType) throws MBeanException, RuntimeOperationsException
getDescriptors
in interface ModelMBeanInfo
inDescriptorType
- value of descriptorType field that must be set
for the descriptor to be returned. Must be "mbean",
"attribute", "operation", "constructor", or "notification".
If it is null then all types will be returned.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps another exceptionpublic void setDescriptors(Descriptor[] inDescriptors) throws MBeanException, RuntimeOperationsException
setDescriptors
in interface ModelMBeanInfo
inDescriptors
- The descriptors to be set in the ModelMBeanInfo.
Null elements of the list will be ignored. All descriptors
must have name and descriptorType fields.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps exceptions for illegal
or null argumentspublic Descriptor getDescriptor(java.lang.String inDescriptorName) throws MBeanException, RuntimeOperationsException
inDescriptorName
- The name of the descriptor.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps exceptions for invalid
input name or type.public Descriptor getDescriptor(java.lang.String inDescriptorName, java.lang.String inDescriptorType) throws MBeanException, RuntimeOperationsException
getDescriptor
in interface ModelMBeanInfo
inDescriptorName
- The name of the descriptor.inDescriptorType
- The type of the descriptor being requested.
If this is null then all types are searched. Valid types
are 'attribute', 'constructor', 'operation', and
'notification'. This value must be equal to the
'descriptorType' field in the descriptor that is returned.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps exceptions for invalid
input name or type.public void setDescriptor(Descriptor inDescriptor, java.lang.String inDescriptorType) throws MBeanException, RuntimeOperationsException
setDescriptor
in interface ModelMBeanInfo
inDescriptor
- The descriptor to be set in the ModelMBean.
It must NOT be null. All descriptors must have name and
descriptorType fields.inDescriptorType
- The type of the descriptor being set. If this
is null then the descriptorType field in the descriptor
is used. If specified this value must be set in the
descriptorType field for the descriptor to be returned.
Must be "mbean","attribute", "operation", "constructor",
or "notification".RuntimeOperationsException
- Wraps exceptions for illegal
or null arguments.public Descriptor getMBeanDescriptor() throws MBeanException, RuntimeOperationsException
getMBeanDescriptor
in interface ModelMBeanInfo
MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps another exceptionpublic void setMBeanDescriptor(Descriptor inDescriptor) throws MBeanException, RuntimeOperationsException
setMBeanDescriptor
in interface ModelMBeanInfo
inDescriptor
- This descriptor contains metadata about the MBean
and default policies for persistence and caching for
the entire MBean.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps another exceptionpublic ModelMBeanAttributeInfo getAttribute(java.lang.String inName) throws MBeanException, RuntimeOperationsException
getAttribute
in interface ModelMBeanInfo
inName
- The name of the ModelMBeanAttributeInfo to get.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps another exception for
invalid attribute name or ModelMBeanAttributeInfo to be returned.public ModelMBeanOperationInfo getOperation(java.lang.String inName) throws MBeanException, RuntimeOperationsException
getOperation
in interface ModelMBeanInfo
inName
- The name of the ModelMBeanOperationInfo to get.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps another exception for invalid
attribute name or ModelMBeanOperationInfo to be returned.public ModelMBeanConstructorInfo getConstructor(java.lang.String inName) throws MBeanException, RuntimeOperationsException
String
- inName The name of the ModelMBeanConstructorInfo to get.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps another exception for invalid
attribute name or ModelMBeanConstructorInfo to be returned.public ModelMBeanNotificationInfo getNotification(java.lang.String inName) throws MBeanException, RuntimeOperationsException
getNotification
in interface ModelMBeanInfo
inName
- The name of the ModelMBeanNotificationInfo to get.MBeanException
- Wraps another exceptionRuntimeOperationsException
- Wraps another exception
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |