Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

cern::cmw::mom::pubsub::NotificationHelper Class Reference

List of all members.

Static Public Member Functions

final boolean isNotification (String topic)
Notification messageToNotification (Message m)

Static Public Attributes

final String[] CarrierTopics
final int NOTIFICATION = 0
final int CONSUMER_NOTIFICATION = 1
final int CONSUMER_OPEN_NOTIFICATION = 2
final int CONSUMER_CLOSE_NOTIFICATION = 3
final int CONSUMER_ALIVE_NOTIFICATION = 4
final String NOTIFICATION_TYPE_PROPERTY = "NOTIFICATION_TYPE"
final String TOPIC_PROPERTY = "TOPIC"
final String SELECTOR_PROPERTY = "SELECTOR"
final String SUBSCRIPTION_ID_PROPERTY = "SUBSCRIPTION_ID"

Static Package Attributes

Category cat = Category.getInstance(NotificationHelper.class.getName())

Static Private Attributes

final String T_NOTIFICATIONS_ROOT = "CMW.ADMIN.NOTIFICATIONS"
final String T_NOTIFICATIONS = "CMW.ADMIN.NOTIFICATIONS.#"
final String T_CONSUMER_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.#"
final String T_OPEN_SUB_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.OPEN_SUBSCRIPTION"
final String T_CLOSE_SUB_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.CLOSE_SUBSCRIPTION"
final String T_KEEP_ALIVE_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.KEEP_ALIVE_SUBSCRIPTION"

Detailed Description

Public class. Helper class for notification handling. Several mission-critical applications require a capability to be notified about special events such as the creation/destruction of a subscription. Some client might also be interested in knowing if a specific topic is beeing subscribed. A notification class hierarchy corrensponds to the different type of notifications published by the system on specific administrative topics. The helper class offers fields and static methods to deal with Notifications.
Version:
1.0 23 Jan 2001
Author:
Controls Middleware Project
See also:
Notification


Member Function Documentation

final boolean cern::cmw::mom::pubsub::NotificationHelper::isNotification String  topic  )  [inline, static]
 

Return true if the topic is a notification topic.

Parameters:
topic The topic to check.
Returns:
boolean

Notification cern::cmw::mom::pubsub::NotificationHelper::messageToNotification Message  m  )  [inline, static]
 

Convert a Message into a Notification.

Parameters:
m The Message to convert
Returns:
Notification The Notification instance


Member Data Documentation

final String [] cern::cmw::mom::pubsub::NotificationHelper::CarrierTopics [static]
 

Initial value:

Array containing the topics used for distributing notifications.

Category cern::cmw::mom::pubsub::NotificationHelper::cat = Category.getInstance(NotificationHelper.class.getName()) [static, package]
 

final int cern::cmw::mom::pubsub::NotificationHelper::CONSUMER_ALIVE_NOTIFICATION = 4 [static]
 

Subscription keep-alive notification.

final int cern::cmw::mom::pubsub::NotificationHelper::CONSUMER_CLOSE_NOTIFICATION = 3 [static]
 

Subscriber close notification.

final int cern::cmw::mom::pubsub::NotificationHelper::CONSUMER_NOTIFICATION = 1 [static]
 

Subscription related notification.

final int cern::cmw::mom::pubsub::NotificationHelper::CONSUMER_OPEN_NOTIFICATION = 2 [static]
 

Subscriber open notification.

final int cern::cmw::mom::pubsub::NotificationHelper::NOTIFICATION = 0 [static]
 

Generic notification.

final String cern::cmw::mom::pubsub::NotificationHelper::NOTIFICATION_TYPE_PROPERTY = "NOTIFICATION_TYPE" [static]
 

Message property name identifying the notification type.

final String cern::cmw::mom::pubsub::NotificationHelper::SELECTOR_PROPERTY = "SELECTOR" [static]
 

Message property name identifying the selector the notification is about.

final String cern::cmw::mom::pubsub::NotificationHelper::SUBSCRIPTION_ID_PROPERTY = "SUBSCRIPTION_ID" [static]
 

Message property name identifying the subscription the notification is about.

final String cern::cmw::mom::pubsub::NotificationHelper::T_CLOSE_SUB_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.CLOSE_SUBSCRIPTION" [static, private]
 

final String cern::cmw::mom::pubsub::NotificationHelper::T_CONSUMER_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.#" [static, private]
 

final String cern::cmw::mom::pubsub::NotificationHelper::T_KEEP_ALIVE_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.KEEP_ALIVE_SUBSCRIPTION" [static, private]
 

final String cern::cmw::mom::pubsub::NotificationHelper::T_NOTIFICATIONS = "CMW.ADMIN.NOTIFICATIONS.#" [static, private]
 

final String cern::cmw::mom::pubsub::NotificationHelper::T_NOTIFICATIONS_ROOT = "CMW.ADMIN.NOTIFICATIONS" [static, private]
 

final String cern::cmw::mom::pubsub::NotificationHelper::T_OPEN_SUB_NOTIFICATIONS = T_NOTIFICATIONS_ROOT + ".CONSUMER.OPEN_SUBSCRIPTION" [static, private]
 

final String cern::cmw::mom::pubsub::NotificationHelper::TOPIC_PROPERTY = "TOPIC" [static]
 

Message property name identifying the topic the notification is about.


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:07:58 2009 for ACS Java API by doxygen 1.3.8