magpie.user.server

Class ServerLauncher

java.lang.Object

magpie.user.server.ServerLauncher

public class ServerLauncher
extends java.lang.Object

Main class for launching a Magpie server.

How to start server

ServerLauncher can be started simply by starting Magpie with the "-server" flag. Invoked in this why, Magpie takes a few command line arguments:
-port <port>: Port on which to launch server. Socket server (e.g., what you would use with Python client) starts on this server, HTTP server will start on port + 1.
-models <path>: Path to file describing models to be served. This file should be formatted in YAML and follow the following structure:

This YAML file should be partitioned into several separate documents, which each describe a different model and are separated by lines of '---'.

Each document should contain the following fields:

• name Name for this model
• modelPath Path to the model file
• datasetPath Path to the dataset
• description Short description of model
• property Name of property being modeled, or a short description
• units (Optional) Units for the property
• training Short description of the training set
• citation Citation for the model
• author Name of author of the model
• notes Longer description of the model
• maxEntries Maximum number of entries that can be run by a single query

Feel free to use HTML formatting in the YAML file. This information will likely be rendered by a web browser

-maxEntries <path>Maximum number of entries that this server will run for a single request

Client Implementation Guide

This code uses a REST interface. Eventually, we may provide a wrapper for this API in other languages. There are a few example webpages using this interface in the Magpie repository.

To do list:

1. Allow the dataset used to parse entries be different than that used to run it (e.g., parse crystal structure, run based on composition)
2. Create a class that stores datasets, and can use them in seraches / send them to users

Field Summary

Fields

Modifier and Type	Field and Description
static int	ListenPort Port on which to listen
static int	MaxNumEntries Maximum mumber of entries to run
static java.util.Map<java.lang.String,ModelPackage>	Models List of models available to this program
static org.glassfish.grizzly.http.server.HttpServer	Server Server currently being used
static java.util.Date	StartDate Time server was launched
static int	ThreadCount Number of allowed threads
static java.util.concurrent.ExecutorService	ThreadPool Executor used to prevent too many complex calculations at once.

Constructor Summary

Constructors

Constructor and Description
ServerLauncher()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args)
static void	parseInput(java.lang.String[] args) Handle input passed to the server.
static void	readInformationFile(java.lang.String path) Given model information file, configure the handler
static void	startServer() Given the current settings, start the Magpie server

Methods inherited from class java.lang.Object

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

Field Detail

ListenPort

public static int ListenPort

Port on which to listen

Models

public static java.util.Map<java.lang.String,ModelPackage> Models

List of models available to this program

Server

public static org.glassfish.grizzly.http.server.HttpServer Server

Server currently being used

StartDate

public static java.util.Date StartDate

Time server was launched

ThreadPool

public static java.util.concurrent.ExecutorService ThreadPool

Executor used to prevent too many complex calculations at once.

ThreadCount

public static int ThreadCount

Number of allowed threads

MaxNumEntries

public static int MaxNumEntries

Maximum mumber of entries to run

Constructor Detail

ServerLauncher

public ServerLauncher()

Method Detail

parseInput

public static void parseInput(java.lang.String[] args)
                       throws java.lang.Exception

Handle input passed to the server. See class documentation for format

Parameters:

args - Input

Throws:

java.lang.Exception

readInformationFile

public static void readInformationFile(java.lang.String path)
                                throws java.lang.Exception

Given model information file, configure the handler

Parameters:

path - Path to model information file

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Parameters:

args - the command line arguments

Throws:

java.lang.Exception

startServer

public static void startServer()
                        throws java.lang.Exception

Given the current settings, start the Magpie server

Throws:

java.lang.Exception