org.sdm.spa

Class MessageBasedWebService

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.sdm.spa.MessageBasedWebService

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Deprecated.

Use org.sdm.spa.WebService or org.sdm.spa.WSWithComplexTypes instead.

public class MessageBasedWebService
extends TypedAtomicActor

The MessageWebService actor, provides the user with a plug-in interface to execute any WSDL-defined web service. Given a URL for the WSDL of a web service and an operation name that is included in the WSDL, this actor customizes itself to execute this web service operation.

WSDL is an XML format for describing network services as a set of endpoints operating on messages containing either document-oriented or procedure- oriented information. The operations and messages are described abstractly, and then bound to a concrete network protocol and message format to define an endpoint. Related concrete endpoints are combined into abstract endpoints (services). WSDL is extensible to allow description of endpoints and their messages regardless of what message formats or network protocols are used to communicate. More information on WSDL and realted standard can be found at: http://www.w3.org/TR/wsdl

The user can instantiate the generic web service actor by providing the WSDL URL and choosing the desired web service operation. The actor then a utomatically specializes itself and adds ports with the inputs and outputs as described by the WSDL. The so instantiated actor acts as a proxy for the web service being executed and links to the other actors through its ports.

The WSDL is parsed to get the input, output and binding information. It dynamically generates ports for each input and output of the operation. This customization happens at the configuration time of a model. When the actor is fired at run time, it gets the binding information and creates a call object to run the model. Using this call object, it invokes the web service and broadcasts the response to the output ports. The above MessageBasedWebService actor expects XMLTokens as input and broadcasts XMLTokens as well.

Notices to users:

• Please double-click on the actor to start customization.
• To enter a WSDL URL which is not in the given list of WSDL URLs, click on the "Preferences" button on the configuration interface and change the type of the parameter to "Text". Then you can type in the WSDL you would like to use.
• After you select the WSDL, "Commit" and double-click on the actor again. This will reconfigure the list of available operations. Please do this everytime you change the WSDL URL.

Author:

Ilkay Altintas, Nandita Mangal

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
TypedIOPort	clientExecErrors Deprecated. It outputs the errors if any occured when actor is executing.
Parameter	hasTrigger Deprecated. This is an parameter to activate the optional startTrigger port.
SingletonParameter	hide Deprecated.
StringParameter	methodName Deprecated. The parameter for the method name.
StringParameter	password Deprecated. The password to invoke the web service if necessary.
TypedIOPort	startTrigger Deprecated. This is an optional input port that can be used to help the scheduling of the actor.
StringParameter	userName Deprecated. The userName to invoke the web service if necessary.
StringParameter	wsdlUrl Deprecated. The parameter for the URL of the web service WSDL.

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
MessageBasedWebService(CompositeEntity container, java.lang.String name) Deprecated. Construct a WebService actor with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute at) Deprecated. Callback for changes in attribute values Get the WSDL from the given URL.
void	configureActor() Deprecated. Configure the actor for the entered operation of the given web service.
void	configureOperationNames() Deprecated. Configure the actor for the entered operation of the given web service.
void	createPorts(org.apache.axis.wsdl.symbolTable.Parameters params) Deprecated. Creates ports for the web service operation
void	deletePorts() Deprecated. Deletes all the ports of this actor.
void	fire() Deprecated. Get the URL address of the the location of the web service defined by the given WSDL.
void	getServiceBinding() Deprecated. Configure the service, port and binding info.
boolean	prefire() Deprecated. Pre fire the actor.

Methods inherited from class ptolemy.actor.TypedAtomicActor

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

Methods inherited from class ptolemy.actor.AtomicActor

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

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, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

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

wsdlUrl

public StringParameter wsdlUrl

Deprecated.

The parameter for the URL of the web service WSDL.

methodName

public StringParameter methodName

Deprecated.

The parameter for the method name.

userName

public StringParameter userName

Deprecated.

The userName to invoke the web service if necessary.

password

public StringParameter password

Deprecated.

The password to invoke the web service if necessary.

hasTrigger

public Parameter hasTrigger

Deprecated.

This is an parameter to activate the optional startTrigger port. Please activate it ONLY when the actor has no input and it is required for scheduling of the actor.

startTrigger

public TypedIOPort startTrigger

Deprecated.

This is an optional input port that can be used to help the scheduling of the actor.

This port is activated by the hasTrigger parameter. Double-click on the actor to enable. Please enable it ONLY when the actor has no input and it is required for scheduling of the actor.

clientExecErrors

public TypedIOPort clientExecErrors

Deprecated.

It outputs the errors if any occured when actor is executing. It outputs "NO ERRORS." if there are no exceptional cases.

hide

public SingletonParameter hide

Deprecated.

Constructor Detail

MessageBasedWebService

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

Deprecated.

Construct a WebService 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 actor with this name.

Method Detail

attributeChanged

public void attributeChanged(Attribute at)
                      throws IllegalActionException

Deprecated.

Callback for changes in attribute values Get the WSDL from the given URL.

Overrides:

attributeChanged in class NamedObj

Parameters:

at - The attribute that changed.

Throws:

IllegalActionException

configureOperationNames

public void configureOperationNames()

Deprecated.

Configure the actor for the entered operation of the given web service.

configureActor

public void configureActor()

Deprecated.

Configure the actor for the entered operation of the given web service.

createPorts

public void createPorts(org.apache.axis.wsdl.symbolTable.Parameters params)

Deprecated.

Creates ports for the web service operation

deletePorts

public void deletePorts()

Deprecated.

Deletes all the ports of this actor.

fire

public void fire()
          throws IllegalActionException

Deprecated.

Get the URL address of the the location of the web service defined by the given WSDL. Get the the namespace and binding information ofthe web service using the given WSDL and methodName. Add a parameterto the call object for each input part.Fill these parameters with the input values on channels on the ports that correspond to them. Invoke the web service using all the gathered information. Send the response of the call to the result port.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is no director.

getServiceBinding

public void getServiceBinding()

Deprecated.

Configure the service, port and binding info.

prefire

public boolean prefire()
                throws IllegalActionException

Deprecated.

Pre fire the actor. Calls the super class's prefire in case something is set there.

Specified by:

prefire in interface Executable

Overrides:

prefire in class AtomicActor<TypedIOPort>

Returns:

True if this actor is ready for firing, false otherwise.

Throws:

IllegalActionException - Not thrown in this base class.