edu.illinois.ncsa.isda.softwareserver

Class SoftwareServerClient

java.lang.Object

edu.illinois.ncsa.isda.softwareserver.SoftwareServerClient

All Implemented Interfaces:

Comparable

public class SoftwareServerClient
extends Object
implements Comparable

A Software Server client interface.

Author:

Kenton McHenry

Constructor Summary

Constructors

Constructor and Description
SoftwareServerClient(SoftwareServerClient icr) Class copy constructor.
SoftwareServerClient(String server, int port) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the connection to the software server.
int	compareTo(Object object) Compare to another object.
static void	debug(SoftwareServerClient icr) Debug tests for a SoftwareReuseClient.
int	executeTasks(Vector<SoftwareServerAuxiliary.Subtask> task) Execute task on the software reuse server.
kgm.utility.AsynchronousObject<Integer>	executeTasksLater(Vector<SoftwareServerAuxiliary.Subtask> task) Asynchronously execute a task on the software reuse server.
Vector<SoftwareServerAuxiliary.Application>	getApplications() Get the list of applications available on the software reuse server.
int	getPort() Get the port this client is connect to.
String	getServer() Get the server this client is connected to.
String	getStatus() Get the status of the software reuse server.
boolean	isAlive() Check if connection is alive.
boolean	isBusy() Check if the software reuse server is busy executing another task.
static void	main(String[] args) Startup a software reuse client command prompt.
void	requestNewSession() Request a new session.
SoftwareServerAuxiliary.FileData	retrieveData(SoftwareServerAuxiliary.CachedFileData cached_file_data) Retrieve cached file data from the software reuse server.
kgm.utility.AsynchronousObject<SoftwareServerAuxiliary.FileData>	retrieveDataLater(SoftwareServerAuxiliary.CachedFileData cached_file_data) Synchronously retrieve cached file data from the server.
SoftwareServerAuxiliary.CachedFileData	sendData(SoftwareServerAuxiliary.FileData file_data) Send file data to the software reuse server.
kgm.utility.AsynchronousObject<SoftwareServerAuxiliary.CachedFileData>	sendDataLater(SoftwareServerAuxiliary.FileData file_data) Asynchronously send file data to the server.
String	toString() Return a string representation of this object.
void	waitOnPending() Wait for all pending asynchronous calls to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwareServerClient

public SoftwareServerClient(String server,
                    int port)

Class constructor.

Parameters:

server - the name of the software reuse server

port - the port used for the connection

SoftwareServerClient

public SoftwareServerClient(SoftwareServerClient icr)

Class copy constructor.

Parameters:

icr - an software reuse client session to copy

Method Detail

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class Object

Returns:

a string representation of this object

getServer

public String getServer()

Get the server this client is connected to.

Returns:

the software reuse server

getPort

public int getPort()

Get the port this client is connect to.

Returns:

the software reuse server port number

getStatus

public String getStatus()

Get the status of the software reuse server.

Returns:

the status of the software reuse server

getApplications

public Vector<SoftwareServerAuxiliary.Application> getApplications()

Get the list of applications available on the software reuse server.

Returns:

the available applications/operations

sendData

public SoftwareServerAuxiliary.CachedFileData sendData(SoftwareServerAuxiliary.FileData file_data)

Send file data to the software reuse server.

Parameters:

file_data - the file data to send

Returns:

a cached version of the given file data (i.e. a pointer to the data on the server)

sendDataLater

public kgm.utility.AsynchronousObject<SoftwareServerAuxiliary.CachedFileData> sendDataLater(SoftwareServerAuxiliary.FileData file_data)

Asynchronously send file data to the server.

Parameters:

file_data - the file data to send

Returns:

a cached version of the given file data (i.e. a pointer to the data on the server)

retrieveData

public SoftwareServerAuxiliary.FileData retrieveData(SoftwareServerAuxiliary.CachedFileData cached_file_data)

Retrieve cached file data from the software reuse server.

Parameters:

cached_file_data - the cached file data to retrieve

Returns:

the actual file data from the server

retrieveDataLater

public kgm.utility.AsynchronousObject<SoftwareServerAuxiliary.FileData> retrieveDataLater(SoftwareServerAuxiliary.CachedFileData cached_file_data)

Synchronously retrieve cached file data from the server.

Parameters:

cached_file_data - the cached file data to retrieve

Returns:

the file data

executeTasks

public int executeTasks(Vector<SoftwareServerAuxiliary.Subtask> task)

Execute task on the software reuse server.

Parameters:

task - a list of subtasks to execute (note, all input file data should be cached already!)

Returns:

server response (0=success)

executeTasksLater

public kgm.utility.AsynchronousObject<Integer> executeTasksLater(Vector<SoftwareServerAuxiliary.Subtask> task)

Asynchronously execute a task on the software reuse server.

Parameters:

task - a list of subtasks to execute (note, all input file data should be cached already!)

Returns:

status, 0=success

requestNewSession

public void requestNewSession()

Request a new session.

isBusy

public boolean isBusy()

Check if the software reuse server is busy executing another task.

Returns:

true if the software reuse server is currently busy

isAlive

public boolean isAlive()

Check if connection is alive.

Returns:

true if currently connected

waitOnPending

public void waitOnPending()

Wait for all pending asynchronous calls to complete.

close

public void close()

Close the connection to the software server.

compareTo

public int compareTo(Object object)

Compare to another object.

Specified by:

compareTo in interface Comparable

Parameters:

object - the object to compare to

Returns:

0 if equal, -1 otherwise

debug

public static void debug(SoftwareServerClient icr)

Debug tests for a SoftwareReuseClient.

Parameters:

icr - a software reuse client

main

public static void main(String[] args)

Startup a software reuse client command prompt.

Parameters:

args - command line arguments