public class

ModelMBeanNotificationInfo

extends MBeanNotificationInfo
implements DescriptorAccess
java.lang.Object
   ↳ javax.management.MBeanFeatureInfo
     ↳ javax.management.MBeanNotificationInfo
       ↳ javax.management.modelmbean.ModelMBeanNotificationInfo

Class Overview

The ModelMBeanNotificationInfo object describes a notification emitted by a ModelMBean. It is a subclass of MBeanNotificationInfo with the addition of an associated Descriptor and an implementation of the Descriptor interface.

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

 name           : notification name
 descriptorType : must be "notification"
 severity       : 0-6 where 0: unknown; 1: non-recoverable;
                  2: critical, failure; 3: major, severe;
                  4: minor, marginal, error; 5: warning;
                  6: normal, cleared, informative
 messageID      : unique key for message text (to allow translation,
                  analysis)
 messageText    : text of notification
 log            : T - log message F - do not log message
 logfile        : string fully qualified file name appropriate for
                  operating system
 visibility     : 1-4 where 1: always visible 4: rarely visible
 presentationString : xml formatted string to allow presentation of data
The default descriptor contains the name, descriptorType, displayName and severity(=6) fields.

The serialVersionUID of this class is -7445681389570207141L.

Summary

[Expand]
Inherited Fields
From class javax.management.MBeanFeatureInfo
Public Constructors
ModelMBeanNotificationInfo(String[] notifTypes, String name, String description)
Constructs a ModelMBeanNotificationInfo object with a default descriptor.
ModelMBeanNotificationInfo(String[] notifTypes, String name, String description, Descriptor descriptor)
Constructs a ModelMBeanNotificationInfo object.
ModelMBeanNotificationInfo(ModelMBeanNotificationInfo inInfo)
Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object.
Public Methods
Object clone()
Creates and returns a new ModelMBeanNotificationInfo which is a duplicate of this ModelMBeanNotificationInfo.
Descriptor getDescriptor()
Returns a copy of the associated Descriptor for the ModelMBeanNotificationInfo.
void setDescriptor(Descriptor inDescriptor)
Sets associated Descriptor (full replace) for the ModelMBeanNotificationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor.
String toString()
Returns a human readable string containing ModelMBeanNotificationInfo.
[Expand]
Inherited Methods
From class javax.management.MBeanNotificationInfo
From class javax.management.MBeanFeatureInfo
From class java.lang.Object
From interface javax.management.DescriptorAccess
From interface javax.management.DescriptorRead

Public Constructors

public ModelMBeanNotificationInfo (String[] notifTypes, String name, String description)

Constructs a ModelMBeanNotificationInfo object with a default descriptor.

Parameters
notifTypes The array of strings (in dot notation) containing the notification types that may be emitted.
name The name of the Notification class.
description A human readable description of the Notification. Optional.

public ModelMBeanNotificationInfo (String[] notifTypes, String name, String description, Descriptor descriptor)

Constructs a ModelMBeanNotificationInfo object.

Parameters
notifTypes The array of strings (in dot notation) containing the notification types that may be emitted.
name The name of the Notification class.
description A human readable description of the Notification. Optional.
descriptor An instance of Descriptor containing the appropriate metadata for this instance of the MBeanNotificationInfo. If it is null a default descriptor will be created. If the descriptor does not contain the fields "displayName" or "severity" these fields are added in the descriptor with their default values.
Throws
RuntimeOperationsException Wraps an IllegalArgumentException. The descriptor is invalid, or descriptor field "name" is not equal to parameter name, or descriptor field "DescriptorType" is not equal to "notification".

public ModelMBeanNotificationInfo (ModelMBeanNotificationInfo inInfo)

Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object.

Parameters
inInfo the ModelMBeanNotificationInfo to be duplicated

Public Methods

public Object clone ()

Creates and returns a new ModelMBeanNotificationInfo which is a duplicate of this ModelMBeanNotificationInfo.

Returns
  • a clone of this instance.

public Descriptor getDescriptor ()

Returns a copy of the associated Descriptor for the ModelMBeanNotificationInfo.

Returns
  • Descriptor associated with the ModelMBeanNotificationInfo object.
See Also

public void setDescriptor (Descriptor inDescriptor)

Sets associated Descriptor (full replace) for the ModelMBeanNotificationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor. The Descriptor is validated before it is assigned. If the new Descriptor is invalid, then a RuntimeOperationsException wrapping an IllegalArgumentException is thrown.

Parameters
inDescriptor replaces the Descriptor associated with the ModelMBeanNotification interface
Throws
RuntimeOperationsException Wraps an IllegalArgumentException for invalid Descriptor.
See Also

public String toString ()

Returns a human readable string containing ModelMBeanNotificationInfo.

Returns
  • a string describing this object.