org.camera.service

Class CAMERARESTService

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.camera.service.CAMERARESTService

All Implemented Interfaces:

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

public class CAMERARESTService
extends TypedAtomicActor

This CAMERA specific REST Service automatically generates the ports and parameters upon reading the URL of the csdl file. Choices are available for both Get and Post Services.

Author:

Madhu, SDSC madhu@sdsc.edu

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
CompositeEntity	con
Parameter	methodType The REST service method to use, either GET or POST.
java.util.List	oPortList old port list.
TypedIOPort	outputPort Output of REST service.
StringParameter	paramF URL of the csdl file
PortParameter	serviceSiteURL The REST service URL.
static int	TIMEOUT

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
CAMERARESTService(CompositeEntity container, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute at) React to a change in an attribute.
boolean	checkIfPortNameExists(java.lang.String value) This method checks if the port with the provided name exists or not.
void	configureActorConstant(java.lang.String name, java.lang.String value, double[] pos) Currently, this method is not used.
void	configureActorParameter(java.lang.String value, java.lang.String appender, java.lang.String description, java.lang.String valueType, double[] pos) This method creates Parameters with name as value and data type it represents as valueType.
void	configureActorPort(java.lang.String value, java.lang.String description, java.lang.String valueType) It dynamically creates port with name as value and display name as description and port type is set as valueType.
java.lang.String	executeGetMethod(java.util.List<NameValuePair> nvPairList, java.lang.String serSiteURL)
java.lang.String	executePostMethod(java.util.List<NameValuePair> pmPairList, java.util.List<NameValuePair> flPairList, java.lang.String serSiteURL) File & regular parameters are passed as two separate lists and they are treated little differently.
void	fire() Do nothing.
void	remAttributes(java.lang.String resName) Parameters whose names start with resName are removed by this method.
void	removeMyPorts() Removes port that were in the old list but not used currently
void	removePorts() This method removes all input ports

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, prefire, 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, prefire, 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

paramF

public StringParameter paramF

URL of the csdl file

serviceSiteURL

public PortParameter serviceSiteURL

The REST service URL.

oPortList

public java.util.List oPortList

old port list.

methodType

public Parameter methodType

The REST service method to use, either GET or POST.

outputPort

public TypedIOPort outputPort

Output of REST service.

TIMEOUT

public static final int TIMEOUT

See Also:

Constant Field Values

con

public CompositeEntity con

Constructor Detail

CAMERARESTService

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

Throws:

NameDuplicationException

IllegalActionException

Method Detail

fire

public void fire()
          throws IllegalActionException

Description copied from class: AtomicActor

Do nothing. Derived classes override this method to define their primary run-time action.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

attributeChanged

public void attributeChanged(Attribute at)
                      throws IllegalActionException

Description copied from class: NamedObj

React to a change in an attribute. This method is called by a contained attribute when its value changes. In this base class, the method does nothing. In derived classes, this method may throw an exception, indicating that the new attribute value is invalid. It is up to the caller to restore the attribute to a valid value if an exception is thrown.

Overrides:

attributeChanged in class NamedObj

Parameters:

at - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

checkIfPortNameExists

public boolean checkIfPortNameExists(java.lang.String value)

This method checks if the port with the provided name exists or not.

Parameters:

value - Port name

Returns:

true if port with the provided name exists else return false

removeMyPorts

public void removeMyPorts()
                   throws NameDuplicationException,
                          IllegalActionException

Removes port that were in the old list but not used currently

Throws:

NameDuplicationException

IllegalActionException

removePorts

public void removePorts()
                 throws NameDuplicationException,
                        IllegalActionException

This method removes all input ports

Throws:

NameDuplicationException

IllegalActionException

configureActorParameter

public void configureActorParameter(java.lang.String value,
                                    java.lang.String appender,
                                    java.lang.String description,
                                    java.lang.String valueType,
                                    double[] pos)
                             throws IllegalActionException

This method creates Parameters with name as value and data type it represents as valueType. The location of the parameter depends upon pos.

Parameters:

value -

valueType -

pos -

Throws:

IllegalActionException

NameDuplicationException

configureActorConstant

public void configureActorConstant(java.lang.String name,
                                   java.lang.String value,
                                   double[] pos)
                            throws IllegalActionException,
                                   NameDuplicationException

Currently, this method is not used.

Parameters:

name -

value -

pos -

Throws:

IllegalActionException

NameDuplicationException

configureActorPort

public void configureActorPort(java.lang.String value,
                               java.lang.String description,
                               java.lang.String valueType)
                        throws IllegalActionException,
                               NameDuplicationException

It dynamically creates port with name as value and display name as description and port type is set as valueType.

Parameters:

value -

description -

valueType -

Throws:

IllegalActionException

NameDuplicationException

remAttributes

public void remAttributes(java.lang.String resName)
                   throws IllegalActionException,
                          NameDuplicationException

Parameters whose names start with resName are removed by this method.

Parameters:

resName -

Throws:

IllegalActionException

NameDuplicationException

executePostMethod

public java.lang.String executePostMethod(java.util.List<NameValuePair> pmPairList,
                                          java.util.List<NameValuePair> flPairList,
                                          java.lang.String serSiteURL)
                                   throws IllegalActionException

File & regular parameters are passed as two separate lists and they are treated little differently. If flPairList is not null or empty then this method uses Part Object else no.

Parameters:

pmPairList - List of the name and value parameters that user has provided

flPairList - List of the name and value (full file path)of file parameters. It is essentially a list of files that user wishes to attach.

Returns:

the results after executing the Post service.

Throws:

IllegalActionException

executeGetMethod

public java.lang.String executeGetMethod(java.util.List<NameValuePair> nvPairList,
                                         java.lang.String serSiteURL)
                                  throws IllegalActionException

Parameters:

pmPairList - List of the name and value parameters that user has provided through paramInputPort. However in method this list is combined with the user configured ports and the combined list name value pair parameters are added to the service URL separated by ampersand.

nvPairList - List of the name and value parameters that user has provided

Returns:

the results after executing the Get service.

Throws:

IllegalActionException