com.silverpeas.notification
Class NotificationTopic

java.lang.Object
  com.silverpeas.notification.NotificationTopic

public class NotificationTopic
extends Object

Topic on which notifications are published. A topic is a way to gather notifications of the same type or about the same kind of events or actions occuring in Silverpeas. Notification is always sent to a given topic and notification consumers indicates always the type of notification they are interested by subscribing to the corresponding notification topics.

Method Summary

String	getName() Gets the name of this topic.
RegisteredTopics	getRegisteredTopic() Gets the name of this topic.
static NotificationTopic	onTopic(RegisteredTopics topic) Gets a topic matching the specified name.
static NotificationTopic	onTopic(String topicName) Gets a topic matching the specified name.

Methods inherited from class java.lang.Object

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

Method Detail

onTopic

public static NotificationTopic onTopic(RegisteredTopics topic)

Gets a topic matching the specified name. The topic must exist in the underlying messaging system.

Parameters:

topic - the topic to get.

Returns:

the topic with the specified name.

onTopic

public static NotificationTopic onTopic(String topicName)

Gets a topic matching the specified name. The topic must exist in the underlying messaging system.

Parameters:

topicName - the name of the topic to get.

Returns:

the topic with the specified name.

getName

public String getName()

Gets the name of this topic.

Returns:

the topic name.

getRegisteredTopic

public RegisteredTopics getRegisteredTopic()

Gets the name of this topic.

Returns:

the topic name.