org.ptolemy.ptango.lib.xmpp

Class XMPPGateway

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.actor.AbstractInitializableAttribute

org.ptolemy.ptango.lib.xmpp.XMPPGateway

All Implemented Interfaces:

java.lang.Cloneable, Executable, Initializable, Changeable, Debuggable, DebugListener, Derivable, HierarchyListener, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class XMPPGateway
extends AbstractInitializableAttribute
implements Executable

This attribute sets up and maintains a connection to a XMPP server. It keeps track of actors within the model that implement the XMPPSubscriber or XMPPPublisher interface and relays messages between those actors and the XMPP server. The Executable interface is implemented merely to make sure that the connection maintained to the server is alive every iteration, before any firings occur in which actors may attempt to publish something by invoking the XMPP.publish() method. This implementation makes use of the Smack library.

Since:

Ptolemy II 10.0

Version:

$Id: XMPPGateway.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Marten Lohstroh and Ben Zhang

See Also:

XMPPSource, XMPPSink, Executable

Accepted Rating:

Red (marten)

Proposed Rating:

Red (marten)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
Parameter	debugEnable The flag indicates whether or not to enable the smack library debug If this is true, the raw XML stream will be shown for debug use.
FileParameter	passwordFile The file that contains the password.
Parameter	port Port number to connect to.
Parameter	server Server to connect to.
Parameter	userName User name to authenticate with.

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
XMPPGateway(NamedObj container, java.lang.String name) Construct an instance of the XMPPGateway attribute.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) Update the local variable associated with the changed attribute and disconnect from the server.
void	fire() Return immediately.
void	initialize() Attempt to connect to the server and login.
boolean	isFireFunctional() Return false.
boolean	isStrict() Return true.
int	iterate(int count) Return immediately.
boolean	postfire() Return immediately.
boolean	prefire() Check the connection, reconnect and login if required.
void	publish(java.lang.String nodeId, java.lang.String value) Publish a value to a node.
void	removeNode(java.lang.String nodeId) Remove a node from the server configuration.
void	stop() Return immediately.
void	stopFire() Return immediately.
void	terminate() Return immediately.
void	wrapup() Disconnect from the server.

Methods inherited from class ptolemy.actor.AbstractInitializableAttribute

_getInitializableContainer, addInitializable, clone, hierarchyChanged, hierarchyWillChange, preinitialize, removeInitializable, setContainer

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

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

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

Field Detail

passwordFile

public FileParameter passwordFile

The file that contains the password. If this parameter is non-empty, then it is assumed to refer to a file that contains the password. If this parameter is empty, or names a file that cannot be read, then a dialog is displayed for the user to enter the password. It is up to the user to properly protect the file from unauthorized readers by using the file system permissions. The default value is the empty string, meaning that the dialog will be displayed.

port

public Parameter port

Port number to connect to. This is a integer that defaults to 5222.

server

public Parameter server

Server to connect to. This is a string that defaults to "localhost".

userName

public Parameter userName

User name to authenticate with. This is a string that defaults to "guest".

debugEnable

public Parameter debugEnable

The flag indicates whether or not to enable the smack library debug If this is true, the raw XML stream will be shown for debug use. defaults to BooleanToken false

Constructor Detail

XMPPGateway

public XMPPGateway(NamedObj container,
                   java.lang.String name)
            throws IllegalActionException,
                   NameDuplicationException

Construct an instance of the XMPPGateway attribute.

Parameters:

container - The container.

name - The name.

Throws:

IllegalActionException - If the superclass throws it.

NameDuplicationException - If the superclass throws it.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Update the local variable associated with the changed attribute and disconnect from the server.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The changed attribute.

Throws:

IllegalActionException - If thrown while getting the value of the port, server or userName token, or if thrown by the method in the super class.

fire

public void fire()
          throws IllegalActionException

Return immediately.

Specified by:

fire in interface Executable

Throws:

IllegalActionException - If firing is not permitted.

initialize

public void initialize()
                throws IllegalActionException

Attempt to connect to the server and login. Discover subscribers and them as listeners. If a subscriber wants to subscribe to a non-existent node, create it. discover publishers and give them a reference to this attribute. This might change in the future, as changes to running models require actors to register themselves instead of being discovered.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractInitializableAttribute

Throws:

IllegalActionException - If unable to login, create a node, find a node, or subscribe to a node.

isFireFunctional

public boolean isFireFunctional()

Return false.

Specified by:

isFireFunctional in interface Executable

Returns:

True if this executable only updates its states during an iteration in the postfire() method.

isStrict

public boolean isStrict()
                 throws IllegalActionException

Return true.

Specified by:

isStrict in interface Executable

Returns:

True if this executable is strict, meaning all inputs must be known before iteration.

Throws:

IllegalActionException - Thrown by subclass.

iterate

public int iterate(int count)
            throws IllegalActionException

Return immediately.

Specified by:

iterate in interface Executable

Parameters:

count - The number of iterations to perform.

Returns:

NOT_READY, STOP_ITERATING, or COMPLETED.

Throws:

IllegalActionException - If iterating is not permitted, or if prefire(), fire(), or postfire() throw it.

prefire

public boolean prefire()
                throws IllegalActionException

Check the connection, reconnect and login if required.

Specified by:

prefire in interface Executable

Returns:

True if the iteration can proceed.

Throws:

IllegalActionException - If prefiring is not permitted.

postfire

public boolean postfire()
                 throws IllegalActionException

Return immediately.

Specified by:

postfire in interface Executable

Returns:

True if the execution can continue.

Throws:

IllegalActionException - If postfiring is not permitted.

publish

public void publish(java.lang.String nodeId,
                    java.lang.String value)
             throws IllegalActionException

Publish a value to a node. The value is wrapped into a message stanza.

Parameters:

nodeId - The node to publish to.

value - The value to publish.

Throws:

IllegalActionException - If publishing failed.

removeNode

public void removeNode(java.lang.String nodeId)
                throws IllegalActionException

Remove a node from the server configuration.

Parameters:

nodeId - The node to remove.

Throws:

IllegalActionException - If unable to remove the node.

stop

public void stop()

Return immediately.

Specified by:

stop in interface Executable

stopFire

public void stopFire()

Return immediately.

Specified by:

stopFire in interface Executable

terminate

public void terminate()

Return immediately.

Specified by:

terminate in interface Executable

wrapup

public void wrapup()
            throws IllegalActionException

Disconnect from the server.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AbstractInitializableAttribute

Throws:

IllegalActionException - If thrown in the base class.