org.ptolemy.ptango.lib.xmpp

Interface XMPPSubscriber

All Superinterfaces:

org.jivesoftware.smackx.pubsub.listener.ItemEventListener<org.jivesoftware.smackx.pubsub.Item>

All Known Implementing Classes:

XMPPSource

public interface XMPPSubscriber
extends org.jivesoftware.smackx.pubsub.listener.ItemEventListener<org.jivesoftware.smackx.pubsub.Item>

An interface for actors that subscribe to an XMPP XEP-0060 node.

Since:

Ptolemy II 10.0

Version:

$Id: XMPPSubscriber.java 69607 2014-07-30 17:07:26Z cxh $

Author:

Marten Lohstroh

See Also:

XMPPGateway

Accepted Rating:

Red (marten)

Proposed Rating:

Red (marten)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNodeId() Get the nodeId to subscribe to.
java.lang.String	getSubId() Get the subscriber ID.
void	setGateway(XMPPGateway gateway) Register the gateway to the subscriber, so that if the subscription changes, it can notify the gateway.
void	setSubId(java.lang.String subId) Set the subscription id returned by SmackPubSubAccess.subscribeToNode(). // FIXME out-dated

Methods inherited from interface org.jivesoftware.smackx.pubsub.listener.ItemEventListener

handlePublishedItems

Method Detail

getNodeId

java.lang.String getNodeId()

Get the nodeId to subscribe to.

Returns:

A string representing the node to subscribe to.

getSubId

java.lang.String getSubId()

Get the subscriber ID.

Returns:

The subscriber ID.

See Also:

setSubId(String)

setGateway

void setGateway(XMPPGateway gateway)

Register the gateway to the subscriber, so that if the subscription changes, it can notify the gateway.

Parameters:

gateway - The attribute responsible for managing the XMPP session.

setSubId

void setSubId(java.lang.String subId)

Set the subscription id returned by SmackPubSubAccess.subscribeToNode(). // FIXME out-dated

Parameters:

subId - A string identifying this subscriber.

See Also:

getSubId()