javax.management.modelmbean

Class ModelMBeanInfoSupport

Contents
  • All Implemented Interfaces:
    Serializable, Cloneable, DescriptorRead, ModelMBeanInfo

    public class ModelMBeanInfoSupport
extends MBeanInfo
implements ModelMBeanInfo
    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.)

    The serialVersionUID of this class is -1935722590756516193L.

    Since:
    1.5
    See Also:
    Serialized Form

    • Constructor Detail

      • ModelMBeanInfoSupport

        public ModelMBeanInfoSupport(ModelMBeanInfo mbi)
        Constructs a ModelMBeanInfoSupport which is a duplicate of the given ModelMBeanInfo. The returned object is a shallow copy of the given object. Neither the Descriptor nor the contained arrays (ModelMBeanAttributeInfo[] etc) are cloned. This method is chiefly of interest to modify the Descriptor of the returned instance via setDescriptor without affecting the Descriptor of the original object.
        Parameters:
        mbi - the ModelMBeanInfo instance from which the ModelMBeanInfo being created is initialized.

      • ModelMBeanInfoSupport

        public ModelMBeanInfoSupport(String className,
                     String description,
                     ModelMBeanAttributeInfo[] attributes,
                     ModelMBeanConstructorInfo[] constructors,
                     ModelMBeanOperationInfo[] operations,
                     ModelMBeanNotificationInfo[] notifications)
        Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default. The default descriptor is: name=className, 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

        public ModelMBeanInfoSupport(String className,
                     String description,
                     ModelMBeanAttributeInfo[] attributes,
                     ModelMBeanConstructorInfo[] constructors,
                     ModelMBeanOperationInfo[] operations,
                     ModelMBeanNotificationInfo[] notifications,
                     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 of these fields, the missing ones are added with these default values.
        Throws:
        RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor passed in parameter. (see getMBeanDescriptor for the definition of a valid MBean descriptor.)

    • Method Detail

      • clone

        public Object clone()
        Returns a shallow clone of this instance. Neither the Descriptor nor the contained arrays (ModelMBeanAttributeInfo[] etc) are cloned. This method is chiefly of interest to modify the Descriptor of the clone via setDescriptor without affecting the Descriptor of the original object.
        Specified by:
        clone in interface ModelMBeanInfo
        Overrides:
        clone in class MBeanInfo
        Returns:
        a shallow clone of this instance.
        See Also:
        Cloneable

      • getDescriptors

        public Descriptor[] getDescriptors(String inDescriptorType)
                            throws MBeanException,
                                   RuntimeOperationsException
        Description copied from interface: ModelMBeanInfo
        Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo of type inDescriptorType.
        Specified by:
        getDescriptors in interface 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 - Wraps a distributed communication Exception.
        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[])

      • getDescriptor

        public Descriptor getDescriptor(String inDescriptorName,
                       String inDescriptorType)
                         throws MBeanException,
                                RuntimeOperationsException
        Description copied from interface: ModelMBeanInfo
        Returns a Descriptor requested by name and descriptorType.
        Specified by:
        getDescriptor in interface 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 - Wraps a distributed communication 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 Also:
        ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String)

      • setDescriptor

        public void setDescriptor(Descriptor inDescriptor,
                 String inDescriptorType)
                   throws MBeanException,
                          RuntimeOperationsException
        Description copied from interface: ModelMBeanInfo
        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 in interface 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 - Wraps a distributed communication 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.
        See Also:
        ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String)

      • getDescriptor

        public Descriptor getDescriptor()
        Description copied from class: MBeanInfo
        Get the descriptor of this MBeanInfo. Changing the returned value will have no affect on the original descriptor.
        Specified by:
        getDescriptor in interface DescriptorRead
        Overrides:
        getDescriptor in class MBeanInfo
        Returns:
        a descriptor that is either immutable or a copy of the original.
        Since:
        1.6

      • getMBeanDescriptor

        public Descriptor getMBeanDescriptor()
                              throws MBeanException
        Description copied from interface: ModelMBeanInfo

        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. Note that when the Type in this table is Number, a String that is the decimal representation of a Long can also be used.

        NameTypeMeaning
        nameString MBean name.
        descriptorTypeString Must be "mbean".
        displayNameString Name of MBean to be used in displays.
        persistPolicyString One of: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never. See the section "MBean Descriptor Fields" in the JMX specification document.
        persistLocationString The fully qualified directory name where the MBean should be persisted (if appropriate).
        persistFileString File name into which the MBean should be persisted.
        persistPeriodNumber Frequency of persist cycle in seconds, for OnTime and NoMoreOftenThan PersistPolicy
        currencyTimeLimitNumber How long cached value is valid: <0 never, =0 always, >0 seconds.
        logString t: log all notifications, f: log no notifications.
        logfileString Fully qualified filename to log events to.
        visibilityNumber 1-4 where 1: always visible 4: rarely visible.
        exportString Name to be used to export/expose this MBean so that it is findable by other JMX Agents.
        presentationStringString XML formatted string to allow presentation of data to be associated with the MBean.

        ModelMBeanInfoSupport (Java Platform SE 7 ) Home of API Java Contents Haut

        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.

        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 in interface ModelMBeanInfo
        Returns:
        the MBean descriptor.
        Throws:
        MBeanException - Wraps a distributed communication Exception.
        See Also:
        ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor)

      • setMBeanDescriptor

        public void setMBeanDescriptor(Descriptor inMBeanDescriptor)
                        throws MBeanException,
                               RuntimeOperationsException
        Description copied from interface: ModelMBeanInfo
        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=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. See getMBeanDescriptor method javadoc for description of valid field names.
        Specified by:
        setMBeanDescriptor in interface ModelMBeanInfo
        Parameters:
        inMBeanDescriptor - the descriptor to set.
        Throws:
        MBeanException - Wraps a distributed communication Exception.
        RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor.
        See Also:
        ModelMBeanInfo.getMBeanDescriptor()

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/management/modelmbean/ModelMBeanInfoSupport.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut