com.ibm.websphere.management

Class NotificationConstants

  • java.lang.Object
    • com.ibm.websphere.management.NotificationConstants

  • public class NotificationConstants
extends java.lang.Object
    Useful constants for applications which listen to notifications emitted from MBeans.

    For any particular notification (e.g. TYPE_PROCESS_STARTING, which is websphere.process.starting), there is a parent type which includes all notifications with that particular prefix (e.g. TYPE_PROCESS, which is websphere.process). This higher-level notification type can be used to receive all notifications that begin with that prefix.

    • Field Detail

      • TYPE_J2EE_STATE

        public static final java.lang.String TYPE_J2EE_STATE
        This group of notifications is used when an MBean changes state. One example is when a server starts, a TYPE_J2EE_STATE_STARTING notification is emitted by the Server MBean. However, server state change notifications are generally not available outside the process, because there can be no listeners added before the server is started. For server state change notifications, please see TYPE_PROCESS notifications.

        Also note that not all MBeans which change state emit this notification. Please examine the MBean documentation to see if a particular MBean emits this notification.

        See Also:
        Constant Field Values

      • TYPE_J2EE_STATE_STARTING

        public static final java.lang.String TYPE_J2EE_STATE_STARTING
        Notification type indicating the state is now "starting".
        See Also:
        Constant Field Values

      • TYPE_J2EE_STATE_RUNNING

        public static final java.lang.String TYPE_J2EE_STATE_RUNNING
        Notification type indicating the state is now "running".
        See Also:
        Constant Field Values

      • TYPE_J2EE_STATE_STOPPING

        public static final java.lang.String TYPE_J2EE_STATE_STOPPING
        Notification type indicating the state is now "stopping".
        See Also:
        Constant Field Values

      • TYPE_J2EE_STATE_STOPPED

        public static final java.lang.String TYPE_J2EE_STATE_STOPPED
        Notification type indicating the state is now "stopped".
        See Also:
        Constant Field Values

      • TYPE_J2EE_STATE_FAILED

        public static final java.lang.String TYPE_J2EE_STATE_FAILED
        Notification type indicating the state is now "failed".
        See Also:
        Constant Field Values

      • TYPE_PROCESS

        public static final java.lang.String TYPE_PROCESS
        This set of notifications is used for state change of a child process. The purpose of these notifications is to model the TYPE_J2EE_STATE notifications for server start and stop, when a NotificationListener cannot be added directly to the server which is starting or stopping.

        For example, when an application service is started with the NodeAgent.launchProcess operation, the NodeAgent emits a TYPE_PROCESS_STARTING notification. Similarly, when a NodeAgent is fully operational, the DeploymentManager MBean emits a TYPE_PROCESS_RUNNING notification.

        Each of these notifications has a java.util.Properties object as the userData attribute. The name of the process whose state is changing has the key KEY_PROCESS_NAME. If the DeploymentManager is emitting the notification (i.e. the NodeAgent is changing state), the KEY_NODE_NAME is also contained in the user data.

        See Also:
        Constant Field Values

      • TYPE_PROCESS_STARTING

        public static final java.lang.String TYPE_PROCESS_STARTING
        Notification type from a NodeAgent MBean indicating that the process just launched now has state "starting".
        See Also:
        Constant Field Values

      • TYPE_PROCESS_RUNNING

        public static final java.lang.String TYPE_PROCESS_RUNNING
        Notification type from a NodeAgent MBean indicating that the process just launched now has state "running".
        See Also:
        Constant Field Values

      • TYPE_PROCESS_STOPPING

        public static final java.lang.String TYPE_PROCESS_STOPPING
        Notification type from a NodeAgent MBean indicating that the process just launched now has state "stopping".
        See Also:
        Constant Field Values

      • TYPE_PROCESS_STOPPED

        public static final java.lang.String TYPE_PROCESS_STOPPED
        Notification type from a NodeAgent MBean indicating that the process just launched now has state "stopped".
        See Also:
        Constant Field Values

      • TYPE_PROCESS_FAILED

        public static final java.lang.String TYPE_PROCESS_FAILED
        Notification type from a NodeAgent MBean indicating that the process just launched now has state "failed".
        See Also:
        Constant Field Values

      • TYPE_PROCESS_NOT_MONITORED

        public static final java.lang.String TYPE_PROCESS_NOT_MONITORED
        Notification type from a NodeAgent MBean indicating that the process being terminated will not be monitored. This is used only by the scripting component. pok_PQ98443.1
        See Also:
        Constant Field Values

      • KEY_PROCESS_NAME

        public static final java.lang.String KEY_PROCESS_NAME
        The key in user data of a TYPE_PROCESS notification indicating the name of the process to which the current notification applies.
        See Also:
        Constant Field Values

      • KEY_NODE_NAME

        public static final java.lang.String KEY_NODE_NAME
        The key in user data of a TYPE_PROCESS notification indicating the name of the node to which the current notification applies
        See Also:
        Constant Field Values

      • KEY_PROCESS_VERSION

        public static final java.lang.String KEY_PROCESS_VERSION
        The key in user data of a TYPE_PROCESS notification indicating the version of the process to which the current notification applies.
        See Also:
        Constant Field Values

      • KEY_PROCESS_ID

        public static final java.lang.String KEY_PROCESS_ID
        The key in user data of a TYPE_PROCESS notification indicating the pid of the process to which the current notification applies.
        See Also:
        Constant Field Values

      • TYPE_NODESYNC

        public static final java.lang.String TYPE_NODESYNC
        Notifications from a NodeSyncMBean indicating that a nodesync operation is being performed.
        See Also:
        Constant Field Values

      • TYPE_NODESYNC_INITIATED

        public static final java.lang.String TYPE_NODESYNC_INITIATED
        Notification type from a NodeSyncMBean indicating that a node configuration synchronization is initiated.
        See Also:
        Constant Field Values

      • TYPE_NODESYNC_COMPLETE

        public static final java.lang.String TYPE_NODESYNC_COMPLETE
        Notification type from a NodeSyncMBean indicating that a node configuration synchronization is complete. The user data is a Boolean indicating whether the operation result in any configuration changes.
        See Also:
        Constant Field Values

      • TYPE_MULTISYNC_EVENT

        public static final java.lang.String TYPE_MULTISYNC_EVENT
        Notification type from a DeploymentManager mbean indicating that a multisync event has occured. The message will be in the user data of the Notification.
        See Also:
        Constant Field Values

      • TYPE_DISCOVERY

        public static final java.lang.String TYPE_DISCOVERY
        Base type of all notifications emitted from a DiscoveryMBean. These notifications may change in future releases, and so should not be used by non-WebSphere code.
        See Also:
        Constant Field Values

      • TYPE_DISCOVERY_PROCESS_FOUND

        public static final java.lang.String TYPE_DISCOVERY_PROCESS_FOUND
        Notification type from a DiscoveryMBean indicating that a downstream process is discovered. The user data is a java.util.Properties which includes process name and its pid
        See Also:
        Constant Field Values

      • TYPE_DISCOVERY_PROCESS_LOST

        public static final java.lang.String TYPE_DISCOVERY_PROCESS_LOST
        Notification type from a DiscoveryMBean indicating that a downstream process is discovered. The user data is a java.util.Properties which includes process name
        See Also:
        Constant Field Values

      • TYPE_DISCOVERY_AGENT_FOUND

        public static final java.lang.String TYPE_DISCOVERY_AGENT_FOUND
        Notification type from a DiscoveryMBean indicating that an upstream agent (either nodeagent or deployment manager) is discovered. The user data is a com.ibm.ws.discovery.Agent object which encapulates its connection information
        See Also:
        Constant Field Values

      • TYPE_AGENT_DISCOVERED

        public static final java.lang.String TYPE_AGENT_DISCOVERED
        Deprecated. Replaced by TYPE_DISCOVERY_AGENT_FOUND
        Notification type from a DiscoveryMBean indicating that an upstream agent is discovered. The user data is a com.ibm.ws.discovery.ServerInfo object which encapulates information for discovered agent process
        See Also:
        Constant Field Values

      • TYPE_CLUSTER

        public static final java.lang.String TYPE_CLUSTER
        A set of notifications indicating that the state of a cluster has changed. These are similar to the WEBSPHERE_PROCESS notifications, but there are some additional state because a cluster is made up of more than one server.
        See Also:
        Constant Field Values

      • TYPE_CLUSTER_STARTING

        public static final java.lang.String TYPE_CLUSTER_STARTING
        Notification type from a Cluster indicating that the cluster is being started. The userData is a array of com.ibm.websphere.management.wlm.ClusterWeightTableEntry objects.
        See Also:
        Constant Field Values

      • TYPE_CLUSTER_PARTIAL_START

        public static final java.lang.String TYPE_CLUSTER_PARTIAL_START
        Notification type from a Cluster indicating that the cluster has partially started. The userData is a single com.ibm.websphere.management.wlm.ClusterWeightTableEntry object.
        See Also:
        Constant Field Values

      • TYPE_CLUSTER_RUNNING

        public static final java.lang.String TYPE_CLUSTER_RUNNING
        Notification type from a Cluster indicating that the cluster is completely started and running.
        See Also:
        Constant Field Values

      • TYPE_CLUSTER_STOPPING

        public static final java.lang.String TYPE_CLUSTER_STOPPING
        Notification type from a Cluster indicating that the cluster is being stopped.
        See Also:
        Constant Field Values

      • TYPE_CLUSTER_PARTIAL_STOP

        public static final java.lang.String TYPE_CLUSTER_PARTIAL_STOP
        Notification type from a Cluster indicating that the cluster is partially stopped.
        See Also:
        Constant Field Values

      • TYPE_CLUSTER_STOPPED

        public static final java.lang.String TYPE_CLUSTER_STOPPED
        Notification type from a Cluster indicating that the cluster is completely stopped.
        See Also:
        Constant Field Values

      • TYPE_CLUSTER_WEIGHT_TABLE_CHANGE

        public static final java.lang.String TYPE_CLUSTER_WEIGHT_TABLE_CHANGE
        Notification type from a Cluster indicating that the weight table changed.

        The notification user data contains the array of weight table entries.

        See Also:
        Constant Field Values

      • TYPE_CLUSTER_WEIGHT_TABLE_ENTRY_CHANGE

        public static final java.lang.String TYPE_CLUSTER_WEIGHT_TABLE_ENTRY_CHANGE
        Notification type from a Cluster indicating that an entry in the weight table change.

        The notification user data contains the specific weight table entry that changed.

        See Also:
        Constant Field Values

      • TYPE_ADDNODE

        public static final java.lang.String TYPE_ADDNODE
        Notifications of this type are emitted when an addNode operation is being performed. The user data for each notification is a java.util.Properties object containing at minimum the name of the node being added (KEY_ADDNODE_NAME);
        See Also:
        Constant Field Values

      • TYPE_ADDNODE_STARTING

        public static final java.lang.String TYPE_ADDNODE_STARTING
        A node is being added to the domain.
        See Also:
        Constant Field Values

      • TYPE_ADDNODE_COMPLETE

        public static final java.lang.String TYPE_ADDNODE_COMPLETE
        A node is finished being added to the domain.
        See Also:
        Constant Field Values

      • TYPE_ADDNODE_FAILED

        public static final java.lang.String TYPE_ADDNODE_FAILED
        The addNode processing has failed.
        See Also:
        Constant Field Values

      • TYPE_ADDNODE_MESSAGE

        public static final java.lang.String TYPE_ADDNODE_MESSAGE
        A message from the addNode processing has been generated.
        See Also:
        Constant Field Values

      • KEY_ADDNODE_NAME

        public static final java.lang.String KEY_ADDNODE_NAME
        A key in the user data properties object containing the name of the node being added.
        See Also:
        Constant Field Values

      • TYPE_REMOVENODE

        public static final java.lang.String TYPE_REMOVENODE
        Notifications of this type are emitted when an removeNode operation is being performed. The user data for each notification is a java.util.Properties object containing at minimum the name of the node being added (KEY_REMOVENODE_NAME);
        See Also:
        Constant Field Values

      • KEY_REMOVENODE_NAME

        public static final java.lang.String KEY_REMOVENODE_NAME
        A key in the user data properties object containing the name of the node being removed.
        See Also:
        Constant Field Values

      • TYPE_REMOVENODE_STARTING

        public static final java.lang.String TYPE_REMOVENODE_STARTING
        A node is being removed from the domain.
        See Also:
        Constant Field Values

      • TYPE_REMOVENODE_COMPLETE

        public static final java.lang.String TYPE_REMOVENODE_COMPLETE
        A node is finished being removed from the domain.
        See Also:
        Constant Field Values

      • TYPE_REMOVENODE_FAILED

        public static final java.lang.String TYPE_REMOVENODE_FAILED
        The removeNode processing has failed.
        See Also:
        Constant Field Values

      • TYPE_REMOVENODE_MESSAGE

        public static final java.lang.String TYPE_REMOVENODE_MESSAGE
        A message from the removeNode processing has been generated.
        See Also:
        Constant Field Values

      • TYPE_REPOSITORY

        public static final java.lang.String TYPE_REPOSITORY
        Notifications emitted from the ConfigRepository MBean when changes are being made to the config repository.
        See Also:
        Constant Field Values

      • TYPE_REPOSITORY_CHANGE_EVENT

        public static final java.lang.String TYPE_REPOSITORY_CHANGE_EVENT
        Repository change notification
        See Also:
        Constant Field Values

      • TYPE_REPOSITORY_LOCK_EVENT

        public static final java.lang.String TYPE_REPOSITORY_LOCK_EVENT
        Repository lock notification
        See Also:
        Constant Field Values

      • TYPE_REPOSITORY_UNLOCK_EVENT

        public static final java.lang.String TYPE_REPOSITORY_UNLOCK_EVENT
        Repository unlock notification
        See Also:
        Constant Field Values

      • TYPE_REPOSITORY_EPOCH_REFRESH_EVENT

        public static final java.lang.String TYPE_REPOSITORY_EPOCH_REFRESH_EVENT
        Repository epoch refresh notification
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT

        public static final java.lang.String TYPE_APPMANAGEMENT
        Base type for all application management events
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT_INSTALL

        public static final java.lang.String TYPE_APPMANAGEMENT_INSTALL
        Notification type for application installation events
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT_UNINSTALL

        public static final java.lang.String TYPE_APPMANAGEMENT_UNINSTALL
        Notification type for application uninstallation events
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT_UPDATE

        public static final java.lang.String TYPE_APPMANAGEMENT_UPDATE
        Notification type for application update events
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT_EDIT

        public static final java.lang.String TYPE_APPMANAGEMENT_EDIT
        Notification type for application edit events
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT_SYNC

        public static final java.lang.String TYPE_APPMANAGEMENT_SYNC
        Notification type for application sync events
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT_UPDATECLUSTER

        public static final java.lang.String TYPE_APPMANAGEMENT_UPDATECLUSTER
        Notification type for cluster update events
        See Also:
        Constant Field Values

      • TYPE_APPMANAGEMENT_RENAMEAPP

        public static final java.lang.String TYPE_APPMANAGEMENT_RENAMEAPP
        Notification type for application rename events
        See Also:
        Constant Field Values

      • TYPE_WORKSPACE_MANAGER

        public static final java.lang.String TYPE_WORKSPACE_MANAGER
        See Also:
        Constant Field Values

      • TYPE_RAS

        public static final java.lang.String TYPE_RAS
        Notifications emitted from the RasLoggingService MBean when a message is being logged. The userData for each notification is a com.ibm.ejs.ras.MessageEvent which contains the message which is being logged.
        See Also:
        Constant Field Values

      • TYPE_RAS_FATAL

        public static final java.lang.String TYPE_RAS_FATAL
        A fatal message is being logged.
        See Also:
        Constant Field Values

      • TYPE_RAS_ERROR

        public static final java.lang.String TYPE_RAS_ERROR
        An error message is being logged.
        See Also:
        Constant Field Values

      • TYPE_RAS_WARNING

        public static final java.lang.String TYPE_RAS_WARNING
        A warning message is being logged.
        See Also:
        Constant Field Values

      • TYPE_RAS_AUDIT

        public static final java.lang.String TYPE_RAS_AUDIT
        An audit message is being logged.
        See Also:
        Constant Field Values

      • TYPE_RAS_SERVICE

        public static final java.lang.String TYPE_RAS_SERVICE
        A service message is being logged.
        See Also:
        Constant Field Values

      • TYPE_RAS_INFO

        public static final java.lang.String TYPE_RAS_INFO
        An information message is being logged.
        See Also:
        Constant Field Values

      • TYPE_THREAD_MONITOR_THREAD_HUNG

        public static final java.lang.String TYPE_THREAD_MONITOR_THREAD_HUNG
        A notification that a thread is potentially hung. The userData for this type of notification is a java.util.Properties object containing values keyed by the various KEY_THREAD_MONITOR_* defined here.
        Since:
        5.0.3
        See Also:
        Constant Field Values

      • TYPE_THREAD_MONITOR_THREAD_CLEAR

        public static final java.lang.String TYPE_THREAD_MONITOR_THREAD_CLEAR
        A notification that a thread that was previously reported to be hung has now completed. The userData for this type of notification is a java.util.Properties object containing values keyed by the various KEY_THREAD_MONITOR_* defined here.
        Since:
        5.0.3
        See Also:
        Constant Field Values

      • KEY_THREAD_MONITOR_THREAD_NAME

        public static final java.lang.String KEY_THREAD_MONITOR_THREAD_NAME
        A property key for the thread name.
        See Also:
        Constant Field Values

      • HANDLE_NOTIFICATION_TIMEOUT_KEY

        public static final java.lang.String HANDLE_NOTIFICATION_TIMEOUT_KEY
        The key for a System property which can be used to specify how many milliseconds listeners have to complete a handleNotification() call until the listener is removed.
        See Also:
        Constant Field Values

      • HANDLE_NOTIFICATION_TIMEOUT_DEFAULT

        public static final long HANDLE_NOTIFICATION_TIMEOUT_DEFAULT
        Default value for HANDLE_NOTIFICATION_TIMEOUT_KEY.
        See Also:
        Constant Field Values

      • LOCAL_NOTIFICATION_SERVICE_THREAD_KEEPALIVE_TIME

        public static final java.lang.String LOCAL_NOTIFICATION_SERVICE_THREAD_KEEPALIVE_TIME
        The key for a System property which can be used to specify how many milliseconds a LocalNotificationService thread pool thread will be left idle before it is removed.

        The default "keep alive" time is 60,000 milliseconds (one minute).

        See Also:
        Constant Field Values

      • LOCAL_NOTIFICATION_SERVICE_THREAD_KEEPALIVE_TIME_DEFAULT

        public static final long LOCAL_NOTIFICATION_SERVICE_THREAD_KEEPALIVE_TIME_DEFAULT
        Default value for LOCAL_NOTIFICATION_SERVICE_THREAD_KEEPALIVE_TIME.
        See Also:
        Constant Field Values

      • HEAPDUMP_ATTEMPTING

        public static final java.lang.String HEAPDUMP_ATTEMPTING
        Notification types from JVM MBean heapdump operation. Formerly defined in com.ibm.ws.performance.tuning.serverAlert.MBeanNotificationResponse
        See Also:
        Constant Field Values

      • HEAPDUMP_GENERATED

        public static final java.lang.String HEAPDUMP_GENERATED
        See Also:
        Constant Field Values

      • ADVISOR_HEAPDUMP_AUTOMATED_PROCESS_STARTED

        public static final java.lang.String ADVISOR_HEAPDUMP_AUTOMATED_PROCESS_STARTED
        See Also:
        Constant Field Values

      • ADVISOR_HEAPDUMP_AUTOMOATED_PROCESS_FINISHED

        public static final java.lang.String ADVISOR_HEAPDUMP_AUTOMOATED_PROCESS_FINISHED
        See Also:
        Constant Field Values

      • SYSTEMDUMP_ATTEMPTING

        public static final java.lang.String SYSTEMDUMP_ATTEMPTING
        See Also:
        Constant Field Values

      • SYSTEMDUMP_GENERATED

        public static final java.lang.String SYSTEMDUMP_GENERATED
        See Also:
        Constant Field Values

      • ADMIN_AGENT_SUBSYSTEM_INIT

        public static final java.lang.String ADMIN_AGENT_SUBSYSTEM_INIT
        See Also:
        Constant Field Values

      • ADMIN_AGENT_SUBSYSTEM_DESTROY

        public static final java.lang.String ADMIN_AGENT_SUBSYSTEM_DESTROY
        See Also:
        Constant Field Values

      • ADMIN_AGENT_SUBSYSTEM_START

        public static final java.lang.String ADMIN_AGENT_SUBSYSTEM_START
        See Also:
        Constant Field Values

      • ADMIN_AGENT_SUBSYSTEM_STOP

        public static final java.lang.String ADMIN_AGENT_SUBSYSTEM_STOP
        See Also:
        Constant Field Values

    • Constructor Detail

      • NotificationConstants

        public NotificationConstants()
IBM WebSphere Application ServerTM
Release 8.5