edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerRestlet

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

edu.illinois.ncsa.isda.softwareserver.SoftwareServerRestlet

public class SoftwareServerRestlet
extends org.restlet.resource.ServerResource

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

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
SoftwareServerRestlet()

Method Summary

Methods

Modifier and Type	Method and Description
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) Execute a task.
void	executeTaskLater(int session, String application_alias, String task_string, String file, String format) Execute a task asynchronously.
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.
org.restlet.representation.Representation	httpGetHandler()
org.restlet.representation.Representation	httpPostHandler(org.restlet.representation.Representation entity)
static void	initialize() Initialize.
static boolean	isJSONRequest(org.restlet.Request request) Check if the given request is for json only.
static boolean	isPlainRequest(org.restlet.Request request) Check if the given request is for plain text only.
static void	main(String[] args) Start the restful service.
static String	queryEndpoint(String url) Query an endpoint.
static String	removeParameters(String url) Remove parameters from a URL.
void	stop() Stop the REST interface and underlying Software Server.

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, getAttribute, getInfo, getInfo, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doInit, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toObject, toRepresentation, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwareServerRestlet

public SoftwareServerRestlet()

Method Detail

initialize

public static void initialize()

Initialize.

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

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

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

getApplicationStack

public String getApplicationStack()

Get an icon representation of the available software.

Returns:

the HTML for the icon representation

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

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)

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)

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

httpGetHandler

@Get
public org.restlet.representation.Representation httpGetHandler()

httpPostHandler

@Post
public org.restlet.representation.Representation httpPostHandler(org.restlet.representation.Representation entity)

stop

public void stop()

Stop the REST interface and underlying Software Server.

queryEndpoint

public static String queryEndpoint(String url)

Query an endpoint.

Parameters:

url - the URL of the endpoint

Returns:

the text obtained from the endpoint

isPlainRequest

public static boolean isPlainRequest(org.restlet.Request request)

Check if the given request is for plain text only.

Parameters:

request - the request

Returns:

true if plain/text only

isJSONRequest

public static boolean isJSONRequest(org.restlet.Request request)

Check if the given request is for json only.

Parameters:

request - the request

Returns:

true if application/json only

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

main

public static void main(String[] args)

Start the restful service.

Parameters:

args - the input arguments