ptserver.actor.lib.io

Class RESTGetHandler

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

ptserver.actor.lib.io.RESTGetHandler

All Implemented Interfaces:

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

public class RESTGetHandler
extends TypedAtomicActor

RESTGetHandler is an actor that takes a model and a RESTful string specifying a model resource as inputs, and prints information about that resource to the destination file in a combination of HTML + Javascript format. In the future - should we separate actions (REST get) from actors? I envision a "RESTHandler" which would take care of web connection settings, and have (at least) four methods (get, post, put, delete) where classes could be registered to support each method dynamically. A default method can be inserted if the operation is not supported (for example, delete).

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Beth Latronico

See Also:

ExportModel

Pt.AcceptedRating:

Red (ltrnc)

Pt.ProposedRating:

Red (ltrnc)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.io.File	_destinationFile The file to write to.
(package private) boolean	_readyToFire A flag indicating if the actor is ready to fire.
FileParameter	destinationFileName The file name to write to.
SharedParameter	ignoreNamedObjsStartingWithUnderscores True if NamedObjs that start with underscores should be ignored.
TypedIOPort	output Output port for the HTML response.
Parameter	outputToFile True if the actor should output to the file specified by destinationFileName.
StringParameter	resource The resource to return.
FileParameter	sourceModel An optional string specifying the file name or URL of the model to read from.

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
RESTGetHandler(CompositeEntity container, java.lang.String name) Create a new actor in the specified container with the specified name.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<NamedObj>	findResources() Find and return all named objects referenced by the resource parameter.
void	fire() Fire this actor.
protected java.lang.String	getHTML() Construct and return the HTML response.
void	initialize() Initialize this actor.
protected java.util.List<java.lang.String>	listContainedResources(NamedObj obj) Return a list of URIs for all contained objects.

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

destinationFileName

public FileParameter destinationFileName

The file name to write to.

See Also:

FileParameter

ignoreNamedObjsStartingWithUnderscores

public SharedParameter ignoreNamedObjsStartingWithUnderscores

True if NamedObjs that start with underscores should be ignored. The default is a boolean with value false, indicating that NamedObjs such as parameters like _vergilSize should be printed out. This parameters is primarily used for testing.

output

public TypedIOPort output

Output port for the HTML response.

outputToFile

public Parameter outputToFile

True if the actor should output to the file specified by destinationFileName. Otherwise, actor sends output to output port.

resource

public StringParameter resource

The resource to return. This can be the whole model, any contained entity, or a set of contained entities. Please see the find() method for a full explanation of the syntax. Some examples: modelName - Returns the top-level entity (the whole model) and a list of resources contained by this entity modelName/x - Returns actor x whose parent is the top-level entity and a list of resources contained by x modelName/x/y - Returns actor y, whose parent is x, whose parent is the top-level entity, and a list of resources contained by y modelName/ontology.name=unitSystem&concept=Temperature - Returns all entities who have a port annotated with the concept "Temperature" from the ontology "unitSystem"

sourceModel

public FileParameter sourceModel

An optional string specifying the file name or URL of the model to read from. If blank, the model containing this actor is used.

See Also:

FileParameter

_destinationFile

java.io.File _destinationFile

The file to write to.

_readyToFire

boolean _readyToFire

A flag indicating if the actor is ready to fire. True if the source model is valid, the destination file is available for writing, and the resource requested is specified in a valid way. These are checked in initialize(). False otherwise.

Constructor Detail

RESTGetHandler

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

Create a new actor in the specified container with the specified name. The name must be unique within the container or an exception is thrown. The container argument must not be null, or a NullPointerException will be thrown.

Parameters:

container - The container.

name - The name of this actor within the container.

Throws:

IllegalActionException - If the entity cannot be contained by the proposed container (see the setContainer() method).

NameDuplicationException - If the name coincides with an entity already in the container.

Method Detail

fire

public void fire()
          throws IllegalActionException

Fire this actor. This will collect information about the given resource and the named objects it contains, and output this information to either the output port or a file depending on the user's choice.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is a problem finding the resource or writing to the file.

initialize

public void initialize()
                throws IllegalActionException

Initialize this actor. Check that the resource name is properly formatted. If an external model is given, check that this model can be found and opened. If an output file is given, check that this file can be found and opened.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If the resource name is improperly formatted, if an external model is given but can't be opened, or if an output file is given but can't be opened.

findResources

protected java.util.List<NamedObj> findResources()
                                          throws IllegalActionException

Find and return all named objects referenced by the resource parameter. Return an empty list if the request contained by the resource request is malformed.

Returns:

A list of all named objects corresponding to the request contained by the resource parameter. Can be empty. Will return an empty list if the request is malformed.

Throws:

IllegalActionException - If the resource is improperly formatted

getHTML

protected java.lang.String getHTML()
                            throws IllegalActionException

Construct and return the HTML response. The HTML response includes information about the selected entity or entities and links to contained entities. If no entities are selected, an empty HTML page is returned. Uses HTML5 syntax.

Returns:

The HTML response.

Throws:

IllegalActionException - If the resource is improperly formatted

See Also:

ExportHTMLAction

listContainedResources

protected java.util.List<java.lang.String> listContainedResources(NamedObj obj)
                                                           throws IllegalActionException

Return a list of URIs for all contained objects. This allows an agent that knows the URI of the main resource (e.g. the top-level model) to discover contained resources (e.g. actors in the model).

If ignoreNamedObjsStartingWithUnderscores is true and the name of the containedObject begins with an underscore, then the name is not added to the list.

Parameters:

obj - The Ptolemy object to list contained resources for.

Returns:

A list of URIs for all contained objects

Throws:

IllegalActionException - If the ignoreNamedObjsStartingWithUnderscores parmeter cannot be read.