File	Doc	Category	Size	Date	Package
ModelMBeanInfo.java	API Doc	Java SE 5 API	14505	Fri Aug 26 14:57:34 BST 2005	javax.management.modelmbean

ModelMBeanInfo

Fields Summary

Constructors Summary

Methods Summary
public java.lang.Object	clone() Creates and returns a copy of this object.
public javax.management.modelmbean.ModelMBeanAttributeInfo	getAttribute(java.lang.String inName) Returns a ModelMBeanAttributeInfo requested by name. param inName The name of the ModelMBeanAttributeInfo to get. If no ModelMBeanAttributeInfo exists for this name null is returned. return the attribute info for the named attribute, or null if there is none. exception MBeanException Wraps a distributed communication Exception. exception RuntimeOperationsException Wraps an IllegalArgumentException for a null attribute name.
public javax.management.MBeanAttributeInfo[]	getAttributes() Returns the list of attributes exposed for management. Each attribute is described by an MBeanAttributeInfo object. return An array of MBeanAttributeInfo objects.
public java.lang.String	getClassName() Returns the name of the Java class of the MBean described by this MBeanInfo. return the Java class name.
public javax.management.MBeanConstructorInfo[]	getConstructors() Returns the list of the public constructors of the MBean. Each constructor is described by an MBeanConstructorInfo object. return An array of MBeanConstructorInfo objects.
public java.lang.String	getDescription() Returns a human readable description of the MBean. return the description.
public javax.management.Descriptor	getDescriptor(java.lang.String inDescriptorName, java.lang.String inDescriptorType) Returns a Descriptor requested by name and descriptorType. param inDescriptorName The name of the descriptor. param inDescriptorType The type of the descriptor being requested. If this is null or empty then all types are searched. Valid types are 'mbean', 'attribute', 'constructor' 'operation', and 'notification'. This value will be equal to the 'descriptorType' field in the descriptor that is returned. return Descriptor containing the descriptor for the ModelMBean with the same name and descriptorType. If no descriptor is found, null is returned. exception MBeanException Wraps a distributed communication Exception. exception RuntimeOperationsException Wraps an IllegalArgumentException for a null descriptor name or null or invalid type. The type must be "mbean","attribute", "constructor", "operation", or "notification". see #setDescriptor
public javax.management.Descriptor[]	getDescriptors(java.lang.String inDescriptorType) Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo of type inDescriptorType. param 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 or empty then all types will be returned. return Descriptor array containing all descriptors for the ModelMBean if type inDescriptorType. exception MBeanException Wraps a distributed communication Exception. exception RuntimeOperationsException Wraps an IllegalArgumentException when the descriptorType in parameter is not one of: "mbean", "attribute", "operation", "constructor", "notification", empty or null. see #setDescriptors
public javax.management.Descriptor	getMBeanDescriptor() 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|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. return the MBean descriptor. exception MBeanException Wraps a distributed communication Exception. exception RuntimeOperationsException a {@link RuntimeException} occurred while getting the descriptor. see #setMBeanDescriptor
public javax.management.modelmbean.ModelMBeanNotificationInfo	getNotification(java.lang.String inName) Returns a ModelMBeanNotificationInfo requested by name. param inName The name of the ModelMBeanNotificationInfo to get. If no ModelMBeanNotificationInfo exists for this name null is returned. return the info for the named notification, or null if there is none. exception MBeanException Wraps a distributed communication Exception. exception RuntimeOperationsException Wraps an IllegalArgumentException for a null notification name.
public javax.management.MBeanNotificationInfo[]	getNotifications() 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. return An array of MBeanNotificationInfo objects.
public javax.management.modelmbean.ModelMBeanOperationInfo	getOperation(java.lang.String inName) Returns a ModelMBeanOperationInfo requested by name. param inName The name of the ModelMBeanOperationInfo to get. If no ModelMBeanOperationInfo exists for this name null is returned. return the operation info for the named operation, or null if there is none. exception MBeanException Wraps a distributed communication Exception. exception RuntimeOperationsException Wraps an IllegalArgumentException for a null operation name.
public javax.management.MBeanOperationInfo[]	getOperations() Returns the list of operations of the MBean. Each operation is described by an MBeanOperationInfo object. return An array of MBeanOperationInfo objects.
public void	setDescriptor(javax.management.Descriptor inDescriptor, java.lang.String inDescriptorType) Sets descriptors in the info array of type inDescriptorType for the ModelMBean. The setDescriptor method of the corresponding ModelMBean*Info will be called to set the specified descriptor. param inDescriptor The descriptor to be set in the ModelMBean. It must NOT be null. All descriptors must have name and descriptorType fields. param 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 in the descriptor. Must be "mbean","attribute", "constructor", "operation", or "notification". exception RuntimeOperationsException Wraps an IllegalArgumentException for illegal or null arguments or if the name field of the descriptor is not found in the corresponding MBeanAttributeInfo or MBeanConstructorInfo or MBeanNotificationInfo or MBeanOperationInfo. exception MBeanException Wraps a distributed communication Exception. see #getDescriptor
public void	setDescriptors(javax.management.Descriptor[] inDescriptors) Adds or replaces descriptors in the ModelMBeanInfo. param 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. exception RuntimeOperationsException Wraps an IllegalArgumentException for a null or invalid descriptor. exception MBeanException Wraps a distributed communication Exception. see #getDescriptors
public void	setMBeanDescriptor(javax.management.Descriptor inDescriptor) Sets the ModelMBean's descriptor. This descriptor contains default, MBean wide metadata about the MBean and default policies for persistence and caching. This operation does a complete replacement of the descriptor, no merging is done. If the descriptor to set to is null then the default descriptor will be created. 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. See {@link #getMBeanDescriptor getMBeanDescriptor} method javadoc for description of valid field names. param inDescriptor the descriptor to set. exception MBeanException Wraps a distributed communication Exception. exception RuntimeOperationsException Wraps an IllegalArgumentException for invalid descriptor. see #getMBeanDescriptor