edu.illinois.ncsa.isda.softwareserver.polyglot

Class PolyglotRESTEasy

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.polyglot.PolyglotRESTEasy

All Implemented Interfaces:

PolyglotRESTEasyInterface

public class PolyglotRESTEasy
extends Object
implements PolyglotRESTEasyInterface

A restful interface for a polyglot steward. Think of this as an extended polyglot steward.

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
PolyglotRESTEasy() 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	Convert(javax.ws.rs.core.UriInfo uriInfo, String accept) Used to list all the output formats produced by the polyglot server
javax.ws.rs.core.Response	ConvertFile(javax.ws.rs.core.UriInfo uriInfo, String accept, javax.servlet.http.HttpServletRequest req, String outFmt, String file) Used to post a conversion request to the softwareserver
javax.ws.rs.core.Response	ConvertFmt(String outFmt) Used to obtain a list the input formats associated with the output format
javax.ws.rs.core.Response	Endpoints(javax.ws.rs.core.UriInfo uriInfo, String accept) Used to list the of endpoints in the polyglot server
javax.ws.rs.core.Response	File(javax.ws.rs.core.UriInfo uri, String fileName) Used to download a file form polyglot server
javax.ws.rs.core.Response	Form(javax.ws.rs.core.UriInfo uriInfo, String accept) Used to obtain a list of actions that can be performed (get, post)
javax.ws.rs.core.Response	formPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input, String mediaType, String accept, javax.ws.rs.core.UriInfo uri, javax.servlet.http.HttpServletRequest req, String output) Process a file submitted via the web form and return a link to the produced file
javax.ws.rs.core.Response	Forms(javax.ws.rs.core.UriInfo uri, String output, String file, String action) Return a web form to interact with the Software Server
javax.ws.rs.core.Response	Inputs(javax.ws.rs.core.UriInfo uriInfo, String accept) Used to list all the input formats the polyglot server is able to serve
javax.ws.rs.core.Response	InputsOut(javax.ws.rs.core.UriInfo uriInfo, String accept, String out) Used to list all the input formats that can be converted to output format
static void	main(String[] args) Start the Polyglot REST interface.
javax.ws.rs.core.Response	Outputs() Used to list all the file formats the polyglot server is able to produce
javax.ws.rs.core.Response	printErrorMessage(String msg) Returns an error message
javax.ws.rs.core.Response	processPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input, String mediaType, String accept, javax.ws.rs.core.UriInfo uri, javax.servlet.http.HttpServletRequest req, String output, boolean formPost) This is an auxiliary method working for the formPost() and the taskPost() methods.
javax.ws.rs.core.Response	Requests() Used to obtain of a list of the processed task since startup
javax.ws.rs.core.Response	Servers() Used to list the software servers connected to polyglot server
javax.ws.rs.core.Response	Software() Used to list the applications available in polyglot server
void	stop() Stop the REST interface.
javax.ws.rs.core.Response	taskPost(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input, String mediaType, String accept, javax.ws.rs.core.UriInfo uri, javax.servlet.http.HttpServletRequest req, String output) Process a file submitted to Polyglot and return a link to the produced file

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

PolyglotRESTEasy

public PolyglotRESTEasy()

Class constructor.

Method Detail

Endpoints

public javax.ws.rs.core.Response Endpoints(javax.ws.rs.core.UriInfo uriInfo,
                                  String accept)

Used to list the of endpoints in the polyglot server

Specified by:

Endpoints in interface PolyglotRESTEasyInterface

Parameters:

uriInfo - Basic URL information

accept - content type accepted by client

Returns:

list of endpoints in the polyglot server

Convert

public javax.ws.rs.core.Response Convert(javax.ws.rs.core.UriInfo uriInfo,
                                String accept)

Used to list all the output formats produced by the polyglot server

Specified by:

Convert in interface PolyglotRESTEasyInterface

Parameters:

uriInfo - Basic URL information

accept - content type accepted by client

Returns:

list all the output formats produced by the polyglot server

ConvertFmt

public javax.ws.rs.core.Response ConvertFmt(String outFmt)

Used to obtain a list the input formats associated with the output format

Specified by:

ConvertFmt in interface PolyglotRESTEasyInterface

Parameters:

outFmt - the output format

Returns:

list the input formats associated with the output format

ConvertFile

public javax.ws.rs.core.Response ConvertFile(javax.ws.rs.core.UriInfo uriInfo,
                                    String accept,
                                    javax.servlet.http.HttpServletRequest req,
                                    String outFmt,
                                    String file)
                                      throws IOException

Used to post a conversion request to the softwareserver

Specified by:

ConvertFile in interface PolyglotRESTEasyInterface

Parameters:

uriInfo - Basic URL information

accept - content type accepted by client

req - used to obtain the ip address of the client

outFmt - the output format

file - input file to be processed

Returns:

the produced file

Throws:

IOException

Form

public javax.ws.rs.core.Response Form(javax.ws.rs.core.UriInfo uriInfo,
                             String accept)

Used to obtain a list of actions that can be performed (get, post)

Specified by:

Form in interface PolyglotRESTEasyInterface

Parameters:

uriInfo - Basic URL information

accept - content type accepted by client

Returns:

list of actions that can be performed

Forms

public javax.ws.rs.core.Response Forms(javax.ws.rs.core.UriInfo uri,
                              String output,
                              String file,
                              String action)

Return a web form to interact with the Software Server

Specified by:

Forms in interface PolyglotRESTEasyInterface

Parameters:

uriInfo - basic URL information

output - the default output format

file - input file to be processed

action - either get or post

Returns:

a response containing either a link to the form or an error message

File

public javax.ws.rs.core.Response File(javax.ws.rs.core.UriInfo uri,
                             String fileName)
                               throws IOException

Used to download a file form polyglot server

Specified by:

File in interface PolyglotRESTEasyInterface

Parameters:

uri - Basic URL information

fileName - file to be downloaded polyglot server

Returns:

file form polyglot server

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 PolyglotRESTEasyInterface

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 PolyglotRESTEasyInterface

Returns:

yes if the server is alive

Servers

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

Used to list the software servers connected to polyglot server

Specified by:

Servers in interface PolyglotRESTEasyInterface

Returns:

list the software servers connected to polyglot server

Software

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

Used to list the applications available in polyglot server

Specified by:

Software in interface PolyglotRESTEasyInterface

Returns:

list of applications available in software server

Inputs

public javax.ws.rs.core.Response Inputs(javax.ws.rs.core.UriInfo uriInfo,
                               String accept)

Used to list all the input formats the polyglot server is able to serve

Specified by:

Inputs in interface PolyglotRESTEasyInterface

Returns:

list of input formats

InputsOut

public javax.ws.rs.core.Response InputsOut(javax.ws.rs.core.UriInfo uriInfo,
                                  String accept,
                                  String out)

Used to list all the input formats that can be converted to output format

Specified by:

InputsOut in interface PolyglotRESTEasyInterface

Parameters:

uriInfo - Basic URL information

accept - content type accepted by client

out - output format

Returns:

list all the input formats that can be converted to output format

Outputs

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

Used to list all the file formats the polyglot server is able to produce

Specified by:

Outputs in interface PolyglotRESTEasyInterface

Returns:

list of output formats

Requests

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

Used to obtain of a list of the processed task since startup

Specified by:

Requests in interface PolyglotRESTEasyInterface

Returns:

list of the processed task since startup

printErrorMessage

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

Returns an error message

Specified by:

printErrorMessage in interface PolyglotRESTEasyInterface

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,
                                 javax.servlet.http.HttpServletRequest req,
                                 String output)

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

Specified by:

formPost in interface PolyglotRESTEasyInterface

Parameters:

input - Form containing Input Data

mediaType - media type being processed

accept - content type accepted by client

uri - Basic URL information

req - used to obtain the ip address of the client

output - the output format

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,
                                 javax.servlet.http.HttpServletRequest req,
                                 String output)

Process a file submitted to Polyglot and return a link to the produced file

Specified by:

taskPost in interface PolyglotRESTEasyInterface

Parameters:

input - Form containing Input Data

mediaType - media type being processed

accept - content type accepted by client

uri - Basic URL information

req - used to obtain the ip address of the client

output - the 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,
                                    javax.servlet.http.HttpServletRequest req,
                                    String output,
                                    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

req - used to obtain the ip address of the client

output - the output format

fromPost - true if message comes from formPost; false otherwise

Returns:

the produced file

stop

public void stop()

Stop the REST interface.

main

public static void main(String[] args)

Start the Polyglot REST interface.

Parameters:

args - command line arguments