edu.illinois.ncsa.isda.softwareserver.polyglot

Class PolyglotSteward

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.polyglot.Polyglot

edu.illinois.ncsa.isda.softwareserver.polyglot.PolyglotSteward

All Implemented Interfaces:

Runnable

public class PolyglotSteward
extends Polyglot
implements Runnable

A class that coordinates the use of several software server clients via I/O-graphs to perform file format conversions.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
PolyglotSteward() Class constructor.
PolyglotSteward(PolyglotSteward polyglot) Class copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(SoftwareServerClient ssc) Add a software server client.
boolean	add(String server, int port) Add a software server client.
void	close() Close all software server client connections and stop the PolyglotSteward thread.
SoftwareServerAuxiliary.FileData	convert(SoftwareServerAuxiliary.FileData input_file_data, String output_type) Convert a files format.
SoftwareServerAuxiliary.FileData	convert(SoftwareServerAuxiliary.FileData input_file_data, Vector<PolyglotAuxiliary.Conversion<SoftwareServerAuxiliary.Data,SoftwareServerAuxiliary.Application>> conversions) Convert a files format.
String	convert(String input_filename, String output_path, String output_type) Convert a files format.
void	convert(String input_filename, String output_path, Vector<PolyglotAuxiliary.Conversion<SoftwareServerAuxiliary.Data,SoftwareServerAuxiliary.Application>> conversions) Convert a files format.
void	convertOverREST(String input_filename, String output_path, String output_type) Convert a file's format using the Software Server's REST interface.
SoftwareServerClient	get(int index) Retrieve the specified software server client.
IOGraph<String,String>	getDistributedInputOutputGraph() Get a string only version of this IOGraph encoded with host machines.
IOGraph<String,String>	getInputOutputGraph() Get the available inputs, outputs, and conversions.
TreeSet<String>	getInputs() Get the inputs available.
TreeSet<String>	getInputs(String output) Get the inputs available for the given output type.
IOGraph<SoftwareServerAuxiliary.Data,SoftwareServerAuxiliary.Application>	getIOGraph() Get the I/O-graph.
TreeSet<String>	getOutputs() Get the outputs available.
TreeSet<String>	getOutputs(String input) Get the outputs available for the given input type.
TreeSet<String>	getOutputs(TreeSet<String> inputs) Get the common outputs available for the given input types.
Vector<String>	getServers() Get a list of connected software servers.
TreeSet<String>	getSoftware() Get the software available.
void	listen(int port) Start listening for SoftwareServers.
static void	main(String[] args) Command line polyglot interface.
void	run() Clean up lost connections.
void	setApplicationFlexibility(int value) Set the flexibility when choosing an application where 0=none (default), 1=allow parallel applications with the same name (different software servers), 2=allow all parallel applications.
void	setMaxTaskTime(int value) Set the maximum time to wait for a task to complete (used with the Software Server REST interface).
void	setSoftwareServerRESTPort(int value) Set the software server port.
int	size() Get the number of software server clients being used.
void	waitUntilStopped() Wait until the steward's threads have stopped.

Methods inherited from class edu.illinois.ncsa.isda.softwareserver.polyglot.Polyglot

convertLater, waitOnPending

Methods inherited from class java.lang.Object

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

Constructor Detail

PolyglotSteward

public PolyglotSteward()

Class constructor.

PolyglotSteward

public PolyglotSteward(PolyglotSteward polyglot)

Class copy constructor.

Parameters:

polyglot - the polyglot steward to copy

Method Detail

size

public int size()

Get the number of software server clients being used.

Returns:

the number of software server clients

add

public boolean add(SoftwareServerClient ssc)

Add a software server client.

Parameters:

ssc - a software server client

Returns:

true if successfully added

add

public boolean add(String server,
          int port)

Add a software server client.

Parameters:

server - the server name

port - the port number

Returns:

true if successfully added

get

public SoftwareServerClient get(int index)

Retrieve the specified software server client.

Parameters:

index - the index of the desired client

Returns:

the software server client

getIOGraph

public IOGraph<SoftwareServerAuxiliary.Data,SoftwareServerAuxiliary.Application> getIOGraph()

Get the I/O-graph.

Returns:

the I/O-graph

getSoftware

public TreeSet<String> getSoftware()

Get the software available.

Specified by:

getSoftware in class Polyglot

Returns:

the list of software

getOutputs

public TreeSet<String> getOutputs()

Get the outputs available.

Specified by:

getOutputs in class Polyglot

Returns:

the list of outputs

getOutputs

public TreeSet<String> getOutputs(String input)

Get the outputs available for the given input type.

Specified by:

getOutputs in class Polyglot

Parameters:

input - the input type

Returns:

the list of outputs

getOutputs

public TreeSet<String> getOutputs(TreeSet<String> inputs)

Get the common outputs available for the given input types.

Specified by:

getOutputs in class Polyglot

Parameters:

inputs - the input types

Returns:

the list of outputs

getInputs

public TreeSet<String> getInputs()

Get the inputs available.

Specified by:

getInputs in class Polyglot

Returns:

the list of inputs

getInputs

public TreeSet<String> getInputs(String output)

Get the inputs available for the given output type.

Specified by:

getInputs in class Polyglot

Parameters:

output - the output type

Returns:

the list of inputs

getInputOutputGraph

public IOGraph<String,String> getInputOutputGraph()

Get the available inputs, outputs, and conversions.

Specified by:

getInputOutputGraph in class Polyglot

Returns:

an IOGraph containing the information as strings

getServers

public Vector<String> getServers()

Get a list of connected software servers.

Specified by:

getServers in class Polyglot

Returns:

a list of connected software servers

getDistributedInputOutputGraph

public IOGraph<String,String> getDistributedInputOutputGraph()

Get a string only version of this IOGraph encoded with host machines.

Specified by:

getDistributedInputOutputGraph in class Polyglot

Returns:

a string version of this IOGraph

setApplicationFlexibility

public void setApplicationFlexibility(int value)

Set the flexibility when choosing an application where 0=none (default), 1=allow parallel applications with the same name (different software servers), 2=allow all parallel applications. The higher the value the more parallelism can be taken advantage of.

Parameters:

value - the flexibility value

setSoftwareServerRESTPort

public void setSoftwareServerRESTPort(int value)

Set the software server port.

Parameters:

value - the port

setMaxTaskTime

public void setMaxTaskTime(int value)

Set the maximum time to wait for a task to complete (used with the Software Server REST interface).

Parameters:

value - the time to wait in milliseconds

convert

public SoftwareServerAuxiliary.FileData convert(SoftwareServerAuxiliary.FileData input_file_data,
                                       Vector<PolyglotAuxiliary.Conversion<SoftwareServerAuxiliary.Data,SoftwareServerAuxiliary.Application>> conversions)

Convert a files format.

Parameters:

input_file_data - the input file data

conversions - the conversions to perform

Returns:

the output file data

convert

public SoftwareServerAuxiliary.FileData convert(SoftwareServerAuxiliary.FileData input_file_data,
                                       String output_type)

Convert a files format.

Parameters:

input_file_data - the input file data

output_type - the name of the output type

Returns:

the output file data

convert

public void convert(String input_filename,
           String output_path,
           Vector<PolyglotAuxiliary.Conversion<SoftwareServerAuxiliary.Data,SoftwareServerAuxiliary.Application>> conversions)

Convert a files format.

Parameters:

input_filename - the absolute name of the input file

output_path - the output path

conversions - the conversions to perform

convert

public String convert(String input_filename,
             String output_path,
             String output_type)

Convert a files format.

Specified by:

convert in class Polyglot

Parameters:

input_filename - the absolute name of the input file

output_path - the output path

output_type - the name of the output type

Returns:

the output file name (if changed, null otherwise)

convertOverREST

public void convertOverREST(String input_filename,
                   String output_path,
                   String output_type)

Convert a file's format using the Software Server's REST interface. Allows intermediary results to be available (i.e. hosted) on the Software Servers.

Parameters:

input_filename - the absolute name of the input file

output_path - the output path

output_type - the name of the output type

close

public void close()

Close all software server client connections and stop the PolyglotSteward thread.

Specified by:

close in class Polyglot

waitUntilStopped

public void waitUntilStopped()

Wait until the steward's threads have stopped.

listen

public void listen(int port)

Start listening for SoftwareServers.

Parameters:

port - the port to listen to

run

public void run()

Clean up lost connections.

Specified by:

run in interface Runnable

main

public static void main(String[] args)

Command line polyglot interface.

Parameters:

args - command line arguments