edu.illinois.ncsa.isda.softwareserver.polyglot

Class PolyglotStewardAMQ

java.lang.Object

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

edu.illinois.ncsa.isda.softwareserver.polyglot.PolyglotStewardAMQ

All Implemented Interfaces:

Runnable

public class PolyglotStewardAMQ
extends Polyglot
implements Runnable

A class that coordinates the use of several software servers to perform file format conversions.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
PolyglotStewardAMQ() Class constructor.
PolyglotStewardAMQ(boolean START) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	checkin(String host, int job_id, String result) Update status of job task (TODO: needs to do some checks to ensure validity of result!)
void	close() Close anything that needs to be closed.
String	convert(String input, String output_path, String output_format) Convert a files format.
void	discoveryAMQ_pull() Discover Software Servers consuming on the given RabbitMQ bus (adds them to I/O-graph).
void	discoveryAMQ_push()
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.
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	heartbeat_pull() Checks on Software Servers to see if they are still alive (removes them from I/O-graph).
void	heartbeat_push()
void	loadConfiguration(String filename) Initialize based on parameters within the given configuration file.
static void	main(String[] args) Start the Polyglot Steward.
void	process_jobs() Process jobs pending in mongo.
static void	purgeJobs() Purge current and previous jobs.
static com.fasterxml.jackson.databind.JsonNode	queryEndpoint(String url) Query an endpoint.
void	run() The main thread.
void	setAuthentication(String username, String password) Set the username and password to use when others communicate back to polyglot.
void	setJobCounter(String path) Set job counter based on a previous execution.
void	start() Start the main thread (as a separate function so can be called externally, e.g.

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

PolyglotStewardAMQ

public PolyglotStewardAMQ()

Class constructor.

PolyglotStewardAMQ

public PolyglotStewardAMQ(boolean START)

Class constructor.

Parameters:

START - start immediately

Method Detail

loadConfiguration

public void loadConfiguration(String filename)

Initialize based on parameters within the given configuration file.

Parameters:

filename - the file name of the configuration file

start

public void start()

Start the main thread (as a separate function so can be called externally, e.g. if jobs should be purged first)

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

convert

public String convert(String input,
             String output_path,
             String output_format)

Convert a files format.

Specified by:

convert in class Polyglot

Parameters:

input - the absolute name of the input file

output_path - the output path

output_format - the output format

Returns:

the output file name (if changed, null otherwise)

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

close

public void close()

Close anything that needs to be closed.

Specified by:

close in class Polyglot

setJobCounter

public void setJobCounter(String path)

Set job counter based on a previous execution.

Parameters:

path - the artifact path to examine for previous job IDs

setAuthentication

public void setAuthentication(String username,
                     String password)

Set the username and password to use when others communicate back to polyglot.

discoveryAMQ_pull

public void discoveryAMQ_pull()

Discover Software Servers consuming on the given RabbitMQ bus (adds them to I/O-graph).

discoveryAMQ_push

public void discoveryAMQ_push()

heartbeat_pull

public void heartbeat_pull()

Checks on Software Servers to see if they are still alive (removes them from I/O-graph).

heartbeat_push

public void heartbeat_push()

process_jobs

public void process_jobs()

Process jobs pending in mongo.

checkin

public String checkin(String host,
             int job_id,
             String result)

Update status of job task (TODO: needs to do some checks to ensure validity of result!)

Parameters:

host - the host checking in (should be a Software Server)

job_id - the job id being worked on

Returns:

the response to the Software Server

run

public void run()

The main thread.

Specified by:

run in interface Runnable

queryEndpoint

public static com.fasterxml.jackson.databind.JsonNode queryEndpoint(String url)

Query an endpoint.

Parameters:

url - the URL of the endpoint

Returns:

the json obtained from the endpoint

purgeJobs

public static void purgeJobs()

Purge current and previous jobs.

main

public static void main(String[] args)

Start the Polyglot Steward.

Parameters:

args - command line arguments