edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerRESTUtilities

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.SoftwareServerRESTUtilities

public class SoftwareServerRESTUtilities
extends Object

Software Server REST interface utility functions.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
SoftwareServerRESTUtilities()

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.
static String	getApplicationStack(Vector<SoftwareServerAuxiliary.Application> applications) Get an icon representation of the available software.
static String	getConvertForm(Vector<SoftwareServerAuxiliary.Application> applications, Vector<TreeSet<SoftwareServerAuxiliary.TaskInfo>> application_tasks) Get a web form interface for converting via this restful service.
static String	getForm(Vector<SoftwareServerAuxiliary.Application> applications, Vector<TreeSet<SoftwareServerAuxiliary.TaskInfo>> application_tasks, TreeMap<String,SoftwareServerAuxiliary.Application> alias_map, boolean POST_UPLOADS, String selected_application, boolean HIDE_APPLICATIONS) Get a web form interface for this restful service.
static String	queryEndpoint(String url) Query an endpoint.
static void	rabbitMQHandler(String softwareserver_username, String softwareserver_password, int softwareserver_port, Vector<SoftwareServerAuxiliary.Application> softwareserver_applications, String rabbitmq_uri, String rabbitmq_server, String rabbitmq_vhost, String rabbitmq_username, String rabbitmq_password, boolean WAIT, boolean CHECKIN_URL, String public_path) Have a Software Server listen to a RabbitMQ bus for jobs.
static void	registration(String rabbitmq_uri, String regis_queue_name, int regis_msg_ttl, String msg) Create a thread to send registration messages to the RabbitMQ SS-registration queue.
static String	removeParameters(String url) Remove parameters from a URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwareServerRESTUtilities

public SoftwareServerRESTUtilities()

Method Detail

getApplicationStack

public static String getApplicationStack(Vector<SoftwareServerAuxiliary.Application> applications)

Get an icon representation of the available software.

Parameters:

applications - the list of applications

Returns:

the HTML for the icon representation

getForm

public static String getForm(Vector<SoftwareServerAuxiliary.Application> applications,
             Vector<TreeSet<SoftwareServerAuxiliary.TaskInfo>> application_tasks,
             TreeMap<String,SoftwareServerAuxiliary.Application> alias_map,
             boolean POST_UPLOADS,
             String selected_application,
             boolean HIDE_APPLICATIONS)

Get a web form interface for this restful service.

Parameters:

applications - the list of applications

application_tasks - the list of available application tasks

alias_map - the application alias map

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

getConvertForm

public static String getConvertForm(Vector<SoftwareServerAuxiliary.Application> applications,
                    Vector<TreeSet<SoftwareServerAuxiliary.TaskInfo>> application_tasks)

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

Parameters:

applications - the list of applications

application_tasks - the list of available application tasks

Returns:

the form

queryEndpoint

public static String queryEndpoint(String url)

Query an endpoint.

Parameters:

url - the URL of the endpoint

Returns:

the text obtained from the endpoint

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

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

rabbitMQHandler

public static void rabbitMQHandler(String softwareserver_username,
                   String softwareserver_password,
                   int softwareserver_port,
                   Vector<SoftwareServerAuxiliary.Application> softwareserver_applications,
                   String rabbitmq_uri,
                   String rabbitmq_server,
                   String rabbitmq_vhost,
                   String rabbitmq_username,
                   String rabbitmq_password,
                   boolean WAIT,
                   boolean CHECKIN_URL,
                   String public_path)

Have a Software Server listen to a RabbitMQ bus for jobs.

Parameters:

softwareserver_username - the Software Server user to use

softwareserver_password - the Software Server user password

softwareserver_port - the Software Server port

softwareserver_applications - the available applications

rabbitmq_uri - the rabbitmq URI, overrides below parameters

rabbitmq_server - the rabbitmq server

rabbitmq_vhost - the rabbitmq virtual host

rabbitmq_username - the rabbitmq user

rabbitmq_password - the rabbitmq user password

WAIT - true if should wait for jobs to finish before acknowledging completion

CHECKIN_URL - true if the URL to the output file should be sent back to Polygot as opposed to the actual file

public_path - the path where the converted files reside, has trailing slash "/"

registration

public static void registration(String rabbitmq_uri,
                String regis_queue_name,
                int regis_msg_ttl,
                String msg)

Create a thread to send registration messages to the RabbitMQ SS-registration queue.

Parameters:

rabbitmq_uri - the rabbitmq URI

regis_queue_name - the name of the SS registration queue in RabbitMQ

regis_msg_ttl - the TTL (in milliseconds) for the registration msgs

msg - the string to be published into the queue