edu.illinois.ncsa.isda.softwareserver

Class DistributedSoftwareServerRestlet

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

edu.illinois.ncsa.isda.softwareserver.DistributedSoftwareServerRestlet

public class DistributedSoftwareServerRestlet
extends org.restlet.resource.ServerResource

A restful interface to multiple software servers.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
DistributedSoftwareServerRestlet()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addServer(String server) Record the existence of a software server and the applications/tasks it provides.
static void	checkServers() Remove dead servers and their associated tasks.
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.
static Vector<Vector<String>>	getEndpointCommaSeparatedValues(String url) Query a restlet endpoint that responds with lines of comma separated values.
static Vector<String>	getEndpointValues(String url) Query a restlet endpoint that responds with a line separated text list of values.
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.
String	getNonBusyServer(String application, String task, String input, String output) Find a non-busy server that can perform the given task.
String	getServers() Get the software servers registered to this master service.
org.restlet.representation.Representation	httpGetHandler()
org.restlet.representation.Representation	httpPostHandler(org.restlet.representation.Representation entity)
static void	main(String[] args) Start the restful service.
void	stop() Stop the REST interface.

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

DistributedSoftwareServerRestlet

public DistributedSoftwareServerRestlet()

Method Detail

addServer

public static void addServer(String server)

Record the existence of a software server and the applications/tasks it provides.

Parameters:

server - a software server

checkServers

public static void checkServers()

Remove dead servers and their associated tasks.

getServers

public String getServers()

Get the software servers registered to this master service.

Returns:

the registered software servers

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 input 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

getNonBusyServer

public String getNonBusyServer(String application,
                      String task,
                      String input,
                      String output)

Find a non-busy server that can perform the given task.

Parameters:

application - the application to use

task - the task to perform

input - the input format

output - the output format

Returns:

the available server

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.

getEndpointValues

public static Vector<String> getEndpointValues(String url)

Query a restlet endpoint that responds with a line separated text list of values.

Parameters:

url - the URL of the restlet endpoint to query

Returns:

the values returned from the endpoint

getEndpointCommaSeparatedValues

public static Vector<Vector<String>> getEndpointCommaSeparatedValues(String url)

Query a restlet endpoint that responds with lines of comma separated values.

Parameters:

url - the URL of the restlet endpoint to query

Returns:

the values returned from the endpoint

main

public static void main(String[] args)

Start the restful service.

Parameters:

args - the input arguments