simudyne.nexus

Class Server

java.lang.Object

simudyne.nexus.Server

public final class Server
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static boolean	isAutoCompiling() Returns true if auto-compilation has been enabled successfully.
static void	register(java.lang.String name, java.lang.Class<? extends Model> clazz) Register a class implementing the [[simudyne.core.Model]] interface with the server.
static void	register(java.lang.String name, ModelDescriptor config) Register a user-created ModelConfiguration with the server.
static void	run() Runs the webserver.
static void	setAutoCompileRoot(java.lang.String path) Enables auto-compilation of Java files in the specified directory.
static void	setHostname(java.lang.String hostname) Sets the hostname the webserver binds to.
static void	setPort(int port) Sets the port for the webserver.
static void	setWebserverRoot(java.lang.String path) Sets the root directory from which to serve files from the webserver.

Methods inherited from class java.lang.Object

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

Method Detail

register

public static void register(java.lang.String name,
                            ModelDescriptor config)

Register a user-created ModelConfiguration with the server. For the common case of models implementing the [[simudyne.core.Model]] interface, see register(String, java.lang.Class<? extends Model>).

Parameters:

name - User friendly name for the model

config - ModelConfiguration specifying the model and its parameters.

register

public static void register(java.lang.String name,
                            java.lang.Class<? extends Model> clazz)

Register a class implementing the [[simudyne.core.Model]] interface with the server. This creates a default [[simudyne.core.config.POJOConfig]] wrapping the class.

Parameters:

name - User friendly name for the model

clazz - Model class reference

setAutoCompileRoot

public static void setAutoCompileRoot(java.lang.String path)

Enables auto-compilation of Java files in the specified directory. This directory should itself contain one directory per model, and only one class implementing the [[simudyne.core.Model]] interface per subdirectory. Only a single directory may be set for compilation.

Currently only Java models implementing the [[simudyne.core.Model]] interface are supported. Scala support is planned for development.

Note that if you are running from within the SBT build tool, you will need to enable forking of the Compile task for this to work, as otherwise the classpath will not be configured correctly.

Parameters:

path - Path to the root of Java packages to watch and compile.

setWebserverRoot

public static void setWebserverRoot(java.lang.String path)

Sets the root directory from which to serve files from the webserver. This allows custom interfaces to be served from the server. The 'index.html' is served as the default root file, but otherwise there are no specially treated files.

Parameters:

path - Path to the root folder to serve.

setPort

public static void setPort(int port)

Sets the port for the webserver. Defaults to 8080.

Parameters:

port - Port for the webserver to listen on.

setHostname

public static void setHostname(java.lang.String hostname)

Sets the hostname the webserver binds to. Defaults to "127.0.0.1", which means the webserver can only be accessed from the same machine it is running on. If you wish to listen to all hostnames, exposing the server to the network, then set the hostname to "0.0.0.0".

Parameters:

hostname - Hostname for the webserver to bind to.

isAutoCompiling

public static boolean isAutoCompiling()

Returns true if auto-compilation has been enabled successfully.

run

public static void run()

Runs the webserver.

If there is no terminal connected, this will block and run until the process is terminated.

If a terminal is connected, it will listen to standard-input and exit once it receives the 'exit' string.