org.jboss.dtf.testframework.coordinator2
Interface CoordinatorInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

Coordinator

public interface CoordinatorInterface
extends java.rmi.Remote

Method Summary

RunInformation[]	getCurrentRunInformation() Retrieve information about the current run in progress.
SchedulerInterface	getScheduler()
boolean	isBusy() Is this coordinator busy?
boolean	isRunInProgress(RunUID runId) Is this run in progress?
void	restart() Restart the coordinator
void	run(java.net.URL testDefsURL, java.net.URL testSelectionsURL, java.lang.String distributionList, java.lang.String softwareVersion, boolean waitToComplete) Start a test run.
void	shutdown() Shutdown the coordinator
boolean	stopRun(boolean waitForTestToComplete, RunUID runId) Stops the currently active run.

Method Detail

getScheduler

SchedulerInterface getScheduler()
                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

run

void run(java.net.URL testDefsURL,
         java.net.URL testSelectionsURL,
         java.lang.String distributionList,
         java.lang.String softwareVersion,
         boolean waitToComplete)
         throws java.rmi.RemoteException,
                CoordinatorBusyException,
                CannotStartRunException

Start a test run. The coordinator will run the tests defined in testDefsURL and selected within the testSelections file.

Parameters:

testDefsURL - A URL to the test definitions file.

testSelectionsURL - A URL to the test selections file.

distributionList - The email distribution list.

softwareVersion - The software version to log against.

Throws:

java.rmi.RemoteException

CoordinatorBusyException

CannotStartRunException

stopRun

boolean stopRun(boolean waitForTestToComplete,
                RunUID runId)
                throws CoordinatorIdleException,
                       java.rmi.RemoteException

Stops the currently active run.

Parameters:

waitForTestToComplete - If this parameter is true then the run will stop once the current test has finished. If false then the run will stop immediately.

Throws:

java.rmi.RemoteException

CoordinatorIdleException - If the coordinator isn't currently running any tests then this exception will be thrown.

getCurrentRunInformation

RunInformation[] getCurrentRunInformation()
                                          throws CoordinatorIdleException,
                                                 java.rmi.RemoteException

Retrieve information about the current run in progress.

Returns:

Throws:

java.rmi.RemoteException

CoordinatorIdleException - If the coordinator is not currently running any tests.

isBusy

boolean isBusy()
               throws java.rmi.RemoteException

Is this coordinator busy?

Returns:

True if the coordinator is busy

Throws:

java.rmi.RemoteException

isRunInProgress

boolean isRunInProgress(RunUID runId)
                        throws java.rmi.RemoteException

Is this run in progress?

Parameters:

runId -

Returns:

Throws:

java.rmi.RemoteException

restart

void restart()
             throws java.rmi.RemoteException

Restart the coordinator

Throws:

java.rmi.RemoteException

shutdown

void shutdown()
              throws java.rmi.RemoteException

Shutdown the coordinator

Throws:

java.rmi.RemoteException