org.ptolemy.ptango.lib.xmpp

Class XMPPSource

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

org.ptolemy.ptango.lib.xmpp.XMPPSource

All Implemented Interfaces:

java.lang.Cloneable, org.jivesoftware.smackx.pubsub.listener.ItemEventListener<org.jivesoftware.smackx.pubsub.Item>, XMPPSubscriber, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class XMPPSource
extends TypedAtomicActor
implements XMPPSubscriber

An actor that subscribes to an XMPP XEP-0060 node and fires upon an event. An XMPP node is created by a user, where data can be published and subscribed. An XMPP node has a nodeId, which is set at creation time. This actor refers XMPP node via its nodeId. FIXME: comments, explain XEP-0060

Since:

Ptolemy II 10.0

Version:

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

Author:

Marten Lohstroh

See Also:

XMPPGateway

Accepted Rating:

Red (marten)

Proposed Rating:

Red (marten)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	nodeId XMPPSource subscribes to an XMPP node, the name of which is specified by the value of nodeId.
TypedIOPort	output An output port for values received from the XMPP node.

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
XMPPSource(CompositeEntity container, java.lang.String name) Construct an actor with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) If the argument is the nodeId parameter, then reset the state to the specified value.
java.lang.Object	clone(Workspace workspace) Clone the actor into the specified workspace.
void	fire() Send the current value of the state of this actor to the output.
java.lang.String	getNodeId() Return the nodeId.
java.lang.String	getSubId() Return the id of this subscriber.
void	handlePublishedItems(org.jivesoftware.smackx.pubsub.ItemPublishEvent<org.jivesoftware.smackx.pubsub.Item> items) Parse the published item from the XMPP node, save the XML and request that the actor be fired.
void	initialize() Record the current model time and the current real time so that output events can be time stamped with the elapsed time since model start.
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 id of the subscriber.
void	wrapup() Set _hasInitialized to false, so that invocations of handlePublishedItems (from a different thread) will wait until the model has been initialized on the next execution.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

output

public TypedIOPort output

An output port for values received from the XMPP node.

nodeId

public StringParameter nodeId

XMPPSource subscribes to an XMPP node, the name of which is specified by the value of nodeId. The nodeId is set when the XMPP node is created by a user. The default value is empty string.

Constructor Detail

XMPPSource

public XMPPSource(CompositeEntity container,
                  java.lang.String name)
           throws NameDuplicationException,
                  IllegalActionException

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

If the argument is the nodeId parameter, then reset the state to the specified value.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If nodeId cannot be evaluated or cannot be converted to the output type, or if the superclass throws it.

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the actor into the specified workspace.

Overrides:

clone in class TypedAtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

initialize

public void initialize()
                throws IllegalActionException

Record the current model time and the current real time so that output events can be time stamped with the elapsed time since model start. Declare as synchronized so the handlePublishedItems() method can check if initialize() has been called and, if not, wait for initialize() to be called.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If the superclass throws it.

fire

public void fire()
          throws IllegalActionException

Send the current value of the state of this actor to the output. Synchronized on a lock Object so that each data value will be handled before the next one is accepted, since incoming values call the handlePublishedItems() method from a different thread.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If calling send() or super.fire() throws it.

getNodeId

public java.lang.String getNodeId()

Return the nodeId.

Specified by:

getNodeId in interface XMPPSubscriber

Returns:

the nodeId.

getSubId

public java.lang.String getSubId()

Return the id of this subscriber.

Specified by:

getSubId in interface XMPPSubscriber

Returns:

the id of this subscriber.

See Also:

setSubId(String)

handlePublishedItems

public void handlePublishedItems(org.jivesoftware.smackx.pubsub.ItemPublishEvent<org.jivesoftware.smackx.pubsub.Item> items)

Parse the published item from the XMPP node, save the XML and request that the actor be fired. This method is declared in the smack ItemEventListener interface. This method is called when an item is published. NOTE: This method is synchronized, and the lock is _not_ released until the method is finished processing the current item event. The first item event is completely processed before a second item event can be started.

Specified by:

handlePublishedItems in interface org.jivesoftware.smackx.pubsub.listener.ItemEventListener<org.jivesoftware.smackx.pubsub.Item>

Parameters:

items - The item event from the XMPP node. Can contain multiple pieces of information.

wrapup

public void wrapup()
            throws IllegalActionException

Set _hasInitialized to false, so that invocations of handlePublishedItems (from a different thread) will wait until the model has been initialized on the next execution.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

setGateway

public void setGateway(XMPPGateway gateway)

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

Specified by:

setGateway in interface XMPPSubscriber

Parameters:

gateway - The attribute responsible for managing the XMPP session.

setSubId

public void setSubId(java.lang.String subId)

Set the id of the subscriber.

Specified by:

setSubId in interface XMPPSubscriber

Parameters:

subId - A string identifying this subscriber.

See Also:

getSubId()