javax.management.modelmbean
Class ModelMBeanInfoSupport

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.management.MBeanInfo sample code for javax.management.MBeanInfo definition code for javax.management.MBeanInfo 
      extended by javax.management.modelmbean.ModelMBeanInfoSupport
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo

public class ModelMBeanInfoSupport
extends MBeanInfo sample code for javax.management.MBeanInfo definition code for javax.management.MBeanInfo
implements ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

This class represents the meta data for ModelMBeans. Descriptors have been added on the meta data objects.

Java resources wishing to be manageable instantiate 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/adaptors 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 wrapping exceptions from distributed communications (RMI, EJB, etc.)

Since:
1.5
See Also:
Serialized Form

Constructor Summary
ModelMBeanInfoSupport sample code for javax.management.modelmbean.ModelMBeanInfoSupport.ModelMBeanInfoSupport(javax.management.modelmbean.ModelMBeanInfo) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.ModelMBeanInfoSupport(javax.management.modelmbean.ModelMBeanInfo) (ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo  mbi)
          Constructs a ModelMBeanInfoSupport which is a duplicate of the one passed in.
ModelMBeanInfoSupport sample code for javax.management.modelmbean.ModelMBeanInfoSupport.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[]) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[]) (String sample code for java.lang.String definition code for java.lang.String  className, String sample code for java.lang.String definition code for java.lang.String  description, ModelMBeanAttributeInfo sample code for javax.management.modelmbean.ModelMBeanAttributeInfo definition code for javax.management.modelmbean.ModelMBeanAttributeInfo [] attributes, ModelMBeanConstructorInfo sample code for javax.management.modelmbean.ModelMBeanConstructorInfo definition code for javax.management.modelmbean.ModelMBeanConstructorInfo [] constructors, ModelMBeanOperationInfo sample code for javax.management.modelmbean.ModelMBeanOperationInfo definition code for javax.management.modelmbean.ModelMBeanOperationInfo [] operations, ModelMBeanNotificationInfo sample code for javax.management.modelmbean.ModelMBeanNotificationInfo definition code for javax.management.modelmbean.ModelMBeanNotificationInfo [] notifications)
          Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default.
ModelMBeanInfoSupport sample code for javax.management.modelmbean.ModelMBeanInfoSupport.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[], javax.management.Descriptor) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[], javax.management.Descriptor) (String sample code for java.lang.String definition code for java.lang.String  className, String sample code for java.lang.String definition code for java.lang.String  description, ModelMBeanAttributeInfo sample code for javax.management.modelmbean.ModelMBeanAttributeInfo definition code for javax.management.modelmbean.ModelMBeanAttributeInfo [] attributes, ModelMBeanConstructorInfo sample code for javax.management.modelmbean.ModelMBeanConstructorInfo definition code for javax.management.modelmbean.ModelMBeanConstructorInfo [] constructors, ModelMBeanOperationInfo sample code for javax.management.modelmbean.ModelMBeanOperationInfo definition code for javax.management.modelmbean.ModelMBeanOperationInfo [] operations, ModelMBeanNotificationInfo sample code for javax.management.modelmbean.ModelMBeanNotificationInfo definition code for javax.management.modelmbean.ModelMBeanNotificationInfo [] notifications, Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  mbeandescriptor)
          Creates a ModelMBeanInfoSupport with the provided information and the descriptor given in parameter.
 
Method Summary
 Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for javax.management.modelmbean.ModelMBeanInfoSupport.clone() definition code for javax.management.modelmbean.ModelMBeanInfoSupport.clone() ()
          Returns a shallow clone of this instance.
 ModelMBeanAttributeInfo sample code for javax.management.modelmbean.ModelMBeanAttributeInfo definition code for javax.management.modelmbean.ModelMBeanAttributeInfo getAttribute sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getAttribute(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getAttribute(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  inName)
          Returns a ModelMBeanAttributeInfo requested by name.
 ModelMBeanConstructorInfo sample code for javax.management.modelmbean.ModelMBeanConstructorInfo definition code for javax.management.modelmbean.ModelMBeanConstructorInfo getConstructor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getConstructor(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getConstructor(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  inName)
          Returns the ModelMBeanConstructorInfo requested by name.
 Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor getDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  inDescriptorName)
          Returns a Descriptor requested by name.
 Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor getDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  inDescriptorName, String sample code for java.lang.String definition code for java.lang.String  inDescriptorType)
          Returns a Descriptor requested by name and descriptorType.
 Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor [] getDescriptors sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptors(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptors(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  inDescriptorType)
          Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo of type inDescriptorType.
 Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor getMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getMBeanDescriptor() definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getMBeanDescriptor() ()
          Returns the ModelMBean's descriptor which contains MBean wide policies.
 ModelMBeanNotificationInfo sample code for javax.management.modelmbean.ModelMBeanNotificationInfo definition code for javax.management.modelmbean.ModelMBeanNotificationInfo getNotification sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getNotification(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getNotification(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  inName)
          Returns a ModelMBeanNotificationInfo requested by name.
 ModelMBeanOperationInfo sample code for javax.management.modelmbean.ModelMBeanOperationInfo definition code for javax.management.modelmbean.ModelMBeanOperationInfo getOperation sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getOperation(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getOperation(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  inName)
          Returns a ModelMBeanOperationInfo requested by name.
 void setDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptor(javax.management.Descriptor, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptor(javax.management.Descriptor, java.lang.String) (Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  inDescriptor, String sample code for java.lang.String definition code for java.lang.String  inDescriptorType)
          Sets descriptors in the info array of type inDescriptorType for the ModelMBean.
 void setDescriptors sample code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptors(javax.management.Descriptor[]) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptors(javax.management.Descriptor[]) (Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor [] inDescriptors)
          Adds or replaces descriptors in the ModelMBeanInfo.
 void setMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.setMBeanDescriptor(javax.management.Descriptor) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.setMBeanDescriptor(javax.management.Descriptor) (Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  inMBeanDescriptor)
          Sets the ModelMBean's descriptor.
 
Methods inherited from class javax.management.MBeanInfo sample code for javax.management.MBeanInfo definition code for javax.management.MBeanInfo
equals sample code for javax.management.MBeanInfo.equals(java.lang.Object) definition code for javax.management.MBeanInfo.equals(java.lang.Object) , getAttributes sample code for javax.management.MBeanInfo.getAttributes() definition code for javax.management.MBeanInfo.getAttributes() , getClassName sample code for javax.management.MBeanInfo.getClassName() definition code for javax.management.MBeanInfo.getClassName() , getConstructors sample code for javax.management.MBeanInfo.getConstructors() definition code for javax.management.MBeanInfo.getConstructors() , getDescription sample code for javax.management.MBeanInfo.getDescription() definition code for javax.management.MBeanInfo.getDescription() , getNotifications sample code for javax.management.MBeanInfo.getNotifications() definition code for javax.management.MBeanInfo.getNotifications() , getOperations sample code for javax.management.MBeanInfo.getOperations() definition code for javax.management.MBeanInfo.getOperations() , hashCode sample code for javax.management.MBeanInfo.hashCode() definition code for javax.management.MBeanInfo.hashCode()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 
Methods inherited from interface javax.management.modelmbean.ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
getAttributes sample code for javax.management.modelmbean.ModelMBeanInfo.getAttributes() definition code for javax.management.modelmbean.ModelMBeanInfo.getAttributes() , getClassName sample code for javax.management.modelmbean.ModelMBeanInfo.getClassName() definition code for javax.management.modelmbean.ModelMBeanInfo.getClassName() , getConstructors sample code for javax.management.modelmbean.ModelMBeanInfo.getConstructors() definition code for javax.management.modelmbean.ModelMBeanInfo.getConstructors() , getDescription sample code for javax.management.modelmbean.ModelMBeanInfo.getDescription() definition code for javax.management.modelmbean.ModelMBeanInfo.getDescription() , getNotifications sample code for javax.management.modelmbean.ModelMBeanInfo.getNotifications() definition code for javax.management.modelmbean.ModelMBeanInfo.getNotifications() , getOperations sample code for javax.management.modelmbean.ModelMBeanInfo.getOperations() definition code for javax.management.modelmbean.ModelMBeanInfo.getOperations()
 

Constructor Detail

ModelMBeanInfoSupport sample code for javax.management.modelmbean.ModelMBeanInfoSupport(javax.management.modelmbean.ModelMBeanInfo) definition code for javax.management.modelmbean.ModelMBeanInfoSupport(javax.management.modelmbean.ModelMBeanInfo)

public ModelMBeanInfoSupport(ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo  mbi)
Constructs a ModelMBeanInfoSupport which is a duplicate of the one passed in.

Parameters:
mbi - the ModelMBeanInfo instance from which the ModelMBeanInfo being created is initialized.

ModelMBeanInfoSupport sample code for javax.management.modelmbean.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[]) definition code for javax.management.modelmbean.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[])

public ModelMBeanInfoSupport(String sample code for java.lang.String definition code for java.lang.String  className,
                             String sample code for java.lang.String definition code for java.lang.String  description,
                             ModelMBeanAttributeInfo sample code for javax.management.modelmbean.ModelMBeanAttributeInfo definition code for javax.management.modelmbean.ModelMBeanAttributeInfo [] attributes,
                             ModelMBeanConstructorInfo sample code for javax.management.modelmbean.ModelMBeanConstructorInfo definition code for javax.management.modelmbean.ModelMBeanConstructorInfo [] constructors,
                             ModelMBeanOperationInfo sample code for javax.management.modelmbean.ModelMBeanOperationInfo definition code for javax.management.modelmbean.ModelMBeanOperationInfo [] operations,
                             ModelMBeanNotificationInfo sample code for javax.management.modelmbean.ModelMBeanNotificationInfo definition code for javax.management.modelmbean.ModelMBeanNotificationInfo [] notifications)
Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default. The default descriptor is: name=mbeanName, descriptorType=mbean, displayName=ClassName, persistPolicy=never, log=F, visibility=1

Parameters:
className - classname of the MBean
description - human readable description of the ModelMBean
attributes - array of ModelMBeanAttributeInfo objects which have descriptors
constructors - array of ModelMBeanConstructorInfo objects which have descriptors
operations - array of ModelMBeanOperationInfo objects which have descriptors
notifications - array of ModelMBeanNotificationInfo objects which have descriptors

ModelMBeanInfoSupport sample code for javax.management.modelmbean.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[], javax.management.Descriptor) definition code for javax.management.modelmbean.ModelMBeanInfoSupport(java.lang.String, java.lang.String, javax.management.modelmbean.ModelMBeanAttributeInfo[], javax.management.modelmbean.ModelMBeanConstructorInfo[], javax.management.modelmbean.ModelMBeanOperationInfo[], javax.management.modelmbean.ModelMBeanNotificationInfo[], javax.management.Descriptor)

public ModelMBeanInfoSupport(String sample code for java.lang.String definition code for java.lang.String  className,
                             String sample code for java.lang.String definition code for java.lang.String  description,
                             ModelMBeanAttributeInfo sample code for javax.management.modelmbean.ModelMBeanAttributeInfo definition code for javax.management.modelmbean.ModelMBeanAttributeInfo [] attributes,
                             ModelMBeanConstructorInfo sample code for javax.management.modelmbean.ModelMBeanConstructorInfo definition code for javax.management.modelmbean.ModelMBeanConstructorInfo [] constructors,
                             ModelMBeanOperationInfo sample code for javax.management.modelmbean.ModelMBeanOperationInfo definition code for javax.management.modelmbean.ModelMBeanOperationInfo [] operations,
                             ModelMBeanNotificationInfo sample code for javax.management.modelmbean.ModelMBeanNotificationInfo definition code for javax.management.modelmbean.ModelMBeanNotificationInfo [] notifications,
                             Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  mbeandescriptor)
Creates a ModelMBeanInfoSupport with the provided information and the descriptor given in parameter.

Parameters:
className - classname of the MBean
description - human readable description of the ModelMBean
attributes - array of ModelMBeanAttributeInfo objects which have descriptors
constructors - array of ModelMBeanConstructorInfo objects which have descriptor
operations - array of ModelMBeanOperationInfo objects which have descriptor
notifications - array of ModelMBeanNotificationInfo objects which have descriptor
mbeandescriptor - descriptor to be used as the MBeanDescriptor containing MBean wide policy. If the descriptor is null, a default descriptor will be constructed. The default descriptor is: name=className, descriptorType=mbean, displayName=className, persistPolicy=never, log=F, visibility=1. If the descriptor does not contain all these fields, they will be added with these default values.
Throws:
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor passed in parameter. (see getMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getMBeanDescriptor() definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getMBeanDescriptor() for the definition of a valid MBean descriptor.)
Method Detail

clone sample code for javax.management.modelmbean.ModelMBeanInfoSupport.clone() definition code for javax.management.modelmbean.ModelMBeanInfoSupport.clone()

public Object sample code for java.lang.Object definition code for java.lang.Object  clone()
Description copied from class: MBeanInfo sample code for javax.management.MBeanInfo.clone() definition code for javax.management.MBeanInfo.clone()

Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

Since this class is immutable, the clone method is chiefly of interest to subclasses.

Specified by:
clone sample code for javax.management.modelmbean.ModelMBeanInfo.clone() definition code for javax.management.modelmbean.ModelMBeanInfo.clone() in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Overrides:
clone sample code for javax.management.MBeanInfo.clone() definition code for javax.management.MBeanInfo.clone() in class MBeanInfo sample code for javax.management.MBeanInfo definition code for javax.management.MBeanInfo
Returns:
a clone of this instance.
See Also:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

getDescriptors sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptors(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptors(java.lang.String)

public Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor [] getDescriptors(String sample code for java.lang.String definition code for java.lang.String  inDescriptorType)
                            throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                   RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.getDescriptors(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getDescriptors(java.lang.String)
Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo of type inDescriptorType.

Specified by:
getDescriptors sample code for javax.management.modelmbean.ModelMBeanInfo.getDescriptors(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getDescriptors(java.lang.String) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
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.
Returns:
Descriptor array containing all descriptors for the ModelMBean if type inDescriptorType.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException when the descriptorType in parameter is not one of: "mbean", "attribute", "operation", "constructor", "notification", empty or null.
See Also:
ModelMBeanInfo.setDescriptors(javax.management.Descriptor[]) sample code for javax.management.modelmbean.ModelMBeanInfo.setDescriptors(javax.management.Descriptor[]) definition code for javax.management.modelmbean.ModelMBeanInfo.setDescriptors(javax.management.Descriptor[])

setDescriptors sample code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptors(javax.management.Descriptor[]) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptors(javax.management.Descriptor[])

public void setDescriptors(Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor [] inDescriptors)
                    throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                           RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.setDescriptors(javax.management.Descriptor[]) definition code for javax.management.modelmbean.ModelMBeanInfo.setDescriptors(javax.management.Descriptor[])
Adds or replaces descriptors in the ModelMBeanInfo.

Specified by:
setDescriptors sample code for javax.management.modelmbean.ModelMBeanInfo.setDescriptors(javax.management.Descriptor[]) definition code for javax.management.modelmbean.ModelMBeanInfo.setDescriptors(javax.management.Descriptor[]) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
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.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for a null or invalid descriptor.
See Also:
ModelMBeanInfo.getDescriptors(java.lang.String) sample code for javax.management.modelmbean.ModelMBeanInfo.getDescriptors(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getDescriptors(java.lang.String)

getDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String)

public Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  getDescriptor(String sample code for java.lang.String definition code for java.lang.String  inDescriptorName)
                         throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Returns a Descriptor requested by name.

Parameters:
inDescriptorName - The name of the descriptor.
Returns:
Descriptor containing a descriptor for the ModelMBean with the same name. If no descriptor is found, null is returned.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for null name.
See Also:
setDescriptor(javax.management.Descriptor, java.lang.String) sample code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptor(javax.management.Descriptor, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptor(javax.management.Descriptor, java.lang.String)

getDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getDescriptor(java.lang.String, java.lang.String)

public Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  getDescriptor(String sample code for java.lang.String definition code for java.lang.String  inDescriptorName,
                                String sample code for java.lang.String definition code for java.lang.String  inDescriptorType)
                         throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String)
Returns a Descriptor requested by name and descriptorType.

Specified by:
getDescriptor sample code for javax.management.modelmbean.ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
inDescriptorName - The name of the descriptor.
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.
Returns:
Descriptor containing the descriptor for the ModelMBean with the same name and descriptorType. If no descriptor is found, null is returned.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.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 Also:
ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String) sample code for javax.management.modelmbean.ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String)

setDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptor(javax.management.Descriptor, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.setDescriptor(javax.management.Descriptor, java.lang.String)

public void setDescriptor(Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  inDescriptor,
                          String sample code for java.lang.String definition code for java.lang.String  inDescriptorType)
                   throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                          RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String)
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.

Specified by:
setDescriptor sample code for javax.management.modelmbean.ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
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 in the descriptor. Must be "mbean","attribute", "constructor", "operation", or "notification".
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.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.
See Also:
ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String) sample code for javax.management.modelmbean.ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String)

getAttribute sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getAttribute(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getAttribute(java.lang.String)

public ModelMBeanAttributeInfo sample code for javax.management.modelmbean.ModelMBeanAttributeInfo definition code for javax.management.modelmbean.ModelMBeanAttributeInfo  getAttribute(String sample code for java.lang.String definition code for java.lang.String  inName)
                                     throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                            RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.getAttribute(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getAttribute(java.lang.String)
Returns a ModelMBeanAttributeInfo requested by name.

Specified by:
getAttribute sample code for javax.management.modelmbean.ModelMBeanInfo.getAttribute(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getAttribute(java.lang.String) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
inName - The name of the ModelMBeanAttributeInfo to get. If no ModelMBeanAttributeInfo exists for this name null is returned.
Returns:
the attribute info for the named attribute, or null if there is none.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for a null attribute name.

getOperation sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getOperation(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getOperation(java.lang.String)

public ModelMBeanOperationInfo sample code for javax.management.modelmbean.ModelMBeanOperationInfo definition code for javax.management.modelmbean.ModelMBeanOperationInfo  getOperation(String sample code for java.lang.String definition code for java.lang.String  inName)
                                     throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                            RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.getOperation(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getOperation(java.lang.String)
Returns a ModelMBeanOperationInfo requested by name.

Specified by:
getOperation sample code for javax.management.modelmbean.ModelMBeanInfo.getOperation(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getOperation(java.lang.String) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
inName - The name of the ModelMBeanOperationInfo to get. If no ModelMBeanOperationInfo exists for this name null is returned.
Returns:
the operation info for the named operation, or null if there is none.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for a null operation name.

getConstructor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getConstructor(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getConstructor(java.lang.String)

public ModelMBeanConstructorInfo sample code for javax.management.modelmbean.ModelMBeanConstructorInfo definition code for javax.management.modelmbean.ModelMBeanConstructorInfo  getConstructor(String sample code for java.lang.String definition code for java.lang.String  inName)
                                         throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                                RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Returns the ModelMBeanConstructorInfo requested by name. If no ModelMBeanConstructorInfo exists for this name null is returned.

Parameters:
inName - the name of the constructor.
Returns:
the constructor info for the named constructor, or null if there is none.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for a null constructor name.

getNotification sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getNotification(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getNotification(java.lang.String)

public ModelMBeanNotificationInfo sample code for javax.management.modelmbean.ModelMBeanNotificationInfo definition code for javax.management.modelmbean.ModelMBeanNotificationInfo  getNotification(String sample code for java.lang.String definition code for java.lang.String  inName)
                                           throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                                  RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.getNotification(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getNotification(java.lang.String)
Returns a ModelMBeanNotificationInfo requested by name.

Specified by:
getNotification sample code for javax.management.modelmbean.ModelMBeanInfo.getNotification(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanInfo.getNotification(java.lang.String) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
inName - The name of the ModelMBeanNotificationInfo to get. If no ModelMBeanNotificationInfo exists for this name null is returned.
Returns:
the info for the named notification, or null if there is none.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for a null notification name.

getMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.getMBeanDescriptor() definition code for javax.management.modelmbean.ModelMBeanInfoSupport.getMBeanDescriptor()

public Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  getMBeanDescriptor()
                              throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                                     RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor() definition code for javax.management.modelmbean.ModelMBeanInfo.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.

Specified by:
getMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor() definition code for javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor() in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Returns:
the MBean descriptor.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - a RuntimeException sample code for java.lang.RuntimeException definition code for java.lang.RuntimeException occurred while getting the descriptor.
See Also:
ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor) sample code for javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor) definition code for javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor)

setMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfoSupport.setMBeanDescriptor(javax.management.Descriptor) definition code for javax.management.modelmbean.ModelMBeanInfoSupport.setMBeanDescriptor(javax.management.Descriptor)

public void setMBeanDescriptor(Descriptor sample code for javax.management.Descriptor definition code for javax.management.Descriptor  inMBeanDescriptor)
                        throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                               RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Description copied from interface: ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor) definition code for javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor)
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 getMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor() definition code for javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor() method javadoc for description of valid field names.

Specified by:
setMBeanDescriptor sample code for javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor) definition code for javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor) in interface ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo
Parameters:
inMBeanDescriptor - the descriptor to set.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor.
See Also:
ModelMBeanInfo.getMBeanDescriptor() sample code for javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor() definition code for javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor()