ModelMBeanInfo JDK 1.6)

Hide/Show inherited methods

public Object clone ()

Creates and returns a copy of this object.

public ModelMBeanAttributeInfo getAttribute (String inName) throws MBeanException RuntimeOperationsException

Returns a ModelMBeanAttributeInfo requested by name.

public MBeanAttributeInfo getAttributes ()

Returns the list of attributes exposed for management.

Returns the list of attributes exposed for management.
Each attribute is described by an MBeanAttributeInfo object.
Returns: An array of MBeanAttributeInfo objects.

public String getClassName ()

Returns the name of the Java class of the MBean described by this MBeanInfo.

Returns the name of the Java class of the MBean described by
this MBeanInfo.
Returns: the Java class name.

public MBeanConstructorInfo getConstructors ()

Returns the list of the public constructors of the MBean.

Returns the list of the public constructors of the MBean.
Each constructor is described by an MBeanConstructorInfo object.
Returns: An array of MBeanConstructorInfo objects.

public String getDescription ()

Returns a human readable description of the MBean.

public Descriptor getDescriptor (String inDescriptorName, String inDescriptorType) throws MBeanException RuntimeOperationsException

Returns a Descriptor requested by name and descriptorType.

public Descriptor getDescriptors (String inDescriptorType) throws MBeanException RuntimeOperationsException

Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo of type inDescriptorType.

public Descriptor getMBeanDescriptor () throws MBeanException RuntimeOperationsException

Returns the ModelMBean's descriptor which contains MBean wide policies.

Returns the ModelMBean's descriptor which contains MBean wide policies. This descriptor contains metadata about the MBean and default policies for persistence and caching.

The fields in the descriptor are defined, but not limited to, the following:

 name           : MBean name  
 descriptorType : must be "mbean"   
 displayName    : name of attribute to be used in displays 
 persistPolicy  : OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never  
 persistLocation : The fully qualified directory name where the MBean should be persisted (if appropriate)
 persistFile    : File name into which the MBean should be persisted
 persistPeriod  : seconds - frequency of persist cycle for OnTime and NoMoreOftenThan PersistPolicy 
 currencyTimeLimit : how long value is valid, <0 never, =0 always, >0 seconds  
 log            : where t: log all notifications f: log no notifications
 logfile        : fully qualified filename to log events to
 visibility     : 1-4 where 1: always visible 4: rarely visible
 export         : name to be used to export/expose this MBean so that it is findable by
                  other JMX Agents.   
 presentationString : xml formatted string to allow presentation of data to be associated with the MBean.

The default descriptor is: name=mbeanName,descriptorType=mbean, displayName=this.getClassName(), persistPolicy=never,log=F,export=F,visibility=1 If the descriptor does not contain all these fields, they will be added with these default values.

Note: because of inconsistencies in previous versions of this specification, it is recommended not to use negative or zero values for currencyTimeLimit. To indicate that a cached value is never valid, omit the currencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.

Returns: the MBean descriptor.
Throws:
- MBeanException - Wraps a distributed communication Exception.
- RuntimeOperationsException - a {@link RuntimeException} occurred while getting the descriptor.
See Also: ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor),

public ModelMBeanNotificationInfo getNotification (String inName) throws MBeanException RuntimeOperationsException

Returns a ModelMBeanNotificationInfo requested by name.

public MBeanNotificationInfo getNotifications ()

Returns the list of the notifications emitted by the MBean.

Returns the list of the notifications emitted by the MBean. Each notification is described by an MBeanNotificationInfo object.

In addition to any notification specified by the application, a ModelMBean may always send also two additional notifications:

One with descriptor name "GENERIC" and displayName "jmx.modelmbean.generic"
Second is a standard attribute change notification with descriptor name "ATTRIBUTE_CHANGE" and displayName "jmx.attribute.change"

Thus any implementation of ModelMBeanInfo should always add those two notifications in addition to those specified by the application.
Returns: An array of MBeanNotificationInfo objects.

public ModelMBeanOperationInfo getOperation (String inName) throws MBeanException RuntimeOperationsException

Returns a ModelMBeanOperationInfo requested by name.

public MBeanOperationInfo getOperations ()

Returns the list of operations of the MBean.

Returns the list of operations of the MBean.
Each operation is described by an MBeanOperationInfo object.
Returns: An array of MBeanOperationInfo objects.

public void setDescriptor (Descriptor inDescriptor, String inDescriptorType) throws MBeanException RuntimeOperationsException

Sets descriptors in the info array of type inDescriptorType for the ModelMBean.

public void setDescriptors (Descriptor inDescriptors) throws MBeanException RuntimeOperationsException

Adds or replaces descriptors in the ModelMBeanInfo.

public void setMBeanDescriptor (Descriptor inDescriptor) throws MBeanException RuntimeOperationsException

Sets the ModelMBean's descriptor.