cern.cmw.mom.pubsub

Class NotificationHelper

java.lang.Object

cern.cmw.mom.pubsub.NotificationHelper

public final class NotificationHelper
extends java.lang.Object

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.

Author:

Controls Middleware Project

See Also:

Notification

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	CarrierTopics Array containing the topics used for distributing notifications.
static int	CONSUMER_ALIVE_NOTIFICATION Subscription keep-alive notification.
static int	CONSUMER_CLOSE_NOTIFICATION Subscriber close notification.
static int	CONSUMER_NOTIFICATION Subscription related notification.
static int	CONSUMER_OPEN_NOTIFICATION Subscriber open notification.
static int	NOTIFICATION Generic notification.
static java.lang.String	NOTIFICATION_TYPE_PROPERTY Message property name identifying the notification type.
static java.lang.String	SELECTOR_PROPERTY Message property name identifying the selector the notification is about.
static java.lang.String	SUBSCRIPTION_ID_PROPERTY Message property name identifying the subscription the notification is about.
static java.lang.String	TOPIC_PROPERTY Message property name identifying the topic the notification is about.

Constructor Summary

Constructors

Constructor and Description
NotificationHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	isNotification(java.lang.String topic) Return true if the topic is a notification topic.
static Notification	messageToNotification(Message m) Convert a Message into a Notification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CarrierTopics

public static final java.lang.String[] CarrierTopics

Array containing the topics used for distributing notifications.

NOTIFICATION

public static final int NOTIFICATION

Generic notification.

See Also:

Constant Field Values

CONSUMER_NOTIFICATION

public static final int CONSUMER_NOTIFICATION

Subscription related notification.

See Also:

Constant Field Values

CONSUMER_OPEN_NOTIFICATION

public static final int CONSUMER_OPEN_NOTIFICATION

Subscriber open notification.

See Also:

Constant Field Values

CONSUMER_CLOSE_NOTIFICATION

public static final int CONSUMER_CLOSE_NOTIFICATION

Subscriber close notification.

See Also:

Constant Field Values

CONSUMER_ALIVE_NOTIFICATION

public static final int CONSUMER_ALIVE_NOTIFICATION

Subscription keep-alive notification.

See Also:

Constant Field Values

NOTIFICATION_TYPE_PROPERTY

public static final java.lang.String NOTIFICATION_TYPE_PROPERTY

Message property name identifying the notification type.

See Also:

Constant Field Values

TOPIC_PROPERTY

public static final java.lang.String TOPIC_PROPERTY

Message property name identifying the topic the notification is about.

See Also:

Constant Field Values

SELECTOR_PROPERTY

public static final java.lang.String SELECTOR_PROPERTY

Message property name identifying the selector the notification is about.

See Also:

Constant Field Values

SUBSCRIPTION_ID_PROPERTY

public static final java.lang.String SUBSCRIPTION_ID_PROPERTY

Message property name identifying the subscription the notification is about.

See Also:

Constant Field Values

Constructor Detail

NotificationHelper

public NotificationHelper()

Method Detail

isNotification

public static final boolean isNotification(java.lang.String topic)

Return true if the topic is a notification topic.

Parameters:

topic - The topic to check.

Returns:

boolean

messageToNotification

public static Notification messageToNotification(Message m)

Convert a Message into a Notification.

Parameters:

m - The Message to convert

Returns:

Notification The Notification instance