IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.runner
Interface IRatlRunner


public interface IRatlRunner


Field Summary
static String DEFAULT_HISTORY_CACHE_FILE
           
static int EXIT_WAIT
          default exit wait time
static String FORBIDDEN
          we can't run here
static int HEARTBEAT_INTERVAL
          default heartbeat interval (ms)
static int HEARTBEAT_MINIMUM
          default heartbeat minimum interval (ms)
static int HEARTBEAT_TIMEOUT
          default time allowed for an answer to a heartbeat (ms)
static String HEARTRATE
          set the heartbeat interval
static int KEEP_ALIVE_INTERVAL
          default keep alive interval (minutes)
static String REMOVE
          remove a virtual user
static String RPT_ANNOTATION_FILE_SIZE_LIMIT
          An integer (default Integer.MAX_VALUE) indicating the maximum size of an annotation file
static String RPT_AUTOLOAD_HISTORY
          The default value for RPT_LOAD_HISTORY above.
static String RPT_EXIT_WAIT
          An integer (default 30000) which specifies the how long after main() ends to call System.exit()
static String RPT_HEARTBEAT_PERIOD
          An integer (default 10000) which specifies the heartbeat delivery interval
static String RPT_HISTORY_CACHE_FILE
          A string (default "historyCache.tmp") which specifies the name of the history cache file relative to the deployment directory.
static String RPT_HISTORY_CACHE_LEVEL
          An integer (default 0 (NONE)) all events belonging to the specified (or higher) history level will be cached.
static String RPT_KEEP_ALIVE_INTERVAL
          An integer (default 15) which specifies the keep-alive delivery interval in minutes
static String RPT_LOAD_HISTORY
          A boolean (sortof) (default "auto") which indicates whether or not the cached execution history events should be given to the workbench loaders and put into the execution history model.
static String RPT_LOCALE
          A string (ie "en_US") which specifies the locale that you want for the runner process
static String RPT_REALTIME_HISTORY
          A string specifying the history events that should not be cached.
static String RPT_REPORT_NET_SERVER_TIME
          A boolean (default RPT_REPORT_NET_SERVER_TIME_DEFAULT) which specifies whether transactions should use the value provided by calls to "TESUtil.addNetServerTime()" in addition to actual elapsed time for the container.
static String RPT_REPORT_NET_SERVER_TIME_DEFAULT
           
static String RPT_RUNNER_ECHO
          A boolean (default false) which specifies whether the runner echo's incomming command messages
static String RPT_RUNNER_HEARTBEAT_TIMEOUT
          The number of milliseconds (default 60000) that the runner is willing to continue without receiving any communication from the workbench.
static String RPT_RUNNER_PDLOG_LEVEL
          The PDLog level the runner will use until the value specified in the schedule is sent.
static String RPT_SAVE_TEMP_FILES
          A boolean (default false) which indicates whether or not the history cache and annotation temp files should be kept after the run.
static String RPT_SERIALTESTLOG
          A boolean(default true) which indicates whether or not the runner should wait for instruction from the workbench before transferring the testLog data
static String RPT_STATISTICS_FILE
          A string (for debugging) which specifies a file on the local computer where all statistics xml fragments should be written in addition to sending to the workbench.
static String RPT_STATISTICS_PERIOD
          An integer (default 5000) which specifies the statistics delivery interval in the event that the workbench fails to specify one.
static String RPT_TESTLOG_FILE
          A string (for debugging) which specifies a file on the local computer where all testLog xml fragments should be written in addition to sending to the workbench.
static String RPT_TESTLOG_MONITOR
          An integer which specifies the interval (in seconds) that the testLog queue monitor should use to poll the status of the queues related to testLog processing.
static String RPT_USE_COMMAND_EVENT
          A boolean (default true) which specifies whether the runner should attempt using the testLog data channel to deliver select commands to the workbench
static String RPT_USE_HISTORY
          A boolean (default true) which indicates whether or not a history managing thread should be created.
static String RPT_USE_HISTORY_ANNOTATION
          A boolean (default true) which indicates whether or not an annotation managing thread and file should be created.
static String RPT_USE_HISTORY_CACHE
          A boolean (default true) which indicates whether or not a cache managing thread should be created.
static String RPT_USE_STATISTICS
          A boolean (default true) which indicates whether or not a statistics managing thread should be created.
static int STOP_EASY
          default timeout for STOP command (ms)
static int STOP_HARD
          timeout value for an immediate stop
 
Method Summary
 void executeCustomCommand(String s)
          Introduce visibility to executeCustomCommand for AC-less test execution.
 void log(String s)
           
 void log(Throwable t)
           
 void reportException(Throwable t)
           
 void requestHeartBeat()
          request that the runner send a heartbeat (USERSTATES) message to the workbench
 void sendArrival(String syncPointName)
           
 void sendStop(String userGroup)
           
 String status()
           
 

Field Detail

DEFAULT_HISTORY_CACHE_FILE

static final String DEFAULT_HISTORY_CACHE_FILE
See Also:
Constant Field Values

RPT_RUNNER_PDLOG_LEVEL

static final String RPT_RUNNER_PDLOG_LEVEL
The PDLog level the runner will use until the value specified in the schedule is sent.

See Also:
Constant Field Values

RPT_RUNNER_HEARTBEAT_TIMEOUT

static final String RPT_RUNNER_HEARTBEAT_TIMEOUT
The number of milliseconds (default 60000) that the runner is willing to continue without receiving any communication from the workbench.

See Also:
Constant Field Values

RPT_SAVE_TEMP_FILES

static final String RPT_SAVE_TEMP_FILES
A boolean (default false) which indicates whether or not the history cache and annotation temp files should be kept after the run.

See Also:
Constant Field Values

RPT_USE_STATISTICS

static final String RPT_USE_STATISTICS
A boolean (default true) which indicates whether or not a statistics managing thread should be created.

See Also:
Constant Field Values

RPT_USE_HISTORY

static final String RPT_USE_HISTORY
A boolean (default true) which indicates whether or not a history managing thread should be created.

See Also:
Constant Field Values

RPT_USE_HISTORY_CACHE

static final String RPT_USE_HISTORY_CACHE
A boolean (default true) which indicates whether or not a cache managing thread should be created. If false, nothing will be cached.

See Also:
Constant Field Values

RPT_HISTORY_CACHE_FILE

static final String RPT_HISTORY_CACHE_FILE
A string (default "historyCache.tmp") which specifies the name of the history cache file relative to the deployment directory.

See Also:
Constant Field Values

RPT_HISTORY_CACHE_LEVEL

static final String RPT_HISTORY_CACHE_LEVEL
An integer (default 0 (NONE)) all events belonging to the specified (or higher) history level will be cached. Meaningful range: [0-100] in 6.1.2 ([0-4] in 6.1.1).

See Also:
Constant Field Values

RPT_REALTIME_HISTORY

static final String RPT_REALTIME_HISTORY
A string specifying the history events that should not be cached. For compatibility with 6.0 (or whatever the number for the first release was) Possible values: SCHEDULE, NONE, ALL

See Also:
Constant Field Values

RPT_USE_HISTORY_ANNOTATION

static final String RPT_USE_HISTORY_ANNOTATION
A boolean (default true) which indicates whether or not an annotation managing thread and file should be created. (The file name is supplied by the WB.)

See Also:
Constant Field Values

RPT_ANNOTATION_FILE_SIZE_LIMIT

static final String RPT_ANNOTATION_FILE_SIZE_LIMIT
An integer (default Integer.MAX_VALUE) indicating the maximum size of an annotation file

See Also:
Constant Field Values

RPT_LOAD_HISTORY

static final String RPT_LOAD_HISTORY
A boolean (sortof) (default "auto") which indicates whether or not the cached execution history events should be given to the workbench loaders and put into the execution history model. A special value of "auto" (or "AUTO") indicates that the decision will be left up to the workbench based on the size of the cache file and the available workbench memory.

See Also:
Constant Field Values

RPT_AUTOLOAD_HISTORY

static final String RPT_AUTOLOAD_HISTORY
The default value for RPT_LOAD_HISTORY above. This indicates that the amount of memory available on the workbench will determine whether or not to load the cached events.

See Also:
Constant Field Values

RPT_STATISTICS_FILE

static final String RPT_STATISTICS_FILE
A string (for debugging) which specifies a file on the local computer where all statistics xml fragments should be written in addition to sending to the workbench.

See Also:
Constant Field Values

RPT_TESTLOG_FILE

static final String RPT_TESTLOG_FILE
A string (for debugging) which specifies a file on the local computer where all testLog xml fragments should be written in addition to sending to the workbench.

See Also:
Constant Field Values

RPT_STATISTICS_PERIOD

static final String RPT_STATISTICS_PERIOD
An integer (default 5000) which specifies the statistics delivery interval in the event that the workbench fails to specify one.

See Also:
Constant Field Values

RPT_SERIALTESTLOG

static final String RPT_SERIALTESTLOG
A boolean(default true) which indicates whether or not the runner should wait for instruction from the workbench before transferring the testLog data

See Also:
Constant Field Values

RPT_TESTLOG_MONITOR

static final String RPT_TESTLOG_MONITOR
An integer which specifies the interval (in seconds) that the testLog queue monitor should use to poll the status of the queues related to testLog processing. If this property is not set or the value is <= 0 the testLog monitor thread will not be started.

See Also:
Constant Field Values

RPT_HEARTBEAT_PERIOD

static final String RPT_HEARTBEAT_PERIOD
An integer (default 10000) which specifies the heartbeat delivery interval

See Also:
Constant Field Values

RPT_RUNNER_ECHO

static final String RPT_RUNNER_ECHO
A boolean (default false) which specifies whether the runner echo's incomming command messages

See Also:
Constant Field Values

RPT_USE_COMMAND_EVENT

static final String RPT_USE_COMMAND_EVENT
A boolean (default true) which specifies whether the runner should attempt using the testLog data channel to deliver select commands to the workbench

See Also:
Constant Field Values

RPT_EXIT_WAIT

static final String RPT_EXIT_WAIT
An integer (default 30000) which specifies the how long after main() ends to call System.exit()

See Also:
Constant Field Values

RPT_LOCALE

static final String RPT_LOCALE
A string (ie "en_US") which specifies the locale that you want for the runner process

See Also:
Constant Field Values

RPT_KEEP_ALIVE_INTERVAL

static final String RPT_KEEP_ALIVE_INTERVAL
An integer (default 15) which specifies the keep-alive delivery interval in minutes

See Also:
Constant Field Values

RPT_REPORT_NET_SERVER_TIME

static final String RPT_REPORT_NET_SERVER_TIME
A boolean (default RPT_REPORT_NET_SERVER_TIME_DEFAULT) which specifies whether transactions should use the value provided by calls to "TESUtil.addNetServerTime()" in addition to actual elapsed time for the container.

See Also:
Constant Field Values

RPT_REPORT_NET_SERVER_TIME_DEFAULT

static final String RPT_REPORT_NET_SERVER_TIME_DEFAULT
See Also:
Constant Field Values

HEARTBEAT_INTERVAL

static final int HEARTBEAT_INTERVAL
default heartbeat interval (ms)

See Also:
Constant Field Values

HEARTBEAT_MINIMUM

static final int HEARTBEAT_MINIMUM
default heartbeat minimum interval (ms)

See Also:
Constant Field Values

HEARTBEAT_TIMEOUT

static final int HEARTBEAT_TIMEOUT
default time allowed for an answer to a heartbeat (ms)

See Also:
Constant Field Values

STOP_EASY

static final int STOP_EASY
default timeout for STOP command (ms)

See Also:
Constant Field Values

STOP_HARD

static final int STOP_HARD
timeout value for an immediate stop

See Also:
Constant Field Values

EXIT_WAIT

static final int EXIT_WAIT
default exit wait time

See Also:
Constant Field Values

KEEP_ALIVE_INTERVAL

static final int KEEP_ALIVE_INTERVAL
default keep alive interval (minutes)

See Also:
Constant Field Values

HEARTRATE

static final String HEARTRATE
set the heartbeat interval

See Also:
Constant Field Values

REMOVE

static final String REMOVE
remove a virtual user

See Also:
Constant Field Values

FORBIDDEN

static final String FORBIDDEN
we can't run here

See Also:
Constant Field Values
Method Detail

sendArrival

void sendArrival(String syncPointName)

sendStop

void sendStop(String userGroup)

requestHeartBeat

void requestHeartBeat()
request that the runner send a heartbeat (USERSTATES) message to the workbench


executeCustomCommand

void executeCustomCommand(String s)
Introduce visibility to executeCustomCommand for AC-less test execution. Allows CommandProcessor to hold reference to IRatlRunner instead of concreate RPTRunner.


status

String status()

reportException

void reportException(Throwable t)

log

void log(String s)

log

void log(Throwable t)

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.