XMOJO 5 API Docs

javax.management.modelmbean
Class ModelMBeanNotificationInfo

java.lang.Object
  |
  +--javax.management.MBeanFeatureInfo
        |
        +--javax.management.MBeanNotificationInfo
              |
              +--javax.management.modelmbean.ModelMBeanNotificationInfo
All Implemented Interfaces:
java.lang.Cloneable, DescriptorAccess, java.io.Serializable

public class ModelMBeanNotificationInfo
extends MBeanNotificationInfo
implements DescriptorAccess, java.lang.Cloneable

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 : 1-5 where 1: fatal 2: severe 3: error 4: warn 5: info

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, and severity=5 fields.

See Also:
Serialized Form

Fields inherited from class javax.management.MBeanFeatureInfo
description, name
 
Constructor Summary
ModelMBeanNotificationInfo(ModelMBeanNotificationInfo inInfo)
          Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object.
ModelMBeanNotificationInfo(java.lang.String[] notifTypes, java.lang.String name, java.lang.String description)
          Constructs a ModelMBeanNotificationInfo object with a default descxriptor.
ModelMBeanNotificationInfo(java.lang.String[] notifTypes, java.lang.String name, java.lang.String description, Descriptor descriptor)
          Constructs a ModelMBeanNotificationInfo object
 
Method Summary
 java.lang.Object clone()
          Creates a duplicate ModelMBeanNotificationInfo object
 Descriptor getDescriptor()
          Gets the corresponding Descriptor of this ModelMBeanNotificationInfo
 void setDescriptor(Descriptor inDescriptor)
          Sets the specified Descriptor to this ModelMBeanNotificationInfo.If the value is null then default Descriptor will be taken.
 java.lang.String toString()
          Returns a human readable version of the ModelMBeanNotificationInfo instance
 
Methods inherited from class javax.management.MBeanNotificationInfo
getNotifTypes
 
Methods inherited from class javax.management.MBeanFeatureInfo
getDescription, getName
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModelMBeanNotificationInfo

public ModelMBeanNotificationInfo(java.lang.String[] notifTypes,
                                  java.lang.String name,
                                  java.lang.String description)
Constructs a ModelMBeanNotificationInfo object with a default descxriptor.
Parameters:
notifTypes - The notification type string
name - The Notification class name
description - The description about the notification

ModelMBeanNotificationInfo

public ModelMBeanNotificationInfo(java.lang.String[] notifTypes,
                                  java.lang.String name,
                                  java.lang.String description,
                                  Descriptor descriptor)
Constructs a ModelMBeanNotificationInfo object
Parameters:
notifTypes - The notification type string
name - The Notification class name
description - The description about the notification
descriptor - Descriptor containing the appropriate metadata for this instance of the MBeanNotificationInfo. If it is null or invalid then a default desriptor will be created.

ModelMBeanNotificationInfo

public ModelMBeanNotificationInfo(ModelMBeanNotificationInfo inInfo)
Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object.
Parameters:
inInfo - The duplicate ModelMBeanNotificationInfo object
Method Detail

clone

public java.lang.Object clone()
Creates a duplicate ModelMBeanNotificationInfo object
Overrides:
clone in class MBeanNotificationInfo
Returns:
A duplicate ModelMBeanNotificationInfo object

getDescriptor

public Descriptor getDescriptor()
Gets the corresponding Descriptor of this ModelMBeanNotificationInfo
Specified by:
getDescriptor in interface DescriptorAccess
Returns:
This returns the Descriptor associated with this ModelMBeanNotificationInfo

setDescriptor

public void setDescriptor(Descriptor inDescriptor)
Sets the specified Descriptor to this ModelMBeanNotificationInfo.If the value is null then default Descriptor will be taken. The Descriptor is validated before it is assigned. If the new Descriptor is invalid, then an IllegalArgumentException is thrown.
Specified by:
setDescriptor in interface DescriptorAccess
Parameters:
inDescriptor - This replaces the Descriptor associated with the ModelMBeanNotification interface
Throws:
java.lang.IllegalArgumentException - If the new Descriptor is invalid, then it will be thrown.

toString

public java.lang.String toString()
Returns a human readable version of the ModelMBeanNotificationInfo instance
Overrides:
toString in class MBeanNotificationInfo
Returns:
Human readable version of the ModelMBeanNotificationInfo instance

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.