edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerRESTEasy

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.SoftwareServerRESTEasy

All Implemented Interfaces:

SoftwareServerRESTEasyInterface

public class SoftwareServerRESTEasy
extends Object
implements SoftwareServerRESTEasyInterface

A restful interface for a software server. Think of this as an extended software server.

Author:

Edgar Black

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.jboss.resteasy.plugins.server.tjws.TJWSEmbeddedJaxrsServer	tjws

Constructor Summary

Constructors

Constructor and Description
SoftwareServerRESTEasy() Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	alive() Used to verify if the server is responding
javax.ws.rs.core.Response	appIcons(String fileName) Returns the requested icon file if available.
javax.ws.rs.core.Response	busy() Used to verify if the server is busy
javax.ws.rs.core.Response	completedTasks() Used to know the number of task completed since the server starts
static String	createHTMLList(String list, String link, boolean APPEND, String title) Convert a line separated list into an HTML list of links.
void	executeTask(int session, String application_alias, String task_string, String file, String format, String url) Execute a task.
void	executeTaskLater(int session, String application_alias, String task_string, String file, String format, String uri) Execute a task asynchronously.
javax.ws.rs.core.Response	fileOrDir(javax.ws.rs.core.UriInfo uri, String fileOrDirName) Returns a link to either a produced file or to a directory tree
javax.ws.rs.core.Response	form() Returns a list of actions that can be performed (get or post or convert)
javax.ws.rs.core.Response	formPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input, String mediaType, String accept, javax.ws.rs.core.UriInfo uri, String application, String task, String format, String file) Process a file submitted via the web form and return a link to the produced file
String	getApplications() Get the applications available.
String	getApplicationStack() Get an icon representation of the available software.
String	getApplicationTaskInputs(String alias, String task) Get the input formats supported by the given task.
String	getApplicationTaskInputsOutputs(String alias, String task) Get the input and output formats supported by the given task.
String	getApplicationTaskOutputs(String alias, String task) Get the output formats supported by the given task.
String	getApplicationTasks(String alias) Get the tasks available for the given application.
String	getConvertForm() Get a web form interface for converting via this restful service.
String	getForm() Get a web form interface for this restful service.
String	getForm(boolean POST_UPLOADS, String selected_application, boolean HIDE_APPLICATIONS) Get a web form interface for this restful service.
Vector<SoftwareServerAuxiliary.Subtask>	getTask(String application_alias, String task_string, String filename, String output_format) Get the task involved in using the given applications to convert the given file to the specified output format.
javax.ws.rs.core.Response	kills() Used to know the number of task killed since the server starts
javax.ws.rs.core.Response	listApplications(javax.ws.rs.core.UriInfo uriInfo, String Accept) Returns a list of applications available in software server
javax.ws.rs.core.Response	listInputAndOutputFormats(String app, String tsk) Returns a list of input and output file formats accepted and produced by the application
javax.ws.rs.core.Response	listInputFormats(javax.ws.rs.core.UriInfo uriInfo, String Accept, String app, String tsk) Returns a list of input file formats accepted by the application
javax.ws.rs.core.Response	listOutputFile(javax.ws.rs.core.UriInfo uriInfo, String Accept, String app, String tsk, String fmt, String file) Returns a link to the produced file
javax.ws.rs.core.Response	listOutputFmts(javax.ws.rs.core.UriInfo uriInfo, String Accept, String app, String tsk) Return a list of the file formats produced by the application
javax.ws.rs.core.Response	listTasks(javax.ws.rs.core.UriInfo uriInfo, String Accept, String app) Returns a list of tasks performed by a particular application
javax.ws.rs.core.Response	load() Used to get a measure of the server load
static void	main(String[] args) Used to initialize and start the servlet server called the Tiny Java Web Server and Servlet (TJWS) Container.
javax.ws.rs.core.Response	memory() Used to know the memory available to the server
javax.ws.rs.core.Response	printErrorMessage(String msg) Returns an error message
javax.ws.rs.core.Response	processGet(javax.ws.rs.core.UriInfo uri, String application, String task, String format, String file, String action) Returns a link to the produced file
javax.ws.rs.core.Response	processors() Used to know the number of processor available to the server
javax.ws.rs.core.Response	processPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input, String mediaType, String accept, javax.ws.rs.core.UriInfo uri, String application, String task, String format, String file, boolean formPost) This is an auxiliary method working for the formPost() and the taskPost() methods.
static String	queryEndpoint(String url) Query an endpoint.
javax.ws.rs.core.Response	reboot() Used to reboot the server remotely in case it is necessary
static String	removeParameters(String url) Remove parameters from a URL.
javax.ws.rs.core.Response	reset() Used to reset the server remotely in case it is necessary
javax.ws.rs.core.Response	screen() Used to have a look at the server screen and determine if the server must be restarted due to hang application.
static void	stop() Used to stop the servlet server
javax.ws.rs.core.Response	taskPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input, String mediaType, String accept, javax.ws.rs.core.UriInfo uri, String application, String task, String format) Process a file submitted to the Software Server and return a link to the produced file
javax.ws.rs.core.Response	tasks() Used to know the number of task processed since the server starts
javax.ws.rs.core.Response	WelcomeToSoftwareServer() Returns SoftwareServer greetings

Methods inherited from class java.lang.Object

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

Field Detail

tjws

protected static org.jboss.resteasy.plugins.server.tjws.TJWSEmbeddedJaxrsServer tjws

Constructor Detail

SoftwareServerRESTEasy

public SoftwareServerRESTEasy()

Class constructor.

Method Detail

WelcomeToSoftwareServer

public javax.ws.rs.core.Response WelcomeToSoftwareServer()

Returns SoftwareServer greetings

Specified by:

WelcomeToSoftwareServer in interface SoftwareServerRESTEasyInterface

Returns:

SoftwareServer greetings

listApplications

public javax.ws.rs.core.Response listApplications(javax.ws.rs.core.UriInfo uriInfo,
                                         String Accept)

Returns a list of applications available in software server

Specified by:

listApplications in interface SoftwareServerRESTEasyInterface

Parameters:

uriInfo - Basic URL information

Accept - content type accepted by client

Returns:

list of applications available in software server

listTasks

public javax.ws.rs.core.Response listTasks(javax.ws.rs.core.UriInfo uriInfo,
                                  String Accept,
                                  String app)

Returns a list of tasks performed by a particular application

Specified by:

listTasks in interface SoftwareServerRESTEasyInterface

Parameters:

uriInfo - Basic URL information

Accept - content type accepted by client

app - application's name

Returns:

list of tasks performed by a particular application

listOutputFmts

public javax.ws.rs.core.Response listOutputFmts(javax.ws.rs.core.UriInfo uriInfo,
                                       String Accept,
                                       String app,
                                       String tsk)

Return a list of the file formats produced by the application

Specified by:

listOutputFmts in interface SoftwareServerRESTEasyInterface

Parameters:

uriInfo: - Basic URL information

Accept - content type accepted by client

app - application's name

tsk - task to be performed

Returns:

list of the file formats produced by the application

listInputAndOutputFormats

public javax.ws.rs.core.Response listInputAndOutputFormats(String app,
                                                  String tsk)

Returns a list of input and output file formats accepted and produced by the application

Specified by:

listInputAndOutputFormats in interface SoftwareServerRESTEasyInterface

Parameters:

app - application's name

tsk - task to be performed

Returns:

list of input and output file formats accepted and produced by the application

listInputFormats

public javax.ws.rs.core.Response listInputFormats(javax.ws.rs.core.UriInfo uriInfo,
                                         String Accept,
                                         String app,
                                         String tsk)

Returns a list of input file formats accepted by the application

Specified by:

listInputFormats in interface SoftwareServerRESTEasyInterface

Parameters:

uriInfo - Basic URL information

Accept - content type accepted by client

app - application's name

tsk - task to be performed

Returns:

list of input file formats accepted by the application

listOutputFile

public javax.ws.rs.core.Response listOutputFile(javax.ws.rs.core.UriInfo uriInfo,
                                       String Accept,
                                       String app,
                                       String tsk,
                                       String fmt,
                                       String file)

Returns a link to the produced file

Specified by:

listOutputFile in interface SoftwareServerRESTEasyInterface

Parameters:

uriInfo - Basic URL information

produces - content type accepted by client

app - application's name

tsk - task to be performed

fmt - requested output format

file - input file to be processed

Returns:

link to the produced file

form

public javax.ws.rs.core.Response form()

Returns a list of actions that can be performed (get or post or convert)

Specified by:

form in interface SoftwareServerRESTEasyInterface

Returns:

list of actions that can be performed

processGet

public javax.ws.rs.core.Response processGet(javax.ws.rs.core.UriInfo uri,
                                   String application,
                                   String task,
                                   String format,
                                   String file,
                                   String action)

Returns a link to the produced file

Specified by:

processGet in interface SoftwareServerRESTEasyInterface

Parameters:

uri - Basic URL information

application - application's name

task - task to be performed

format - requested output format

file - input file to be processed

action - (get or post or convert)

Returns:

a link to the produced file

fileOrDir

public javax.ws.rs.core.Response fileOrDir(javax.ws.rs.core.UriInfo uri,
                                  String fileOrDirName)
                                    throws IOException

Returns a link to either a produced file or to a directory tree

Specified by:

fileOrDir in interface SoftwareServerRESTEasyInterface

Parameters:

uri - Basic URL information

fileOrDirName - input file or directory

Returns:

a link to either a produced file or to a directory tree

Throws:

IOException

appIcons

public javax.ws.rs.core.Response appIcons(String fileName)

Returns the requested icon file if available. If not, a default icon file is return instead.

Specified by:

appIcons in interface SoftwareServerRESTEasyInterface

Parameters:

fileName - file name of icon

Returns:

the requested icon file if available, default icon icon if not

alive

public javax.ws.rs.core.Response alive()

Used to verify if the server is responding

Specified by:

alive in interface SoftwareServerRESTEasyInterface

Returns:

yes if the server is alive

busy

public javax.ws.rs.core.Response busy()

Used to verify if the server is busy

Specified by:

busy in interface SoftwareServerRESTEasyInterface

Returns:

true if the server is processing at least one request, false if not.

processors

public javax.ws.rs.core.Response processors()

Used to know the number of processor available to the server

Specified by:

processors in interface SoftwareServerRESTEasyInterface

Returns:

number of processors available to the server

memory

public javax.ws.rs.core.Response memory()

Used to know the memory available to the server

Specified by:

memory in interface SoftwareServerRESTEasyInterface

Returns:

memory available to the server (is this right????)

load

public javax.ws.rs.core.Response load()

Used to get a measure of the server load

Specified by:

load in interface SoftwareServerRESTEasyInterface

Returns:

measure of the server load

tasks

public javax.ws.rs.core.Response tasks()

Used to know the number of task processed since the server starts

Specified by:

tasks in interface SoftwareServerRESTEasyInterface

Returns:

number of task since the server starts

kills

public javax.ws.rs.core.Response kills()

Used to know the number of task killed since the server starts

Specified by:

kills in interface SoftwareServerRESTEasyInterface

Returns:

number of task killed since the server starts

completedTasks

public javax.ws.rs.core.Response completedTasks()

Used to know the number of task completed since the server starts

Specified by:

completedTasks in interface SoftwareServerRESTEasyInterface

Returns:

number of task completed since the server starts

screen

public javax.ws.rs.core.Response screen()

Used to have a look at the server screen and determine if the server must be restarted due to hang application.

Specified by:

screen in interface SoftwareServerRESTEasyInterface

Returns:

number an image of the server screen (only authorized users)

reset

public javax.ws.rs.core.Response reset()

Used to reset the server remotely in case it is necessary

Specified by:

reset in interface SoftwareServerRESTEasyInterface

Returns:

ok after reseting the server. (only authorized users)

reboot

public javax.ws.rs.core.Response reboot()

Used to reboot the server remotely in case it is necessary

Specified by:

reboot in interface SoftwareServerRESTEasyInterface

Returns:

ok after rebooting the server. (only authorized users)

printErrorMessage

public javax.ws.rs.core.Response printErrorMessage(String msg)

Returns an error message

Specified by:

printErrorMessage in interface SoftwareServerRESTEasyInterface

Parameters:

msg - String to be returned within the error message

Returns:

error message

formPost

public javax.ws.rs.core.Response formPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input,
                                 String mediaType,
                                 String accept,
                                 javax.ws.rs.core.UriInfo uri,
                                 String application,
                                 String task,
                                 String format,
                                 String file)

Process a file submitted via the web form and return a link to the produced file

Specified by:

formPost in interface SoftwareServerRESTEasyInterface

Parameters:

input - Form containing Input Data

mediaType - media type being processed

accept - content type accepted by client

uri - Basic URL information

application - application's name

task - task to be performed

format - requested output format

file - name of the input file to be processed

Returns:

a link to the produced file

taskPost

public javax.ws.rs.core.Response taskPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input,
                                 String mediaType,
                                 String accept,
                                 javax.ws.rs.core.UriInfo uri,
                                 String application,
                                 String task,
                                 String format)

Process a file submitted to the Software Server and return a link to the produced file

Specified by:

taskPost in interface SoftwareServerRESTEasyInterface

Parameters:

input - Form containing Input Data

mediaType - media type being processed

accept - content type accepted by client

uri - Basic URL information

application - application's name

task - task to be performed

format - requested output format

Returns:

a link to the produced file

processPost

public javax.ws.rs.core.Response processPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input,
                                    String mediaType,
                                    String accept,
                                    javax.ws.rs.core.UriInfo uri,
                                    String application,
                                    String task,
                                    String format,
                                    String file,
                                    boolean formPost)

This is an auxiliary method working for the formPost() and the taskPost() methods. Returns the produced file

Parameters:

input - Form containing Input Data

mediaType - media type being processed

accept - content type accepted by client

uri - Basic URL information

application - application's name

task - task to be performed

format - requested output format

file - name of the input file to be processed

fromPost - true if message comes from formPost; false otherwise

Returns:

the produced file

getApplicationStack

public String getApplicationStack()

Get an icon representation of the available software.

Returns:

the HTML for the icon representation

getApplications

public String getApplications()

Get the applications available.

Returns:

the applications

getApplicationTasks

public String getApplicationTasks(String alias)

Get the tasks available for the given application.

Parameters:

alias - the application alias

Returns:

the application tasks

getApplicationTaskOutputs

public String getApplicationTaskOutputs(String alias,
                               String task)

Get the output formats supported by the given task.

Parameters:

alias - the application alias

task - the application task

Returns:

the output formats supported

getApplicationTaskInputsOutputs

public String getApplicationTaskInputsOutputs(String alias,
                                     String task)

Get the input and output formats supported by the given task.

Parameters:

alias - the application alias

task - the application task

Returns:

the input and output formats supported

getApplicationTaskInputs

public String getApplicationTaskInputs(String alias,
                              String task)

Get the input formats supported by the given task.

Parameters:

alias - the application alias

task - the application task

Returns:

the input formats supported

getTask

public Vector<SoftwareServerAuxiliary.Subtask> getTask(String application_alias,
                                              String task_string,
                                              String filename,
                                              String output_format)

Get the task involved in using the given applications to convert the given file to the specified output format.

Parameters:

application_alias - the alias of the application to use.

task_string - the task to perform

filename - the file name of the cached file to convert

output_format - the output format

Returns:

the task to perform the conversion

executeTask

public void executeTask(int session,
               String application_alias,
               String task_string,
               String file,
               String format,
               String url)

Execute a task.

Parameters:

session - the session id to use while executing the task

application_alias - the application to use

task_string - the task to perform (nothing assumed to be a conversion)

file - the URL of the file to convert

format - the output format

executeTaskLater

public void executeTaskLater(int session,
                    String application_alias,
                    String task_string,
                    String file,
                    String format,
                    String uri)

Execute a task asynchronously.

Parameters:

session - the session id to use while executing the task

application_alias - the application to use

task_string - the task to perform (nothing assumed to be a conversion)

file - the URL of the input file

format - the output format

getForm

public String getForm(boolean POST_UPLOADS,
             String selected_application,
             boolean HIDE_APPLICATIONS)

Get a web form interface for this restful service.

Parameters:

POST_UPLOADS - true if this form should use POST rather than GET for uploading files

selected_application - the default application

HIDE_APPLICATIONS - true if applications menu should be hidden

Returns:

the form

getForm

public String getForm()

Get a web form interface for this restful service.

Returns:

the form

getConvertForm

public String getConvertForm()

Get a web form interface for converting via this restful service.

Returns:

the form

createHTMLList

public static String createHTMLList(String list,
                    String link,
                    boolean APPEND,
                    String title)

Convert a line separated list into an HTML list of links.

Parameters:

list - the line separated list of items

link - the URL base

APPEND - true if list items should be appended to the end of link

title - the title of the generated HTML page (can be null)

Returns:

an HTML version of the given list

removeParameters

public static String removeParameters(String url)

Remove parameters from a URL.

Parameters:

url - the URL of a file

Returns:

the URL of a file without parameters

queryEndpoint

public static String queryEndpoint(String url)

Query an endpoint.

Parameters:

url - the URL of the endpoint

Returns:

the text obtained from the endpoint

stop

public static void stop()

Used to stop the servlet server

main

public static void main(String[] args)

Used to initialize and start the servlet server called the Tiny Java Web Server and Servlet (TJWS) Container.

Parameters:

args - the input arguments