org.globus.wsrf
Interface Topic

All Superinterfaces:

TopicListenerList

All Known Implementing Classes:

ResourcePropertyTopic, SimpleTopic

public interface Topic

extends TopicListenerList

Interface for representing a topic. A topic is either a child of a parent topic or in the case of root topics a member of a topic list. Non-root topics have names without a namespace component.

See Also:

TopicList

Method Summary

void	addTopic(Topic topic) Add a sub-topic.
java.lang.Object	getCurrentMessage() Get the current notification message if there is any
javax.xml.namespace.QName	getName() Get the name of the topic.
Topic	getTopic(javax.xml.namespace.QName topicName) Get the sub-topic with the given topic name
java.util.List	getTopicPath() Get the topic path.
TopicExpressionType	getTopicReference() Get the topic expression for the topic(s) that this topic references.
boolean	isReference() Is this a topic reference?
void	notify(java.lang.Object obj) Send out a notification on this topic
void	removeTopic(Topic topic) Remove a sub-topic
void	setTopicPath(java.util.List topicPath) Set the topic path.
void	setTopicReference(TopicExpressionType topicPath) Set the topic expression that resolves to a set of topics that this topic references.
java.util.Iterator	topicIterator() Iterator for the set of child topics

Methods inherited from interface org.globus.wsrf.TopicListenerList

addTopicListener, removeTopicListener, topicListenerIterator

Method Detail

addTopic

public void addTopic(Topic topic)
              throws java.lang.Exception

Add a sub-topic.

Parameters:

topic - The sub-topic to add

Throws:

java.lang.Exception

removeTopic

public void removeTopic(Topic topic)

Remove a sub-topic

Parameters:

topic - The sub-topic to remove

getTopic

public Topic getTopic(javax.xml.namespace.QName topicName)

Get the sub-topic with the given topic name

Parameters:

topicName - The topic name of the sub topic

Returns:

The sub-topic

setTopicReference

public void setTopicReference(TopicExpressionType topicPath)

Set the topic expression that resolves to a set of topics that this topic references. Only used for reference topics.

Parameters:

topicPath - The topic expression to set.

getTopicReference

public TopicExpressionType getTopicReference()

Get the topic expression for the topic(s) that this topic references.

Returns:

The topic expression that this topic reference or null if this topic is not a reference.

setTopicPath

public void setTopicPath(java.util.List topicPath)

Set the topic path. The topic path is represented as a ordered list of topic names

Parameters:

topicPath - The topic path to associate with this topic

getTopicPath

public java.util.List getTopicPath()

Get the topic path. The topic path is represented as a ordered list of topic names

Returns:

The topic path of this topic

getName

public javax.xml.namespace.QName getName()

Get the name of the topic. Only root topics should actually be qualified names, other topic should be non-qualified

Returns:

The name of the topic

getCurrentMessage

public java.lang.Object getCurrentMessage()

Get the current notification message if there is any

Returns:

A object containing the current message, may be null

notify

public void notify(java.lang.Object obj)
            throws java.lang.Exception

Send out a notification on this topic

Parameters:

obj - Object representation of the message to send

Throws:

java.lang.Exception

isReference

public boolean isReference()

Is this a topic reference?

Returns:

true if this topic is a reference to another topic false if not

topicIterator

public java.util.Iterator topicIterator()

Iterator for the set of child topics

Returns:

The iterator