jtr.runners
Interface IRunnerClean

All Known Subinterfaces:

IRunner, IRunnerJMS, IRunnerParameterized, IRunnerPooled, IRunnerWs

All Known Implementing Classes:

AbstractJMSRunner, AbstractRunner, AbstractRunnerAncestor, AbstractWsRunner, JUnitFacadeRunner

public interface IRunnerClean

This interface represents a runner in its CLEAN state.
This means that the runner has simply been created but not parameterized yet.
The next admitted state can only be PARAMETERIZED.

Since:

1.0

Version:

5.0

Author:

Francesco Russo (frusso@dev.java.net)

Method Summary

int	getCurrentRun() Tells which is the current run.
java.lang.String	getDefaultName() Get the JTR-assigned unique name of the current runner.
EnterpriseConfig	getEnterprise() Get the enterprise configuration associated with the current runner.
int	getEpoch() Get the current jtr-test epoch.
java.lang.String	getFqn() Obtains the runner FQN.
int	getInstanceCount() Get the number of instances that must be active, according to the jtr.xml, during the test-suite.
int	getInstanceID() Returns the associated instance ID.
java.lang.String	getName() Get the logical name of the current runner.
IOutcomeFactory	getOutcomeFactory() Get the factory in charge of instantiating IOutCome instances.
ParametersMap	getParameters() Get the paramters for the current runner.
IParamsAssigner	getParamsAssigner() Get the assigner in charge of performing the parameters injection into the current runner.
int	getRuns() Get the total number of runs this runner has to execute.
long	getSleepTime() Get the sleep time value assigned to the current runner.
IStatFunction	getStatFunction(java.lang.String paramName) Returns the reference to the IStatFunction implementation associated with the parameter named paramName, if present, otherwies null is returned.
TestOutcomeTable	getTestOutcomeTable() Get the TestOutcomeTable instance where the runner logs all the experienced error conditions.
void	setCurrentRun(int val) Tells which is the current run.
void	setEnterprise(EnterpriseConfig enterprise) Set the enterprise configuration associated with the current runner.
void	setEpoch(int epoch) Set the current jtr-test epoch.
void	setFqn(java.lang.String name) Assigns the runner its FQN.
void	setInstanceCount(int i) Set the number of instances that must be active, according to the jtr.xml, during the test-suite.
void	setInstanceID(int id) Associates the current runner with its instance ID.
void	setName(java.lang.String name) Set the logical name of the current runner.
void	setOutcomeFactory(IOutcomeFactory outcomeFactory) Set the factory in charge of instantiating IOutCome instances.
void	setParameters(ParametersMap params) Set the paramters for the current runner.
void	setParamsAssigner(IParamsAssigner paramsAssigner) Set the assigner in charge of performing the parameters injection into the current runner.
void	setRuns(int runs) Set the total number of runs this runner has to execute.
void	setSleepTime(long sleepTime) Set the sleep time value assigned to the current runner.
void	setStatFunction(java.lang.String paramName, IStatFunction f) Sets the reference to the IStatFunction implementation associated with the parameter named paramName.
void	setTestCompletionListener(ITestCompletionListener testComplLsnr) This method assigns an ITestCompletionListener instance to a runner in CLEAN state.
void	setTestOutcomeTable(TestOutcomeTable testOutcomeTable) Set the TestOutcomeTable instance where the runner logs all the experienced error conditions.

Method Detail

getStatFunction

IStatFunction getStatFunction(java.lang.String paramName)

Returns the reference to the IStatFunction implementation associated with the parameter named paramName, if present, otherwies null is returned.

Parameters:

paramName -

Returns:

setFqn

void setFqn(java.lang.String name)

Assigns the runner its FQN.

Parameters:

name - The FQN

getFqn

java.lang.String getFqn()

Obtains the runner FQN.

Returns:

The FQN

setName

void setName(java.lang.String name)

Set the logical name of the current runner.

Parameters:

name - String

getName

java.lang.String getName()

Get the logical name of the current runner.

Returns:

String

getDefaultName

java.lang.String getDefaultName()

Get the JTR-assigned unique name of the current runner.

Returns:

String

getEnterprise

EnterpriseConfig getEnterprise()

Get the enterprise configuration associated with the current runner.

Returns:

EnterpriseConfig

setEnterprise

void setEnterprise(EnterpriseConfig enterprise)

Set the enterprise configuration associated with the current runner.

Parameters:

enterprise - EnterpriseConfig

getRuns

int getRuns()

Get the total number of runs this runner has to execute.

Returns:

int

setRuns

void setRuns(int runs)

Set the total number of runs this runner has to execute.

Parameters:

runs - int

getSleepTime

long getSleepTime()

Get the sleep time value assigned to the current runner.

Returns:

long

setSleepTime

void setSleepTime(long sleepTime)

Set the sleep time value assigned to the current runner.

Parameters:

sleepTime - long

setParameters

void setParameters(ParametersMap params)

Set the paramters for the current runner.

Parameters:

params -

getParameters

ParametersMap getParameters()

Get the paramters for the current runner.

Returns:

ParametersMap

getParamsAssigner

IParamsAssigner getParamsAssigner()

Get the assigner in charge of performing the parameters injection into the current runner.

Returns:

IParamsAssigner

setParamsAssigner

void setParamsAssigner(IParamsAssigner paramsAssigner)

Set the assigner in charge of performing the parameters injection into the current runner.

Parameters:

paramsAssigner - IParamsAssigner

getTestOutcomeTable

TestOutcomeTable getTestOutcomeTable()

Get the TestOutcomeTable instance where the runner logs all the experienced error conditions.

Returns:

TestOutcomeTable

setStatFunction

void setStatFunction(java.lang.String paramName,
                     IStatFunction f)

Sets the reference to the IStatFunction implementation associated with the parameter named paramName.

Parameters:

paramName -

f -

setTestOutcomeTable

void setTestOutcomeTable(TestOutcomeTable testOutcomeTable)

Set the TestOutcomeTable instance where the runner logs all the experienced error conditions.

Parameters:

testOutcomeTable - TestOutcomeTable

getOutcomeFactory

IOutcomeFactory getOutcomeFactory()

Get the factory in charge of instantiating IOutCome instances.

Returns:

IOutcomeFactory

setOutcomeFactory

void setOutcomeFactory(IOutcomeFactory outcomeFactory)

Set the factory in charge of instantiating IOutCome instances.

Parameters:

outcomeFactory - IOutcomeFactory

setInstanceCount

void setInstanceCount(int i)

Set the number of instances that must be active, according to the jtr.xml, during the test-suite.

Parameters:

i - The number of instances

getInstanceCount

int getInstanceCount()

Get the number of instances that must be active, according to the jtr.xml, during the test-suite.

Returns:

The number of instances

setInstanceID

void setInstanceID(int id)

Associates the current runner with its instance ID. An instance ID is a counter that grows starting from zero an reaches the number of instances configured for its category (class) minus one.

Parameters:

id - The ID

getInstanceID

int getInstanceID()

Returns the associated instance ID.

Returns:

The instance ID

setCurrentRun

void setCurrentRun(int val)

Tells which is the current run. Values go starts from zero.

Parameters:

val - The current run

getCurrentRun

int getCurrentRun()

Tells which is the current run. Values go starts from zero.

Returns:

The current run

getEpoch

int getEpoch()

Get the current jtr-test epoch.

Returns:

int

setEpoch

void setEpoch(int epoch)

Set the current jtr-test epoch.

Parameters:

epoch - int

setTestCompletionListener

void setTestCompletionListener(ITestCompletionListener testComplLsnr)

This method assigns an ITestCompletionListener instance to a runner in CLEAN state. This assignment can be performed for just one time in a JTR test-session for each runner instance.
Note: it is legal for this instance to be always null for runner instances started on JTR passive-nodes.

Parameters:

testComplLsnr - The listener instance