|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEngine
Interfaces for Test Execution.
Field Summary |
---|
Fields inherited from interface com.ibm.rational.test.lt.kernel.action.IKAction |
---|
ABANDONED, DP_ENCRYPTED_VALUES_KEY, EXECUTING, FINISHED, HANDLETIMER, SEMWAIT, SLEEPING, Status, UNSTARTED |
Fields inherited from interface com.ibm.rational.test.lt.kernel.logging.IKLog |
---|
HISTORY_ALL, HISTORY_NONE, HISTORY_PAGES, HISTORY_REQUESTS, HISTORY_SCHEDULE, LOG_ALL, LOG_CONFIG, LOG_FINE, LOG_FINER, LOG_FINEST, LOG_INFO, LOG_NONE, LOG_SEVERE, LOG_WARNING, STATISTIC_ALL, STATISTIC_NONE, STATISTIC_PAGES |
Fields inherited from interface com.ibm.rational.test.lt.kernel.services.ITestExecutionServices |
---|
STORAGE_LOCAL, STORAGE_USER |
Method Summary | |
---|---|
void |
addDatapool(String datapoolName,
int datapoolOffset,
int datapoolNumberOfRows)
Deprecated. |
void |
addSyncPoint(String name,
int timeout,
boolean releaseTogether,
int togetherDwell,
int staggerMinDwell,
int staggerMaxDwell,
int expected,
boolean autoRelease,
IStatTree runStat)
Engine Sync Point Management. |
boolean |
addUsers(String userGroupName,
int numUsers,
int startingUserNum,
int startingGlobalNum)
Add virtual users. |
void |
createWorker()
Create a new Engine Worker and worker thread. |
boolean |
engineStopped()
Deprecated. |
void |
executeTest(String scriptName,
int numUsers)
Execute test. |
Map |
getDatapoolMap()
Deprecated. |
String |
getDeploymentDirectory()
Deprecated. |
String |
getDriverName()
Deprecated. |
IEngineInfo |
getEngineInfo()
container for various bits of info |
Object |
getEngineShutdownLock()
Engine shutdown lock. |
IRatlRunner |
getRunner()
|
com.ibm.rational.test.lt.kernel.action.impl.Schedule |
getSchedule()
Executing schedule container. |
String |
getStatus()
Engine status. |
int |
getStopReason()
|
int |
getTotalMemory()
Deprecated. |
int |
getVirtualUsersActive()
Deprecated. |
boolean |
initializeFinalize(String extPt,
String feature,
String className)
Engine InitializeFinalize runnable for Engine and Worker. |
boolean |
isScheduleRun()
Deprecated. |
boolean |
loadSchedule(String scheduleName)
Load a schedule for execution. |
void |
releaseSyncPoint(String name,
long releaseTime)
|
void |
runUntilFinish(IKAction action)
Dispatch next action and wait for specific action finish. |
void |
runUntilStarted(IKAction action)
Dispatch next action and wait for specific action start. |
boolean |
runUsers()
Run virtual users. |
boolean |
runUsers(int staggerDelay)
Run virtual users. |
boolean |
runUsers(String UGName,
com.ibm.rational.test.lt.kernel.impl.KStaggerPair[] stagger)
Run virtual users. |
void |
setDeploymentDirectory(String dir)
Deprecated. |
void |
setDriverName(String name)
Deprecated. |
void |
setHistoryLevel(int testLogLevel)
Set Engine testLog level. |
void |
setHistoryLevel(int testLogLevel,
int filter)
Set Engine testLog level for the given filter. |
void |
setLogLevel(int logLevel)
Set Engine log level. |
void |
setManualStop(boolean b)
Stop engine manually. |
void |
setRunner(IRatlRunner runner)
Suitable runner for communication with schedule controller. |
void |
setScheduleRunFlag(boolean flag)
Deprecated. |
void |
setStatisticsLevel(int statisticsLevel)
Set Engine statistics level. |
void |
setStopReason(int r)
|
boolean |
setUserLevels(String userGroupName,
int numLoggingUsers,
int numHistoryUsers,
int numStatsUsers)
Deprecated. |
boolean |
setUserLevels(String userGroupName,
int numLoggingUsers,
int numHistoryUsers,
int numStatsUsers,
int numARMUsers)
Set virtual user levels. |
void |
setWorkBenchHostName(String userId)
Deprecated. |
void |
setWorkBenchUserId(String userId)
Deprecated. |
void |
stop()
Stop the engine. |
Methods inherited from interface com.ibm.rational.test.lt.kernel.action.IContainer |
---|
add, addCatch, addFinally, addInitially, current, finish, get, getActions, getActionsArray, getChildCount, getParentHistoryId, getStartEvent, getStartHistoryId, getStopEvent, getUserGroup, getVirtualUser, isAllowChildrenToPageTestLog, next, nextHistoryId, previous, recordChildExecutionTime, registerChildVerdict, registerChildVerdict, registerChildVerdict, registerChildVerdict, remove, rollUpVerdicts, setAllowChildrenToPageTestLog, setStartHistoryId, stopChildren, verifyParentRelationships |
Methods inherited from interface com.ibm.rational.test.lt.kernel.action.IKAction |
---|
abandon, addEventBehavior, blocked, execute, executeAction, executionTime, findDataArea, finish, getBlockedTimeout, getHistory, getHistoryType, getId, getName, getParent, getResultInteger, getResultObject, getResultString, getRtbEnabled, getStatTree, getStopRequested, getSubsystem, getTimeoutDuration, getTimeoutScheme, getVirtualUserName, getWorkerThread, hasFinished, hasStarted, isRunning, reset, setBlockedTimeout, setDispatchingAction, setHistory, setHistoryType, setId, setResultInteger, setResultObject, setResultString, setResultString, setRtbEnabled, setStatTree, start, status, stop, stopAction |
Methods inherited from interface com.ibm.rational.test.lt.kernel.ICountable |
---|
addCounter, getCounter, getCounters, resetCounters |
Methods inherited from interface com.ibm.rational.test.lt.kernel.logging.IKLog |
---|
getHistoryLevel, getHistoryLevel, getLogLevel, getStatisticsLevel, getVirtualUserGUID, log, log, log, log, reportEvent, reportEvent, reportEvent, reportMessage, reportMessage, reportMessage, reportVerdict, reportVerdict, reportVerdict, reportVerdict, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, reportVerificationPoint, wouldARM, wouldLog, wouldReportHistory, wouldReportHistory, wouldReportStatistics |
Methods inherited from interface com.ibm.rational.test.lt.kernel.action.IKSemaphore |
---|
acquire, availablePermits, getQueue, getQueueLength, reducePermits, release, release, toString, tryAcquire, tryAcquire |
Methods inherited from interface com.ibm.rational.test.lt.kernel.services.ITestExecutionServices |
---|
getARM, getLoopControl, getPDLogManager, getStatisticsManager, getTestLogManager, getTime, getTransaction, getValue, setValue |
Methods inherited from interface java.lang.Runnable |
---|
run |
Method Detail |
---|
void runUntilFinish(IKAction action)
Starts execution of next action added. Returns when specified action finishes.
action
- Wait for this action to finish executing.void runUntilStarted(IKAction action)
Starts execution of next action added. Returns when specified action has begun execution.
action
- Wait for this action to get started.void setManualStop(boolean b)
Engine normally finishes when last child finishes. Specifying
manual stop allows engine to remain active until stopped by
explicit call to stop
.
b
- true
to turn on manual stop
false
to turn off manual stopvoid stop()
Stops the engine, waiting for engine shutdown before returning. Engine will stop hard in 30 seconds if executing actions do not respond to request to stop.
stop
in interface IKAction
IKAction.hasStarted()
,
IKAction.hasFinished()
,
IKAction.isRunning()
,
IKAction.start()
,
IKAction.finish()
boolean loadSchedule(String scheduleName)
Dynamically loads schedule specified by class name.
scheduleName
- The schedule class name.
true
if the schedule load succeeded.boolean addUsers(String userGroupName, int numUsers, int startingUserNum, int startingGlobalNum)
Dynamically creates new virtual users based on workload defined by the UserGroup.
userGroupName
- The UserGroup name.numUsers
- The number of users to add.startingUserNum
- The starting user number for this UserGroup.startingGlobalNum
- The starting user global number spanning agents.
true
if the users were added.boolean runUsers(int staggerDelay)
Starts execution of virtual users added to the engine.
staggerDelay
- A delay value, specified in milliseconds, between starting users.
true
if the users are all running.boolean runUsers()
Starts execution of virtual users added to the engine with a default stagger delay of 10 milliseconds.
true
if the users are all running.boolean runUsers(String UGName, com.ibm.rational.test.lt.kernel.impl.KStaggerPair[] stagger)
Starts execution of virtual users added to the engine.
UGName
- UserGroup name.stagger
- Array of startup sequences made up of two integers. First
integer is the number of users to start. Second integer
is a delay value in milliseconds to wait before starting each user.
true
if the users are all running.com.ibm.rational.test.lt.kernel.action.impl.Schedule getSchedule()
Return the executing schedule.
void setDeploymentDirectory(String dir)
dir
- The deployed assets directory name.String getDeploymentDirectory()
void addDatapool(String datapoolName, int datapoolOffset, int datapoolNumberOfRows)
Add a segmented datapool to the engine. Segmented datapools allow one datapool to be shared across multiple engines (drivers). Each engine should be told its starting row number and the number of rows from the datapool it is allowed to consume.
datapoolName
- The datapool name.datapoolOffset
- Row offset for this engine.datapoolNumberOfRows
- Number of rows this engine may use from the datapool starting from offset
.Map getDatapoolMap()
boolean engineStopped()
boolean setUserLevels(String userGroupName, int numLoggingUsers, int numHistoryUsers, int numStatsUsers)
Specify how many users in a UserGroup participate as loggers, history users, statistics reporting users.
userGroupName
- The UserGroup name.numLoggingUsers
- The number of logging users.numHistoryUsers
- The number of history users.numStatsUsers
- The number of statistics users.
true
if the levels set succesfully
false
if the levels set failedboolean setUserLevels(String userGroupName, int numLoggingUsers, int numHistoryUsers, int numStatsUsers, int numARMUsers)
Specify how many users in a UserGroup participate as loggers, history users, statistics reporting users.
userGroupName
- The UserGroup name.numLoggingUsers
- The number of logging users.numHistoryUsers
- The number of history users.numStatsUsers
- The number of history users.numARMUsers
- The number of statistics users.
true
if the levels set succesfully
false
if the levels set failedvoid executeTest(String scriptName, int numUsers)
scriptName
- Test name.numUsers
- Number of virtual users.Object getEngineShutdownLock()
Returns an object that allows for synchronization on engine shutdown.
void setLogLevel(int logLevel)
Specify a logging level for the engine.
logLevel
- Log level.void setHistoryLevel(int testLogLevel)
Specify a testLog level for the engine.
testLogLevel
- TestLog level.void setHistoryLevel(int testLogLevel, int filter)
Specify a testLog level for the given filter for the engine.
testLogLevel
- TestLog level.filter
- which filter to set.void setStatisticsLevel(int statisticsLevel)
Specify a statistics level for the engine.
statisticsLevel
- Statistics level.void setWorkBenchUserId(String userId)
Allow specification of the username of the person running the test.
userId
- The user id.void setWorkBenchHostName(String userId)
Allow specification of the host directing the test.
userId
- The host name.void setDriverName(String name)
name
- The driver host name.String getDriverName()
int getTotalMemory()
int getVirtualUsersActive()
String getStatus()
void setScheduleRunFlag(boolean flag)
flag
- true
if running schedule.
false
if running test.boolean isScheduleRun()
true
if running schedule.
false
if running test.void createWorker()
boolean initializeFinalize(String extPt, String feature, String className)
void addSyncPoint(String name, int timeout, boolean releaseTogether, int togetherDwell, int staggerMinDwell, int staggerMaxDwell, int expected, boolean autoRelease, IStatTree runStat)
void releaseSyncPoint(String name, long releaseTime)
void setRunner(IRatlRunner runner)
runner
- IRatlRunner getRunner()
IEngineInfo getEngineInfo()
int getStopReason()
void setStopReason(int r)
|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |