org.onlab.stc

Class Coordinator

java.lang.Object

org.onlab.stc.Coordinator

public class Coordinator
extends Object

Coordinates execution of a scenario process flow.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Coordinator.Directive Represents action to be taken on a test step.
static class	Coordinator.Status Represents processor state.

Constructor Summary

Constructors

Constructor and Description
Coordinator(Scenario scenario, ProcessFlow processFlow, File logDir) Creates a process flow coordinator.

Method Summary

Modifier and Type	Method and Description
void	addListener(StepProcessListener listener) Adds the specified listener.
long	duration() Returns number of milliseconds it took to execute.
Coordinator.Status	getStatus(Step step) Returns the status record of the specified test step.
Set<Step>	getSteps() Returns set of all test steps.
static void	print(String format, Object... args) Prints formatted output.
void	removeListener(StepProcessListener listener) Removes the specified listener.
void	reset() Resets any previously accrued status and events.
void	reset(List<String> runFromPatterns, List<String> runToPatterns) Resets all previously accrued status and events for steps that lie in the range between the steps or groups whose names match the specified patterns.
void	start() Starts execution of the process flow graph.
int	waitFor() Wants for completion of the entire process flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

Coordinator

public Coordinator(Scenario scenario,
                   ProcessFlow processFlow,
                   File logDir)

Creates a process flow coordinator.

Parameters:

scenario - test scenario to coordinate

processFlow - process flow to coordinate

logDir - scenario log directory

Method Detail

reset

public void reset()

Resets any previously accrued status and events.

reset

public void reset(List<String> runFromPatterns,
                  List<String> runToPatterns)

Resets all previously accrued status and events for steps that lie in the range between the steps or groups whose names match the specified patterns.

Parameters:

runFromPatterns - list of starting step patterns

runToPatterns - list of ending step patterns

duration

public long duration()

Returns number of milliseconds it took to execute.

Returns:

number of millis elapsed during the run

start

public void start()

Starts execution of the process flow graph.

waitFor

public int waitFor()
            throws InterruptedException

Wants for completion of the entire process flow.

Returns:

exit code to use

Throws:

InterruptedException - if interrupted while waiting for completion

getSteps

public Set<Step> getSteps()

Returns set of all test steps.

Returns:

set of steps

getStatus

public Coordinator.Status getStatus(Step step)

Returns the status record of the specified test step.

Parameters:

step - test step or group

Returns:

step status record

addListener

public void addListener(StepProcessListener listener)

Adds the specified listener.

Parameters:

listener - step process listener

removeListener

public void removeListener(StepProcessListener listener)

Removes the specified listener.

Parameters:

listener - step process listener

print

public static void print(String format,
                         Object... args)

Prints formatted output.

Parameters:

format - printf format string

args - arguments to be printed