edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerAuxiliary.Script

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.SoftwareServerAuxiliary.Script

Enclosing class:

SoftwareServerAuxiliary

public static class SoftwareServerAuxiliary.Script
extends Object

A structure representing a wrapper script.

Field Summary

Fields

Modifier and Type	Field and Description
String	alias
String	application
TreeSet<String>	executables
String	filename
TreeSet<String>	inputs
String	name
String	operation
TreeSet<String>	outputs
String	path
static SoftwareServerAuxiliary.ScriptTypes	scripttypes
String	type
TreeSet<String>	types

Constructor Summary

Constructors

Constructor and Description
SoftwareServerAuxiliary.Script() Class constructor.
SoftwareServerAuxiliary.Script(String filename) Class constructor.
SoftwareServerAuxiliary.Script(String filename, String comment_head) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute this script.
static void	execute(String script) Execute a script.
void	executeAndWait() Execute this script.
static void	executeAndWait(String script) Execute a script.
boolean	executeAndWait(String source, String target, String temp_path, int max_runtime) Execute this script.
boolean	executeAndWait(String source, String target, String temp_path, int max_runtime, boolean HANDLE_OUTPUT) Execute this script.
Vector<SoftwareServerAuxiliary.Script>	getAssociatedInputScripts() Search this scripts path for input scripts associated with this application.
Vector<SoftwareServerAuxiliary.Script>	getAssociatedOutputScripts() Search this scripts path for output scripts associated with this application.
static String	getCommand(String script) Get the execution command for the given script.
static String	getCommand(String script, String source, String target, String temp_path) Get the execution command for the given script.
TreeSet<String>	getExecutables() Get the executables called by the script.
static String	getOperation(String script) Get the operation performed by the given script.
String	getOperationScriptname(String operation) Return the name of an associated script for the given operation.
TreeSet<String>	parseFormatList(String line) Parse a line from a script header containing a format list

Methods inherited from class java.lang.Object

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

Field Detail

filename

public String filename

path

public String path

name

public String name

type

public String type

alias

public String alias

operation

public String operation

application

public String application

types

public TreeSet<String> types

inputs

public TreeSet<String> inputs

outputs

public TreeSet<String> outputs

executables

public TreeSet<String> executables

scripttypes

public static SoftwareServerAuxiliary.ScriptTypes scripttypes

Constructor Detail

SoftwareServerAuxiliary.Script

public SoftwareServerAuxiliary.Script()

Class constructor.

SoftwareServerAuxiliary.Script

public SoftwareServerAuxiliary.Script(String filename)

Class constructor. Script info will be looked up via extension.

Parameters:

filename - the script file name

SoftwareServerAuxiliary.Script

public SoftwareServerAuxiliary.Script(String filename,
                              String comment_head)

Class constructor. Useful when script can be called stand alone and all that's needed is the comment style.

Parameters:

filename - the script file name

comment_head - the preceding sequence of characters indicating a commented line (can be null)

Method Detail

parseFormatList

public TreeSet<String> parseFormatList(String line)

Parse a line from a script header containing a format list

Parameters:

line - the line containing the format list

Returns:

the formats parsed from this list

getOperationScriptname

public String getOperationScriptname(String operation)

Return the name of an associated script for the given operation.

Parameters:

operation - the desired operation

Returns:

the name of the script for this operation

getAssociatedInputScripts

public Vector<SoftwareServerAuxiliary.Script> getAssociatedInputScripts()

Search this scripts path for input scripts associated with this application.

Returns:

the list of scripts found

getAssociatedOutputScripts

public Vector<SoftwareServerAuxiliary.Script> getAssociatedOutputScripts()

Search this scripts path for output scripts associated with this application.

Returns:

the list of scripts found

getExecutables

public TreeSet<String> getExecutables()

Get the executables called by the script.

Returns:

a set of found executables

getOperation

public static String getOperation(String script)

Get the operation performed by the given script.

Parameters:

script - the script filename

Returns:

the operation performed by the script

getCommand

public static String getCommand(String script)

Get the execution command for the given script.

Parameters:

script - the absolute filename of the script

Returns:

the execution command

getCommand

public static String getCommand(String script,
                String source,
                String target,
                String temp_path)

Get the execution command for the given script.

Parameters:

script - the absolute filename of the script

source - the first argument to pass to the script

target - the second argument to pass to the script

temp_path - the third argument to pass to the script

Returns:

the execution command

executeAndWait

public static void executeAndWait(String script)

Execute a script.

Parameters:

script - the absolute filename of the script

executeAndWait

public boolean executeAndWait(String source,
                     String target,
                     String temp_path,
                     int max_runtime,
                     boolean HANDLE_OUTPUT)

Execute this script.

Parameters:

source - the first argument to pass to the script

target - the second argument to pass to the script

temp_path - the third argument to pass to the script

max_runtime - the maximum allowed time to run (in milli-seconds)

HANDLE_OUTPUT - true if the process output should be handled

Returns:

true if the operation completed within the given time frame

executeAndWait

public boolean executeAndWait(String source,
                     String target,
                     String temp_path,
                     int max_runtime)

Execute this script.

Parameters:

source - the first argument to pass to the script

target - the second argument to pass to the script

temp_path - the third argument to pass to the script

max_runtime - the maximum allowed time to run (in milli-seconds)

Returns:

true if the operation completed within the given time frame

executeAndWait

public void executeAndWait()

Execute this script.

execute

public static void execute(String script)

Execute a script.

Parameters:

script - the absolute filename of the script

execute

public void execute()

Execute this script.