edu.illinois.ncsa.isda.softwareserver.parametrized

Class SoftwareServerReslet

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

edu.illinois.ncsa.isda.softwareserver.parametrized.SoftwareServerReslet

public class SoftwareServerReslet
extends org.restlet.resource.ServerResource

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

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
SoftwareServerReslet()

Method Summary

Methods

Modifier and Type	Method and Description
void	executeTask(int session, String application_alias, String task_string, String file, String format, String params) Execute a task.
void	executeTaskLater(int session, String application_alias, String task_string, String file, String format, String params) 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	getApplicationTaskInputs(String alias, String task, String output)
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	getApplicationTaskOutputs(String alias, String task, String input) Get the output formats supported by the given task from a known input format.
String	getApplicationTaskParameters(String application_alias, String task_string, String output_format, String input_format)
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.
kgm.utility.Pair<String,String>	getJSParameters(String application_alias, String task_string, String output_format, String input_format) Get the HTML for parameters form
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.
Vector<SoftwareServerAuxiliary.Subtask>	getTaskInfo(String application_alias, String task_string, String input_format, String output_format)
org.restlet.representation.Representation	httpGetHandler()
org.restlet.representation.Representation	httpPostHandler(org.restlet.representation.Representation entity)
static void	initialize() Initialize.
static boolean	isTextOnly(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.

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

SoftwareServerReslet

public SoftwareServerReslet()

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,
                               String input)

Get the output formats supported by the given task from a known input format.

Parameters:

alias - the application alias

task - the application task

Returns:

the output formats supported

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

getApplicationTaskInputs

public String getApplicationTaskInputs(String alias,
                              String task,
                              String output)

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

getJSParameters

public kgm.utility.Pair<String,String> getJSParameters(String application_alias,
                                              String task_string,
                                              String output_format,
                                              String input_format)

Get the HTML for parameters form

Parameters:

application_alias - the application to use

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

output_format - the output format

input_format - the URL of the file to convert

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

getTaskInfo

public Vector<SoftwareServerAuxiliary.Subtask> getTaskInfo(String application_alias,
                                                  String task_string,
                                                  String input_format,
                                                  String output_format)

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

getApplicationTaskParameters

public String getApplicationTaskParameters(String application_alias,
                                  String task_string,
                                  String output_format,
                                  String input_format)

Parameters:

application_alias - the application to use

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

output_format - the output format

input_format - the URL of the file to convert

executeTask

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

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 params)

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)

queryEndpoint

public static String queryEndpoint(String url)

Query an endpoint.

Parameters:

url - the URL of the endpoint

Returns:

the text obtained from the endpoint

isTextOnly

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

Check if the given request is for plain text only.

Parameters:

request - the request

Returns:

true if plain/text only

main

public static void main(String[] args)

Start the restful service.

Parameters:

args - the input arguments