Cisco Systems, Inc.

com.pcube.apps.engage
Class Notification

java.lang.Object
  extended by java.util.EventObject
      extended by javax.management.Notification
          extended by com.pcube.apps.engage.Notification
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ConnectionStateChangedNotification

public class Notification
extends javax.management.Notification
implements java.io.Serializable

A notification sent to the NotificationListener. The notifications are of the ENGAGE_GENERAL_NOTIFICATION, ENGAGE_WARNING_NOTIFICATION or ENGAGE_ERROR_NOTIFICATION type. Each notification has a notification message, type and level - NOTIFICATION_LEVEL_LOW for all listeners or NOTIFICATION_LEVEL_HIGH as being a detailed notification.

See Also:
Serialized Form

Field Summary
static byte ENGAGE_ERROR_NOTIFICATION
          An error notification
static byte ENGAGE_GENERAL_NOTIFICATION
          A general notification
static byte ENGAGE_WARNING_NOTIFICATION
          A warning notification
static byte NOTIFICATION_LEVEL_HIGH
          A detailed notification - for listeners that want high filtered notifications
static byte NOTIFICATION_LEVEL_LOW
          A notification for all listeners - get all warnings and errors
static byte POLICY_AND_SUBSCRIBER_CLIENT_NOTIFICATION
          The notification is meant for both Policy and Subscriber clients
static byte POLICY_CLIENT_NOTIFICATION
          The notification is meant for Policy clients
static byte SUBSCRIBER_CLIENT_NOTIFICATION
          The notification is meant for Subscriber clients
 
Constructor Summary
Notification(java.lang.String msg, byte msgType, byte msgClients, byte msgLevel)
           
Notification(java.lang.String msg, java.lang.Object source, byte msgType, byte msgClients, byte msgLevel)
          Notification Constructor.
 
Method Summary
 java.lang.String getNotification()
          Gets this notification's message.
 byte getNotificationClients()
          Gets the notifications clients.
 byte getNotificationLevel()
          Gets the notification's level.
 byte getNotificationType()
          Gets this notification's type.
 java.lang.String toString()
           
 
Methods inherited from class javax.management.Notification
getMessage, getSequenceNumber, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NOTIFICATION_LEVEL_LOW

public static final byte NOTIFICATION_LEVEL_LOW
A notification for all listeners - get all warnings and errors

See Also:
Constant Field Values

NOTIFICATION_LEVEL_HIGH

public static final byte NOTIFICATION_LEVEL_HIGH
A detailed notification - for listeners that want high filtered notifications

See Also:
Constant Field Values

ENGAGE_GENERAL_NOTIFICATION

public static final byte ENGAGE_GENERAL_NOTIFICATION
A general notification

See Also:
Constant Field Values

ENGAGE_WARNING_NOTIFICATION

public static final byte ENGAGE_WARNING_NOTIFICATION
A warning notification

See Also:
Constant Field Values

ENGAGE_ERROR_NOTIFICATION

public static final byte ENGAGE_ERROR_NOTIFICATION
An error notification

See Also:
Constant Field Values

POLICY_CLIENT_NOTIFICATION

public static final byte POLICY_CLIENT_NOTIFICATION
The notification is meant for Policy clients

See Also:
Constant Field Values

SUBSCRIBER_CLIENT_NOTIFICATION

public static final byte SUBSCRIBER_CLIENT_NOTIFICATION
The notification is meant for Subscriber clients

See Also:
Constant Field Values

POLICY_AND_SUBSCRIBER_CLIENT_NOTIFICATION

public static final byte POLICY_AND_SUBSCRIBER_CLIENT_NOTIFICATION
The notification is meant for both Policy and Subscriber clients

See Also:
Constant Field Values
Constructor Detail

Notification

public Notification(java.lang.String msg,
                    java.lang.Object source,
                    byte msgType,
                    byte msgClients,
                    byte msgLevel)
Notification Constructor.

Parameters:
msg - this notification's message
msgType - this notification's message's type
msgClients -
msgLevel - this notification's level

Notification

public Notification(java.lang.String msg,
                    byte msgType,
                    byte msgClients,
                    byte msgLevel)
Method Detail

getNotification

public java.lang.String getNotification()
Gets this notification's message.

Returns:
this notification's message

getNotificationType

public byte getNotificationType()
Gets this notification's type.

Returns:
the notification level
See Also:
ENGAGE_GENERAL_NOTIFICATION, ENGAGE_WARNING_NOTIFICATION, ENGAGE_ERROR_NOTIFICATION

getNotificationLevel

public byte getNotificationLevel()
Gets the notification's level.

Returns:
this notification's level
See Also:
NOTIFICATION_LEVEL_LOW, NOTIFICATION_LEVEL_HIGH

getNotificationClients

public byte getNotificationClients()
Gets the notifications clients. The notification system is used both by the Policy clients and by the Subscriber clients. There are messages which are intended only for on of them or for both of them.

Returns:
this notification's clients
See Also:
POLICY_CLIENT_NOTIFICATION, SUBSCRIBER_CLIENT_NOTIFICATION, POLICY_AND_SUBSCRIBER_CLIENT_NOTIFICATION

toString

public java.lang.String toString()
Overrides:
toString in class javax.management.Notification

Cisco Systems, Inc.

Copyright © 2013 Cisco Systems, Inc. Confidential.