ModelMBeanNotificationInfo (Java Platform SE 8 ) (original) (raw)
- javax.management.MBeanFeatureInfo
- javax.management.MBeanNotificationInfo
- javax.management.modelmbean.ModelMBeanNotificationInfo
- javax.management.MBeanNotificationInfo
All Implemented Interfaces:
Serializable, Cloneable, DescriptorAccess, DescriptorRead
public class ModelMBeanNotificationInfo
extends MBeanNotificationInfo
implements DescriptorAccess
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 . |
||
Since: | ||
1.5 | ||
See Also: | ||
Serialized Form |
Field Summary
* ### Fields inherited from class javax.management.[MBeanFeatureInfo](../../../javax/management/MBeanFeatureInfo.html "class in javax.management") `[description](../../../javax/management/MBeanFeatureInfo.html#description), [name](../../../javax/management/MBeanFeatureInfo.html#name)`
Constructor Summary
Constructors
Constructor Description ModelMBeanNotificationInfo(ModelMBeanNotificationInfo inInfo) Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object. 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. Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type Method Description 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. * ### Methods inherited from class javax.management.[MBeanNotificationInfo](../../../javax/management/MBeanNotificationInfo.html "class in javax.management") `[equals](../../../javax/management/MBeanNotificationInfo.html#equals-java.lang.Object-), [getNotifTypes](../../../javax/management/MBeanNotificationInfo.html#getNotifTypes--), [hashCode](../../../javax/management/MBeanNotificationInfo.html#hashCode--)` * ### Methods inherited from class javax.management.[MBeanFeatureInfo](../../../javax/management/MBeanFeatureInfo.html "class in javax.management") `[getDescription](../../../javax/management/MBeanFeatureInfo.html#getDescription--), [getName](../../../javax/management/MBeanFeatureInfo.html#getName--)` * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang") `[finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`
Constructor Detail
* #### ModelMBeanNotificationInfo public ModelMBeanNotificationInfo([String](../../../java/lang/String.html "class in java.lang")[] notifTypes, [String](../../../java/lang/String.html "class in java.lang") name, [String](../../../java/lang/String.html "class in java.lang") 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. * #### ModelMBeanNotificationInfo public ModelMBeanNotificationInfo([String](../../../java/lang/String.html "class in java.lang")[] notifTypes, [String](../../../java/lang/String.html "class in java.lang") name, [String](../../../java/lang/String.html "class in java.lang") description, [Descriptor](../../../javax/management/Descriptor.html "interface in javax.management") 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", the missing ones are added with their default values. Throws: `[RuntimeOperationsException](../../../javax/management/RuntimeOperationsException.html "class in javax.management")` \- Wraps an[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang"). The descriptor is invalid, or descriptor field "name" is not equal to parameter name, or descriptor field "descriptorType" is not equal to "notification". * #### ModelMBeanNotificationInfo public ModelMBeanNotificationInfo([ModelMBeanNotificationInfo](../../../javax/management/modelmbean/ModelMBeanNotificationInfo.html "class in javax.management.modelmbean") inInfo) Constructs a new ModelMBeanNotificationInfo object from this ModelMBeanNotfication Object. Parameters: `inInfo` \- the ModelMBeanNotificationInfo to be duplicated
Method Detail
* #### clone public [Object](../../../java/lang/Object.html "class in java.lang") clone() Creates and returns a new ModelMBeanNotificationInfo which is a duplicate of this ModelMBeanNotificationInfo. Overrides: `[clone](../../../javax/management/MBeanNotificationInfo.html#clone--)` in class `[MBeanNotificationInfo](../../../javax/management/MBeanNotificationInfo.html "class in javax.management")` Returns: a clone of this instance. See Also: [Cloneable](../../../java/lang/Cloneable.html "interface in java.lang") * #### getDescriptor public [Descriptor](../../../javax/management/Descriptor.html "interface in javax.management") getDescriptor() Returns a copy of the associated Descriptor for the ModelMBeanNotificationInfo. Specified by: `[getDescriptor](../../../javax/management/DescriptorRead.html#getDescriptor--)` in interface `[DescriptorRead](../../../javax/management/DescriptorRead.html "interface in javax.management")` Overrides: `[getDescriptor](../../../javax/management/MBeanFeatureInfo.html#getDescriptor--)` in class `[MBeanFeatureInfo](../../../javax/management/MBeanFeatureInfo.html "class in javax.management")` Returns: Descriptor associated with the ModelMBeanNotificationInfo object. See Also: [setDescriptor(javax.management.Descriptor)](../../../javax/management/modelmbean/ModelMBeanNotificationInfo.html#setDescriptor-javax.management.Descriptor-) * #### setDescriptor public void setDescriptor([Descriptor](../../../javax/management/Descriptor.html "interface in javax.management") 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. Specified by: `[setDescriptor](../../../javax/management/DescriptorAccess.html#setDescriptor-javax.management.Descriptor-)` in interface `[DescriptorAccess](../../../javax/management/DescriptorAccess.html "interface in javax.management")` Parameters: `inDescriptor` \- replaces the Descriptor associated with the ModelMBeanNotification interface Throws: `[RuntimeOperationsException](../../../javax/management/RuntimeOperationsException.html "class in javax.management")` \- Wraps an[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") for invalid Descriptor. See Also: [getDescriptor()](../../../javax/management/modelmbean/ModelMBeanNotificationInfo.html#getDescriptor--) * #### toString public [String](../../../java/lang/String.html "class in java.lang") toString() Returns a human readable string containing ModelMBeanNotificationInfo. Overrides: `[toString](../../../javax/management/MBeanNotificationInfo.html#toString--)` in class `[MBeanNotificationInfo](../../../javax/management/MBeanNotificationInfo.html "class in javax.management")` Returns: a string describing this object.
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.