ptserver.control

Class ServerManager

java.lang.Object

javax.servlet.GenericServlet

com.caucho.hessian.server.HessianServlet

ptserver.control.ServerManager

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, IServerManager

public class ServerManager
extends com.caucho.hessian.server.HessianServlet
implements IServerManager

Acts as a facade to the Ptolemy server application and administers control commands coming through the servlet.

Since:

Ptolemy II 10.0

Version:

$Id: ServerManager.java 69607 2014-07-30 17:07:26Z cxh $

Author:

Justin Killian

See Also:

Serialized Form

Accepted Rating:

Red (jkillian)

Proposed Rating:

Red (jkillian)

Constructor Summary

Constructors

Constructor and Description
ServerManager()

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.

Methods inherited from class com.caucho.hessian.server.HessianServlet

createHessian2Input, getAPIClass, getContextClassLoader, getSerializerFactory, getServletInfo, init, invoke, service, setAPIClass, setDebug, setHome, setHomeAPI, setLogName, setObject, setObjectAPI, setSendCollectionType, setSerializerFactory, setService

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerManager

public ServerManager()

Method Detail

close

public void close(Ticket ticket)
           throws IllegalActionException

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

Specified by:

close in interface IServerManager

Parameters:

ticket - Ticket reference to the simulation request.

Throws:

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

downloadModel

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

Download the selected model to the client.

Specified by:

downloadModel in interface IServerManager

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

public 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.

Specified by:

getModelListing in interface IServerManager

Returns:

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

Throws:

IllegalActionException - If there was a problem discovering available models.

getLayoutListing

public 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.

Specified by:

getLayoutListing in interface IServerManager

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

public 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.

Specified by:

getTokenHandlerMap in interface IServerManager

Returns:

The token handler map from the server.

Throws:

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

open

public 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.

Specified by:

open in interface IServerManager

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

public void pause(Ticket ticket)
           throws IllegalActionException

Pause the execution of the selected simulation.

Specified by:

pause in interface IServerManager

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

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

resume

public void resume(Ticket ticket)
            throws IllegalActionException

Resume the execution of the selected simulation.

Specified by:

resume in interface IServerManager

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

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

start

public void start(Ticket ticket)
           throws IllegalActionException

Start the execution of the selected simulation.

Specified by:

start in interface IServerManager

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

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

stop

public void stop(Ticket ticket)
          throws IllegalActionException

Stop the execution of the selected simulation.

Specified by:

stop in interface IServerManager

Parameters:

ticket - The ticket reference to the simulation request.

Throws:

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