IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.services
Interface ITestExecutionServices

All Known Subinterfaces:
ICondition, IContainer, IEngine, IFor, IIf, IKAction, IKChannel, IKLoadTestSchedule, IKTransaction, IKUserGroup, ILoop, IPacedLoop, IParallel, IWhile
All Known Implementing Classes:
com.ibm.rational.test.lt.kernel.action.impl.Container, com.ibm.rational.test.lt.kernel.action.impl.KAction, KCatchRPTEvent, com.ibm.rational.test.lt.kernel.action.impl.KContainer, com.ibm.rational.test.lt.kernel.action.impl.KScript, LTTestScript

public interface ITestExecutionServices

The ITestExecutionServices interface provides information for adding custom test execution features to tests. This interface replaces the IKLog interface. All the methods that were available in IKLog are contained in ITestExecutionServices, along with several newly exposed objects and interfaces. ITestExecutionServices is the primary interface for test execution services.

ITestExecutionServices provides a number of methods for use in ICustomCode2. Each of these methods returns an object that provides further services in that area.


Field Summary
static String STORAGE_LOCAL
           
static String STORAGE_USER
           
 
Method Summary
 IDataArea findDataArea(String name)
          Returns an IDataArea object for the named DataArea or null if no such DataArea exists.
 IARM getARM()
          Retuns an IARM object that exposes ARM (Application Response Measurement)-related methods.
 ILoopControl getLoopControl()
          Returns an ILoopControl object that provides methods for limited control of the nearest enclosing loop in a performance test or schedule.
 IPDLogManager getPDLogManager()
          Returns an IPDLogManager object that provides methods for writing messages into the problem determination log from custom code actions.
 IStatisticsManager getStatisticsManager()
          Returns an IStatisticsManager object that provides methods for creating and reporting statistical model counters.
 ITestLogManager getTestLogManager()
          Returns an ITestLogManager object that provides methods for writing events, such as messages and verification points, to the TestLog (execution history).
 ITime getTime()
          Returns an ITime object that provides basic time methods used to synchronize all the computers in a performance test run, and to record the test start and elapsed time.
 ITransaction getTransaction(String label)
          Asserts that an ITransaction object with the given label exists in the virtual tester's transaction collection and returns a reference to that transaction object.
 String getValue(String varname, String storageLocation)
          This method allows you to get the value of a variable, the variable name to be used is the same one that exists in the Test Variables section.
 void setValue(String varname, String storageLocation, String newValue)
          This method allows you to set the value of a variable, the variable name to be used is the same one that exists in the Test Variables section.
 

Field Detail

STORAGE_LOCAL

static final String STORAGE_LOCAL
See Also:
Constant Field Values

STORAGE_USER

static final String STORAGE_USER
See Also:
Constant Field Values
Method Detail

getARM

IARM getARM()
Retuns an IARM object that exposes ARM (Application Response Measurement)-related methods. These methods apply to virtual users that are being sampled for ARM processing.

Returns:
An IARM object that exposes ARM-related methods.

findDataArea

IDataArea findDataArea(String name)
Returns an IDataArea object for the named DataArea or null if no such DataArea exists. Three publicly accessible data areas are provided:

EnginData

Owned by the engine and contains objects that apply to the entire engine and persist for the duration of the test run.

VirtualUserData

Owned by the virtual user container and contains objects that persist for the life of the virtual user.

TestData

Owned by the KScript container (which all tests extend) and contains objects that persist for the duration of the individual test script.

Other DataAreas might be provided for specific protocols.

Parameters:
name -
Returns:
An IDataArea object for the named DataArea or null if no such DataArea exists.

getLoopControl

ILoopControl getLoopControl()
Returns an ILoopControl object that provides methods for limited control of the nearest enclosing loop in a performance test or schedule.

Returns:
An ILoopControl object that provides methods for limited control of the nearest enclosing loop.

getPDLogManager

IPDLogManager getPDLogManager()
Returns an IPDLogManager object that provides methods for writing messages into the problem determination log from custom code actions.

Returns:
An IPDLogManager object that provides methods for writing messages into the problem determination log.

getStatisticsManager

IStatisticsManager getStatisticsManager()
Returns an IStatisticsManager object that provides methods for creating and reporting statistical model counters. These counters can then be accessed through the performance test reports.

Returns:
An IStatisticsManager object that provides methods for creating and reporting statistical model counters.

getTestLogManager

ITestLogManager getTestLogManager()
Returns an ITestLogManager object that provides methods for writing events, such as messages and verification points, to the TestLog (execution history).

Returns:
An ITestLogManager object that provides methods for writing events to the TestLog (execution history).

getTime

ITime getTime()
Returns an ITime object that provides basic time methods used to synchronize all the computers in a performance test run, and to record the test start and elapsed time.

Returns:
An ITime object that provides basic time methods.

getTransaction

ITransaction getTransaction(String label)
Asserts that an ITransaction object with the given label exists in the virtual tester's transaction collection and returns a reference to that transaction object.

Parameters:
label -
Returns:
A reference to the ITransaction object with the given label in the virtual tester's transaction collection.

getValue

String getValue(String varname,
                String storageLocation)
This method allows you to get the value of a variable, the variable name to be used is the same one that exists in the Test Variables section. If the variable does not exist, null will be returned.

Parameters:
varname - - the name of the variable to get the value for
storageLocation - - the location to get the variable from, currently the only options are ITestExecutionServices.STORAGE_LOCAL and ITestExecutionServices.STORAGE_USER
Returns:
- the value of the variable

setValue

void setValue(String varname,
              String storageLocation,
              String newValue)
This method allows you to set the value of a variable, the variable name to be used is the same one that exists in the Test Variables section. If the variable does not exist, one will be created in the storage location specified and it will be set to the value provided.

Parameters:
varname - - the name of the variable to be set
storageLocation - - the location to store the variable, currently the options are ITestExecutionServices.STORAGE_LOCAL and ITestExecutionServices.STORAGE_USER
newValue -

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.