edu.illinois.ncsa.isda.softwareserver

Class SoftwareServer

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.SoftwareServer

All Implemented Interfaces:

Runnable

public class SoftwareServer
extends Object
implements Runnable

A Software Server.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
SoftwareServer() Class constructor.
SoftwareServer(String filename) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addScriptedOperations(String path, String extension) Add operation scripts within the given directory.
void	addScriptedOperations(String path, String extension, String comment_head) Add operation scripts within the given directory.
String	executeTask(String host, int session, Vector<SoftwareServerAuxiliary.Subtask> task) Execute the given task.
String	executeTaskAtomically(String host, int session, Vector<SoftwareServerAuxiliary.Subtask> task) Execute the given task (synchronized version).
Vector<SoftwareServerAuxiliary.Application>	getApplications() Get the utilized applications.
String	getCachePath() Get the servers cache path.
int	getCompletedTaskCount() Get the number of completed tasks.
static String	getFilename(String filename) Parse the filename from the cached filename.
int	getKillCount() Get the number of times the kill operation has been used.
static int	getLastSession(String path) Get the last session, the highest number, based on the files in the given directory.
int	getMaxOperationTime() Get the maximum allowed operation time.
int	getPort() Get the port the server is listening to.
int	getSession() Get a new session number.
static int	getSession(String filename) Parse the session id from the cached filename.
int	getTaskCount() Get the number of tasks received since starting up.
String	getTempPath() Get the servers temp path.
boolean	isBusy() Is the server busy executing a task?
void	loadConfiguration(String filename) Initialize based on parameters within the given configuration file.
static void	main(String[] args) A main for the ICR service.
void	rebootMachine() Reboot the machine the software server is running on.
void	resetCounts() Reset task counters to zero.
void	run() Process ICR requests.
void	serveConnection(int session, Socket client_socket) Process requests from the given connection.
void	setCachePath(String path) Set the cache path
void	stop() Stop the Software Server.
void	waitUntilRunning() Wait until the servers main thread is running.
void	waitUntilStopped() Wait until the servers main thread stops.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwareServer

public SoftwareServer()

Class constructor.

SoftwareServer

public SoftwareServer(String filename)

Class constructor.

Parameters:

filename - the file name of a configuration file

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

getMaxOperationTime

public int getMaxOperationTime()

Get the maximum allowed operation time.

Returns:

the maximum allowed operation time

setCachePath

public void setCachePath(String path)

Set the cache path

Parameters:

path - the path to use

addScriptedOperations

public void addScriptedOperations(String path,
                         String extension)

Add operation scripts within the given directory. Script info will be looked up. Note: all scripts must follow the text header convention

Parameters:

path - the path to the scripts

extension - the script file extension (can be null indicating any extension)

addScriptedOperations

public void addScriptedOperations(String path,
                         String extension,
                         String comment_head)

Add operation scripts within the given directory. Note: all scripts must follow the text header convention

Parameters:

path - the path to the scripts

extension - the script file extension (can be null indicating any extension)

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

getPort

public int getPort()

Get the port the server is listening to.

Returns:

the port used

getCachePath

public String getCachePath()

Get the servers cache path.

Returns:

the servers cache path

getTempPath

public String getTempPath()

Get the servers temp path.

Returns:

the servers temp path

getSession

public int getSession()

Get a new session number.

Returns:

a session number

getApplications

public Vector<SoftwareServerAuxiliary.Application> getApplications()

Get the utilized applications.

Returns:

a list of applications being used

getTaskCount

public int getTaskCount()

Get the number of tasks received since starting up.

Returns:

the number of tasks recevied

getKillCount

public int getKillCount()

Get the number of times the kill operation has been used.

Returns:

the number of times the kill operation has been used

getCompletedTaskCount

public int getCompletedTaskCount()

Get the number of completed tasks.

Returns:

the number of completed tasks

executeTask

public String executeTask(String host,
                 int session,
                 Vector<SoftwareServerAuxiliary.Subtask> task)

Execute the given task.

Parameters:

host - the host requesting this task execution

session - the session id

task - a list of subtasks to execute

Returns:

the result (i.e. the last output file)

executeTaskAtomically

public String executeTaskAtomically(String host,
                           int session,
                           Vector<SoftwareServerAuxiliary.Subtask> task)

Execute the given task (synchronized version).

Parameters:

host - the host requesting this task execution

session - the session id

task - a list of subtasks to execute

Returns:

the result (i.e. the last output file)

isBusy

public boolean isBusy()

Is the server busy executing a task?

Returns:

true if the server is busy

run

public void run()

Process ICR requests.

Specified by:

run in interface Runnable

waitUntilRunning

public void waitUntilRunning()

Wait until the servers main thread is running.

serveConnection

public void serveConnection(int session,
                   Socket client_socket)

Process requests from the given connection.

Parameters:

session - the session id for this connection

client_socket - the connection to serve

resetCounts

public void resetCounts()

Reset task counters to zero.

rebootMachine

public void rebootMachine()

Reboot the machine the software server is running on.

waitUntilStopped

public void waitUntilStopped()

Wait until the servers main thread stops.

stop

public void stop()

Stop the Software Server.

getSession

public static int getSession(String filename)

Parse the session id from the cached filename.

Parameters:

filename - the cached filename

Returns:

the session id

getLastSession

public static int getLastSession(String path)

Get the last session, the highest number, based on the files in the given directory.

Parameters:

path - the directory to examine

Returns:

the last session number

getFilename

public static String getFilename(String filename)

Parse the filename from the cached filename.

Parameters:

filename - the cached filename

Returns:

the filename

main

public static void main(String[] args)

A main for the ICR service.

Parameters:

args - command line arguments