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. Note that when the Type in this table is Number, a String that is the decimal representation of a Long can also be used.
| Name | Type | Meaning |
|---|---|---|
| name | String | Notification name. |
| descriptorType | String | Must be "notification". |
| severity | Number | 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 | String | Unique key for message text (to allow translation, analysis). |
| messageText | String | Text of notification. |
| log | String | T - log message, F - do not log message. |
| logfile | String | fully qualified file name appropriate for operating system. |
| visibility | Number | 1-4 where 1: always visible 4: rarely visible. |
| presentationString | String | XML formatted string to allow presentation of data. |
The default descriptor contains the name, descriptorType,
displayName and severity(=6) fields. The default value of the name
and displayName fields is the name of the Notification class (as
specified by the name parameter of the
ModelMBeanNotificationInfo constructor).
The serialVersionUID of this class is -7445681389570207141L.
| Modifier and Type | Field and Description |
|---|---|
| private static boolean | |
| private static final String | |
| private static final ObjectStreamField[] | |
| private static final long | |
| private Descriptor | |
| private static final ObjectStreamField[] | |
| private static final long | |
| private static final ObjectStreamField[] | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | ModelMBeanNotificationInfo(String[]
The array of strings (in dot notation) containing
the notification types that may be emitted. notifTypes, String The name of the Notification class. name, String A human readable description of the
Notification. Optional. description)Constructs a ModelMBeanNotificationInfo object with a default descriptor. |
| public | ModelMBeanNotificationInfo(String[]
The array of strings (in dot notation)
containing the notification types that may be emitted. notifTypes, String The name of the Notification class. name, String A human readable description of the Notification.
Optional. description, 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",
the missing ones are added with their default values. descriptor)Constructs a ModelMBeanNotificationInfo object. |
| public | ModelMBeanNotificationInfo(ModelMBeanNotificationInfo
the ModelMBeanNotificationInfo to be duplicated inInfo)Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object. |
| Modifier and Type | Method and Description |
|---|---|
| public Object | clone()
Overrides javax. Creates and returns a new ModelMBeanNotificationInfo which is a duplicate of this ModelMBeanNotificationInfo. |
| public Descriptor | Returns: Descriptor associated with the ModelMBeanNotificationInfo object.Overrides javax. Implements javax. Returns a copy of the associated Descriptor for the ModelMBeanNotificationInfo. |
| private void | readObject(ObjectInputStream in)
Hides javax. Deserializes a |
| public void | setDescriptor(Descriptor
replaces the Descriptor associated with the
ModelMBeanNotification interface inDescriptor)Implements javax. Sets associated Descriptor (full replace) for the ModelMBeanNotificationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor. |
| public String | Returns: a string describing this object.Overrides javax. Returns a human readable string containing ModelMBeanNotificationInfo. |
| private Descriptor | validDescriptor(final Descriptor
Descriptor to be checked, or null which is equivalent to an
empty Descriptor. in)Clones the passed in Descriptor, sets default values, and checks for validity. |
| private void | writeObject(ObjectOutputStream out)
Hides javax. Serializes a |
| compat | back to summary |
|---|---|
| private static boolean compat | |
| currClass | back to summary |
|---|---|
| private static final String currClass | |
| newSerialPersistentFields | back to summary |
|---|---|
| private static final ObjectStreamField[] newSerialPersistentFields | |
| newSerialVersionUID | back to summary |
|---|---|
| private static final long newSerialVersionUID | |
| notificationDescriptor | back to summary |
|---|---|
| private Descriptor notificationDescriptor | |
| oldSerialPersistentFields | back to summary |
|---|---|
| private static final ObjectStreamField[] oldSerialPersistentFields | |
| oldSerialVersionUID | back to summary |
|---|---|
| private static final long oldSerialVersionUID | |
| serialPersistentFields | back to summary |
|---|---|
private static final ObjectStreamField[] serialPersistentFields
| |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides javax. | |
| ModelMBeanNotificationInfo | back to summary |
|---|---|
| public ModelMBeanNotificationInfo(String[] notifTypes, String name, String description) Constructs a ModelMBeanNotificationInfo object with a default descriptor. | |
| ModelMBeanNotificationInfo | back to summary |
|---|---|
| public ModelMBeanNotificationInfo(String[] notifTypes, String name, String description, Descriptor descriptor) Constructs a ModelMBeanNotificationInfo object.
| |
| ModelMBeanNotificationInfo | back to summary |
|---|---|
| public ModelMBeanNotificationInfo(ModelMBeanNotificationInfo inInfo) Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object.
| |
| clone | back to summary |
|---|---|
| public Object clone() Overrides javax. Creates and returns a new ModelMBeanNotificationInfo which is a duplicate of this ModelMBeanNotificationInfo.
| |
| getDescriptor | back to summary |
|---|---|
| public Descriptor getDescriptor() Overrides javax. Implements javax. Returns a copy of the associated Descriptor for the ModelMBeanNotificationInfo.
| |
| readObject | back to summary |
|---|---|
| private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Hides javax. Deserializes a | |
| setDescriptor | back to summary |
|---|---|
| public void setDescriptor(Descriptor inDescriptor) Implements javax. 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.
| |
| toString | back to summary |
|---|---|
| public String toString() Overrides javax. Returns a human readable string containing ModelMBeanNotificationInfo.
| |
| validDescriptor | back to summary |
|---|---|
| private Descriptor validDescriptor(final Descriptor in) throws RuntimeOperationsException Clones the passed in Descriptor, sets default values, and checks for validity. If the Descriptor is invalid (for instance by having the wrong "name"), this indicates programming error and a RuntimeOperationsException will be thrown. The following fields will be defaulted if they are not already set: descriptorType="notification",displayName=this.getName(), name=this.getName(),severity="6"
| |
| writeObject | back to summary |
|---|---|
| private void writeObject(ObjectOutputStream out) throws IOException Hides javax. Serializes a | |