ptserver.control

Interface IServerManager

All Known Implementing Classes:

PtolemyServer, ServerManager

public interface IServerManager

Define the control commands that can be administered to the Ptolemy server from its distributed clients. These functions are available through a synchronous, RPC-like servlet that is embedded within the Ptolemy server.

Since:

Ptolemy II 10.0

Version:

$Id: IServerManager.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Justin Killian

Accepted Rating:

Red (jkillian)

Proposed Rating:

Red (jkillian)

Method Summary

Modifier and Type	Method and Description
void	close(Ticket ticket) Shut down the thread associated with the user's ticket.
byte[]	downloadModel(java.lang.String url) Download the selected model to the client.
java.lang.String[]	getLayoutListing(java.lang.String url) Get a listing of the layouts for a specific model available on the server in either the database or the local file system.
java.lang.String[]	getModelListing() Get a listing of the models available on the server in either the database or the local file system.
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getTokenHandlerMap() Get the token handlers loaded on the server so that they can be set up on the client.
ProxyModelResponse	open(java.lang.String modelUrl, java.lang.String layoutUrl) Open a model with the provided model URL and wait for the user to request the execution of the simulation.
void	pause(Ticket ticket) Pause the execution of the selected simulation.
void	resume(Ticket ticket) Resume the execution of the selected simulation.
void	start(Ticket ticket) Start the execution of the selected simulation.
void	stop(Ticket ticket) Stop the execution of the selected simulation.

Method Detail

close

void close(Ticket ticket)
    throws IllegalActionException

Shut down the thread associated with the user's ticket.

Parameters:

ticket - Ticket reference to the simulation request.

Throws:

IllegalActionException - If the server was unable to destroy the simulation thread.

downloadModel

byte[] downloadModel(java.lang.String url)
              throws IllegalActionException

Download the selected model to the client.

Parameters:

url - URL of the model file.

Returns:

Byte array containing the model data.

Throws:

IllegalActionException - If the server encountered an error opening the model file.

getModelListing

java.lang.String[] getModelListing()
                            throws IllegalActionException

Get a listing of the models available on the server in either the database or the local file system.

Returns:

An array of URLs for the models available on the server.

Throws:

IllegalActionException - If there was a problem discovering available models.

getLayoutListing

java.lang.String[] getLayoutListing(java.lang.String url)
                             throws IllegalActionException

Get a listing of the layouts for a specific model available on the server in either the database or the local file system.

Parameters:

url - Address of the model file for which layouts are found.

Returns:

An array of URLs for the layouts available for the model on the server.

Throws:

IllegalActionException - If there was a problem discovering available layouts.

getTokenHandlerMap

java.util.LinkedHashMap<java.lang.String,java.lang.String> getTokenHandlerMap()
                                                                       throws IllegalActionException

Get the token handlers loaded on the server so that they can be set up on the client.

Returns:

The token handler map from the server.

Throws:

IllegalActionException - If the server was unable to get the handler map.

open

ProxyModelResponse open(java.lang.String modelUrl,
                        java.lang.String layoutUrl)
                 throws IllegalActionException

Open a model with the provided model URL and wait for the user to request the execution of the simulation.

Parameters:

modelUrl - The path to the model file

layoutUrl - The path to a model's layout file

Returns:

The user's reference to the simulation task along with specifically formatted for the client model XML and its inferred types

Throws:

IllegalActionException - If the model fails to load from the provided URL.

pause

void pause(Ticket ticket)
    throws IllegalActionException

Pause the execution of the selected simulation.

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

IllegalActionException - If the server was unable to pause the running simulation.

resume

void resume(Ticket ticket)
     throws IllegalActionException

Resume the execution of the selected simulation.

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

IllegalActionException - If the server was unable to resume the execution of the simulation.

start

void start(Ticket ticket)
    throws IllegalActionException

Start the execution of the selected simulation.

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

IllegalActionException - If the server was unable to start the simulation.

stop

void stop(Ticket ticket)
   throws IllegalActionException

Stop the execution of the selected simulation.

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

IllegalActionException - If the server was unable to stop the simulation.