org.apache.muse.ws.notification.topics
Interface Topic
- All Superinterfaces:
- XmlSerializable
- All Known Implementing Classes:
- SimpleTopic
public interface Topic
- extends XmlSerializable
Topic is an interface that represents the wsnt:Topic data structure described
in WS-Notification v1.3 and WS-Topics v1.3. Instances of this type are
collected by WS-N NotificationProducer implementations to implement topic
filters on subscriptions.
- Author:
- Dan Jemiolo (danj)
addMessageType
void addMessageType(QName messageType)
addTopic
void addTopic(Topic childTopic)
throws BaseFault
- Adds a child topic to the topic.
- Parameters:
childTopic
-
- Throws:
BaseFault
getConcretePath
QName getConcretePath()
- Returns:
- A fully-qualified name for the topic.
getCurrentMessage
NotificationMessage getCurrentMessage()
- Returns:
- The last message published to this topic.
getMessagePattern
String getMessagePattern()
getMessagePatternDialect
String getMessagePatternDialect()
getMessageTypes
Set getMessageTypes()
getName
String getName()
- Returns:
- The local name of the topic.
getParentTopic
Topic getParentTopic()
getTopic
Topic getTopic(String topicName)
- Parameters:
topicName
-
- Returns:
- The child topic with the given name, or null if no such topic exists.
getTopicNamespace
TopicNamespace getTopicNamespace()
- Returns:
- The TopicNamespace that contains this Topic.
getTopics
Collection getTopics()
- Returns:
- All of the child topics under this topic.
hasTopic
boolean hasTopic(String topicName)
- Parameters:
topicName
-
- Returns:
- True if this topic has a child topic with the given name.
isFinal
boolean isFinal()
- Returns:
- True if the topic does not allow addition of child topics.
isRootTopic
boolean isRootTopic()
- Returns:
- True if the topic has no parent topic.
removeAllTopics
void removeAllTopics()
removeMessageType
void removeMessageType(QName messageType)
removeTopic
void removeTopic(String topicName)
setCurrentMessage
void setCurrentMessage(NotificationMessage message)
- Parameters:
message
- The last message published to this topic.
setFinal
void setFinal(boolean isFinal)
setMessagePattern
void setMessagePattern(String messagePattern)
setParentTopic
void setParentTopic(Topic parentTopic)
throws BaseFault
- Throws:
BaseFault
Copyright © 2005-2011 Apache Web Services - Muse. All Rights Reserved.