AbstractJavaTest

java.lang.Object
- java.lang.Thread
- - com.dkfqs.tools.javatest.AbstractJavaTest

All Implemented Interfaces:

java.lang.Runnable
```
public abstract class AbstractJavaTest
extends java.lang.Thread
```
An abstract class for a test program which supports the 'DKFQS All Purpose Interface Type 1'.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AbstractJavaTest.ResourceFiles` Additional files which are required to execute the test program, such as jar-files and input-files.

Nested classes/interfaces inherited from class java.lang.Thread
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ABORT_TESTJOB_FILE_NAME` The existence of this file in the data output directory effects that the test is aborted.
`static int`	`ENCODE_ALGORITHM_DECODE` Decode percent-encoded variable value.
`static int`	`ENCODE_ALGORITHM_ENCODE` Encode variable value with percent-encoding algorithm.
`static int`	`ENCODE_ALGORITHM_NONE` No encoding or decoding of variable value (unchanged / keep it as is).
`static java.lang.String`	`ERROR_SEVERITY_ERROR` Error severity 'error': After the error has occurred then the simulated aborts the execution of the current session loop and starts the execution of the next session loop.
`static java.lang.String`	`ERROR_SEVERITY_FATAL` Error severity 'fatal': After the error has occurred then the simulated user aborts any further execution of the test, which means that the test has ended for this simulated user.
`static java.lang.String`	`ERROR_SEVERITY_WARNING` Error severity 'warning': After the error has occurred then the simulated user continues with the execution of the current session loop.
`static int`	`LOG_DEBUG` Debug log level.
`static int`	`LOG_ERROR` Error log level.
`static int`	`LOG_FATAL` Fatal log level - System.exit(1) may be called later.
`static int`	`LOG_INFO` Info log level.
`static int`	`LOG_TRACE` Trace log level.
`static int`	`LOG_WARN` Waring log level.
`static int`	`SESSION_STATUS_END_OF_TEST` Session status end of test: The execution of the session has failed and further execution of all users is stopped.
`static int`	`SESSION_STATUS_END_OF_USER` Session status end of user: The execution of the session has failed and further execution of the user is stopped.
`static int`	`SESSION_STATUS_FAILED` Session status failed: The execution of the session has failed, but the user continues to execute the next session.
`static int`	`SESSION_STATUS_SUCCESS` Session status success: The execution of user session was successful.
`static java.lang.String`	`STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE` An average and current value.
`static java.lang.String`	`STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG` A cumulative long counter.
`static java.lang.String`	`STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT` An efficiency ratio percent value.
`static java.lang.String`	`STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART` A chart with samples of event timestamp and (measured) long value..
`static java.lang.String`	`STATISTIC_TYPE_THROUGHPUT_TIME_CHART` A chart of a throughput per second.
`static StdoutLogAdapter`	`stdoutLog` The stdout log adapter.
`static java.lang.String`	`SUSPEND_TESTJOB_FILE_NAME` The existence of this file in the data output directory effects that the test is suspended.
`static java.util.HashSet<java.lang.Integer>`	`VALID_ENCODE_ALGORITHM_SET` A set of all valid encode algorithms for variable values.
`static java.util.HashSet<java.lang.Integer>`	`VALID_SESSION_STATUS_SET` A set of all valid session statuses.

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description

AbstractJavaTest(int userNumber)
Constructor: Create a new instance.

Constructors
Constructor and Description
`AbstractJavaTest(int userNumber)` Constructor: Create a new instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`abstractMain(java.lang.String[] args)` Static Main: Get all generic arguments passed from the command line of the main program.
`void`	`addAverageDeltaAndCurrentValue(long statisticId, long sumValuesDelta, long numValuesDelta, long currentValue, long currentValueTimestamp)` All Purpose Interface: Add delta values to the average and set the current value for a 'average-and-current-value' statistic.
`void`	`addCounterLong(long statisticId, long value)` All Purpose Interface: Increment the counter of a declared 'cumulative-counter-long' statistic.
`void`	`addEfficiencyRatioDelta(long statisticId, long efficiencyDeltaValue, long inefficiencyDeltaValue)` All Purpose Interface: Add efficiency ratio delta values to a 'efficiency-ratio-percent' statistic.
`void`	`addSampleError(long statisticId, java.lang.String errorSubject, java.lang.String errorSeverity, java.lang.String errorType, java.lang.String errorLog, java.lang.String errorContext)` All Purpose Interface: Add an error to a declared statistic (for example when measuring a data sample did fail).
`void`	`addSampleLong(long statisticId, long value)` All Purpose Interface: Add a measured long value to a statistic.
`static void`	`addSimulatedUser(AbstractJavaTest abstractJavaTestInstance)` Add an instance of a simulated user.
`int`	`addTestResultAnnotationExecEvent(java.lang.String eventText)` All Purpose Interface: Add an execution annotation event to the test result.
`void`	`addThroughputDelta(long statisticId, double deltaValue)` All Purpose Interface: Add a measured delta value to a throughput statistic.
`void`	`declareStatistic(long statisticId, java.lang.String statisticType, java.lang.String statisticTitle, java.lang.String statisticSubtitle, java.lang.String yAxisTitle, java.lang.String unitText, int sortPosition, boolean addToSummaryStatistic, java.lang.String backgroundColor)` All Purpose Interface: Declare a new statistic.
`abstract void`	`declareStatistics()` Declare all statistics which are known to be measured.
`abstract void`	`executeUserEnd(int userNumber)` Called when the user has ended.
`abstract int`	`executeUserSession(int userNumber, int sessionLoopNumber)` Invoked when the user is supposed to execute an 'user session'.
`abstract void`	`executeUserSessionEnd(int sessionStatus, int userNumber, int sessionLoopNumber)` Invoked after the end of an executed 'user session'.
`abstract void`	`executeUserStart(int userNumber)` Called when the user is started.
`static java.io.File`	`getArgDataOutputDirectory()` Get the data output directory command line argument.
`static int`	`getArgDelayPerSessionLoopMillis()` Get the delay per session loop command line argument, or the default value if the argument was not passed.
`static java.lang.String`	`getArgJobDescription()` Get the job description command line argument.
`static int`	`getArgMaxSessionLoopsPerUser()` Get the max session loops per user command line argument, or the default value if the argument was not passed.
`static int`	`getArgMaxTestDuration()` Get the max test duration command line argument, or the default value if the argument was not passed,
`static int`	`getArgNumberOfUsers()` Get the number of users command line argument, or the default value if the argument was not passed.
`static int`	`getArgRampUpTime()` Get the ramp up time command line argument.
`static long`	`getExecuteEndTimestamp()` Get the execute end time stamp.
`static long`	`getExecuteStartTimestamp()` Get the execute start time stamp.
`int`	`getSessionLoopNumber()` Get the current session loop number.
`StdoutLogAdapter`	`getStdoutLogAdapter()` Get the stdout log adapter.
`static long`	`getTotalFailedSessions()` Get the total number of failed sessions, counted overall users.
`static long`	`getTotalPassedSessions()` Get the total number of passed sessions, counted overall users.
`int`	`getUserNumber()` Get the simulated user number.
`static boolean`	`isArgDebugExecution()` Get if debug test execution is enabled.
`static boolean`	`isArgDebugMeasuring()` Get if debug data measuring is enabled.
`static boolean`	`isGlobalAbortFlag()` Get if the test must aborted.
`static void`	`logTestSpecificResourceFileNames(java.lang.Class clazz)` Log the file names of all test specific resource files to stdout.
`abstract void`	`onUserResume(int userNumber)` Called when the user was previously suspended and was now resumed.
`abstract void`	`onUserSuspend(int userNumber)` Called when the user was suspended.
`abstract void`	`onUserTestAbort(int userNumber)` Called, per user, when the whole test is aborted by an abort action.
`void`	`registerSampleStart(long statisticId)` All Purpose Interface: Register that the measuring of a long value sample has started
`void`	`run()` User thread method.
`static void`	`sleep(long millis)` Sleep for a while of milliseconds, but wake up earlier when the test must be aborted.
`static void`	`startUserThreads()` Start the user threads and set the 'execute start' timestamp.
`static void`	`waitUserThreadsEnd()` Wait for the end of all user threads an set then the 'execute end' timestamp.

Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG_DEBUG
```
public static final int LOG_DEBUG
```
    Debug log level.
    
    See Also:
    
    Constant Field Values
  - LOG_TRACE
```
public static final int LOG_TRACE
```
    Trace log level.
    
    See Also:
    
    Constant Field Values
  - LOG_INFO
```
public static final int LOG_INFO
```
    Info log level.
    
    See Also:
    
    Constant Field Values
  - LOG_WARN
```
public static final int LOG_WARN
```
    Waring log level.
    
    See Also:
    
    Constant Field Values
  - LOG_ERROR
```
public static final int LOG_ERROR
```
    Error log level.
    
    See Also:
    
    Constant Field Values
  - LOG_FATAL
```
public static final int LOG_FATAL
```
    Fatal log level - System.exit(1) may be called later.
    
    See Also:
    
    Constant Field Values
  - STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART
```
public static final java.lang.String STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART
```
    A chart with samples of event timestamp and (measured) long value..
    
    See Also:
    
    Constant Field Values
  - STATISTIC_TYPE_THROUGHPUT_TIME_CHART
```
public static final java.lang.String STATISTIC_TYPE_THROUGHPUT_TIME_CHART
```
    A chart of a throughput per second.
    
    See Also:
    
    Constant Field Values
  - STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG
```
public static final java.lang.String STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG
```
    A cumulative long counter.
    
    See Also:
    
    Constant Field Values
  - STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT
```
public static final java.lang.String STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT
```
    An efficiency ratio percent value.
    
    See Also:
    
    Constant Field Values
  - STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE
```
public static final java.lang.String STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE
```
    An average and current value.
    
    See Also:
    
    Constant Field Values
  - SESSION_STATUS_SUCCESS
```
public static final int SESSION_STATUS_SUCCESS
```
    Session status success: The execution of user session was successful.
    
    See Also:
    
    Constant Field Values
  - SESSION_STATUS_FAILED
```
public static final int SESSION_STATUS_FAILED
```
    Session status failed: The execution of the session has failed, but the user continues to execute the next session.
    
    See Also:
    
    Constant Field Values
  - SESSION_STATUS_END_OF_USER
```
public static final int SESSION_STATUS_END_OF_USER
```
    Session status end of user: The execution of the session has failed and further execution of the user is stopped.
    
    See Also:
    
    Constant Field Values
  - SESSION_STATUS_END_OF_TEST
```
public static final int SESSION_STATUS_END_OF_TEST
```
    Session status end of test: The execution of the session has failed and further execution of all users is stopped.
    
    See Also:
    
    Constant Field Values
  - VALID_SESSION_STATUS_SET
```
public static final java.util.HashSet<java.lang.Integer> VALID_SESSION_STATUS_SET
```
    A set of all valid session statuses.
  - ERROR_SEVERITY_WARNING
```
public static final java.lang.String ERROR_SEVERITY_WARNING
```
    Error severity 'warning': After the error has occurred then the simulated user continues with the execution of the current session loop. Error color = yellow.
    
    See Also:
    
    Constant Field Values
  - ERROR_SEVERITY_ERROR
```
public static final java.lang.String ERROR_SEVERITY_ERROR
```
    Error severity 'error': After the error has occurred then the simulated aborts the execution of the current session loop and starts the execution of the next session loop. Error color = red.
    
    See Also:
    
    Constant Field Values
  - ERROR_SEVERITY_FATAL
```
public static final java.lang.String ERROR_SEVERITY_FATAL
```
    Error severity 'fatal': After the error has occurred then the simulated user aborts any further execution of the test, which means that the test has ended for this simulated user. Error color = black.
    
    See Also:
    
    Constant Field Values
  - ENCODE_ALGORITHM_NONE
```
public static final int ENCODE_ALGORITHM_NONE
```
    No encoding or decoding of variable value (unchanged / keep it as is).
    
    See Also:
    
    Constant Field Values
  - ENCODE_ALGORITHM_ENCODE
```
public static final int ENCODE_ALGORITHM_ENCODE
```
    Encode variable value with percent-encoding algorithm.
    
    See Also:
    
    Constant Field Values
  - ENCODE_ALGORITHM_DECODE
```
public static final int ENCODE_ALGORITHM_DECODE
```
    Decode percent-encoded variable value.
    
    See Also:
    
    Constant Field Values
  - VALID_ENCODE_ALGORITHM_SET
```
public static final java.util.HashSet<java.lang.Integer> VALID_ENCODE_ALGORITHM_SET
```
    A set of all valid encode algorithms for variable values.
  - SUSPEND_TESTJOB_FILE_NAME
```
public static final java.lang.String SUSPEND_TESTJOB_FILE_NAME
```
    The existence of this file in the data output directory effects that the test is suspended.
    
    See Also:
    
    Constant Field Values
  - ABORT_TESTJOB_FILE_NAME
```
public static final java.lang.String ABORT_TESTJOB_FILE_NAME
```
    The existence of this file in the data output directory effects that the test is aborted.
    
    See Also:
    
    Constant Field Values
  - stdoutLog
```
public static StdoutLogAdapter stdoutLog
```
    The stdout log adapter.
- Constructor Detail
  - AbstractJavaTest
```
public AbstractJavaTest(int userNumber)
                 throws java.io.IOException
```
    Constructor: Create a new instance.
    
    Parameters:
    
    userNumber - the simulated user number (1..n)
    
    Throws:
    
    java.lang.IllegalArgumentException - if the user number less than 1
    
    java.io.IOException - if the user statistics out file cannot be created
- Method Detail
  - logTestSpecificResourceFileNames
```
public static void logTestSpecificResourceFileNames(java.lang.Class clazz)
```
    Log the file names of all test specific resource files to stdout.
    
    Parameters:
    
    clazz - the class of the test program
    
    See Also:
    
    AbstractJavaTest.ResourceFiles
  - addSimulatedUser
```
public static void addSimulatedUser(AbstractJavaTest abstractJavaTestInstance)
```
    Add an instance of a simulated user.
    
    Parameters:
    
    abstractJavaTestInstance - the instance of the simulated user.
  - startUserThreads
```
public static void startUserThreads()
                             throws java.lang.InterruptedException
```
    Start the user threads and set the 'execute start' timestamp. Note that this method blocks until the ramp-up time is elapsed.
    
    Throws:
    
    java.lang.InterruptedException - if the program is aborted during ramp-up
  - waitUserThreadsEnd
```
public static void waitUserThreadsEnd()
                               throws java.lang.InterruptedException
```
    Wait for the end of all user threads an set then the 'execute end' timestamp.
    
    Throws:
    
    java.lang.InterruptedException - if the program is aborted during waiting for the end of all user threads
  - getTotalPassedSessions
```
public static long getTotalPassedSessions()
```
    Get the total number of passed sessions, counted overall users.
    
    Returns:
    
    the total number of passed sessions
  - getTotalFailedSessions
```
public static long getTotalFailedSessions()
```
    Get the total number of failed sessions, counted overall users.
    
    Returns:
    
    the total number of failed sessions
  - getExecuteStartTimestamp
```
public static long getExecuteStartTimestamp()
```
    Get the execute start time stamp.
    
    Returns:
    
    the execute start time stamp, or -1 if the test was not started
  - getExecuteEndTimestamp
```
public static long getExecuteEndTimestamp()
```
    Get the execute end time stamp.
    
    Returns:
    
    the execute end time stamp, or -1 if no such value is available
  - isGlobalAbortFlag
```
public static boolean isGlobalAbortFlag()
```
    Get if the test must aborted.
    
    Returns:
    
    true if the test must aborted
  - sleep
```
public static void sleep(long millis)
                  throws java.lang.InterruptedException
```
    Sleep for a while of milliseconds, but wake up earlier when the test must be aborted. Implementation notes:
    1. There us no early wakeup for sleep durations less than 5000 ms.
    2. For sleep durations equal or greater than 5000 ms the internal sleep intervals are fixed to 500 ms. This means that the global abort flag is checked every half second.
    3. Do *not* catch the InterruptedException: If you do so the test cannot aborted.
    Parameters:
    
    millis - the sleep duration in milliseconds
    
    Throws:
    
    java.lang.InterruptedException - if the current thread is interrupted
    
    See Also:
    
    isGlobalAbortFlag()
  - getUserNumber
```
public int getUserNumber()
```
    Get the simulated user number.
    
    Returns:
    
    the simulated user number (1..n)
  - getSessionLoopNumber
```
public int getSessionLoopNumber()
```
    Get the current session loop number.
    
    Returns:
    
    the current session loop number (1..n)
  - getStdoutLogAdapter
```
public StdoutLogAdapter getStdoutLogAdapter()
```
    Get the stdout log adapter.
    
    Returns:
    
    the stdout log adapter
  - run
```
public void run()
```
    User thread method.
    
    Specified by:
    
    run in interface java.lang.Runnable
    
    Overrides:
    
    run in class java.lang.Thread
  - declareStatistics
```
public abstract void declareStatistics()
                                throws java.lang.Exception
```
    Declare all statistics which are known to be measured. Identical statistics that are defined twice or more are merged into one statistic. It is therefore not a problem if several users define the same statistics. Note: Additional statistics can also declared at any time during the test execution.
    
    Throws:
    
    java.lang.Exception - if somewhat fails in the implementation
  - executeUserStart
```
public abstract void executeUserStart(int userNumber)
                               throws java.lang.Exception
```
    Called when the user is started.
    
    Parameters:
    
    userNumber - the current simulated user number
    
    Throws:
    
    java.lang.Exception - if somewhat fails in the implementation
  - executeUserSession
```
public abstract int executeUserSession(int userNumber,
                                       int sessionLoopNumber)
                                throws AbstractJavaTestPluginSessionFailedException,
                                       AbstractJavaTestPluginUserFailedException,
                                       AbstractJavaTestPluginTestFailedException,
                                       java.lang.Exception
```
    Invoked when the user is supposed to execute an 'user session'.
    
    Parameters:
    
    userNumber - the current simulated user number (1..n)
    
    sessionLoopNumber - the session loop number (1..n)
    
    Returns:
    
    the session status of the executed session
    
    Throws:
    
    AbstractJavaTestPluginSessionFailedException - if a plug-in signals that the 'user session' is aborted
    
    AbstractJavaTestPluginUserFailedException - if a plug-in signals that the user has to be terminated
    
    AbstractJavaTestPluginTestFailedException - if a plug-in signals that the test has to be terminated
    
    java.lang.Exception - if somewhat fails in the implementation
    
    See Also:
    
    SESSION_STATUS_SUCCESS, SESSION_STATUS_FAILED, SESSION_STATUS_END_OF_USER, SESSION_STATUS_END_OF_TEST
  - executeUserSessionEnd
```
public abstract void executeUserSessionEnd(int sessionStatus,
                                           int userNumber,
                                           int sessionLoopNumber)
                                    throws java.lang.Exception
```
    Invoked after the end of an executed 'user session'.
    
    Parameters:
    
    sessionStatus - the session status of the executed session
    
    userNumber - the current simulated user number (1..n)
    
    sessionLoopNumber - the session loop number (1..n)
    
    Throws:
    
    java.lang.Exception - if somewhat fails in the implementation
    
    See Also:
    
    SESSION_STATUS_SUCCESS, SESSION_STATUS_FAILED, SESSION_STATUS_END_OF_USER, SESSION_STATUS_END_OF_TEST
  - onUserSuspend
```
public abstract void onUserSuspend(int userNumber)
                            throws java.lang.Exception
```
    Called when the user was suspended. Usually, no special actions need to be taken.
    
    Parameters:
    
    userNumber - the current simulated user number
    
    Throws:
    
    java.lang.Exception - if somewhat fails in the implementation
  - onUserResume
```
public abstract void onUserResume(int userNumber)
                           throws java.lang.Exception
```
    Called when the user was previously suspended and was now resumed. Usually, no special actions need to be taken.
    
    Parameters:
    
    userNumber - the current simulated user number
    
    Throws:
    
    java.lang.Exception - if somewhat fails in the implementation
  - executeUserEnd
```
public abstract void executeUserEnd(int userNumber)
                             throws java.lang.Exception
```
    Called when the user has ended.
    
    Parameters:
    
    userNumber - the current simulated user number
    
    Throws:
    
    java.lang.Exception - if somewhat fails in the implementation
  - onUserTestAbort
```
public abstract void onUserTestAbort(int userNumber)
                              throws java.lang.Exception
```
    Called, per user, when the whole test is aborted by an abort action. If the user did start additional threads or other asynchronous tasks, these must be aborted immediately. On the other hand, if the user did not create additional threads or other asynchronous tasks, no special actions need to be taken. Note that in such a case the method executeUserEnd(int userNumber) is *not* called.
    
    Parameters:
    
    userNumber - the current simulated user number
    
    Throws:
    
    java.lang.Exception - if somewhat fails in the implementation
    
    See Also:
    
    executeUserEnd(int)
  - declareStatistic
```
public void declareStatistic(long statisticId,
                             java.lang.String statisticType,
                             java.lang.String statisticTitle,
                             java.lang.String statisticSubtitle,
                             java.lang.String yAxisTitle,
                             java.lang.String unitText,
                             int sortPosition,
                             boolean addToSummaryStatistic,
                             java.lang.String backgroundColor)
```
    All Purpose Interface: Declare a new statistic.
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    statisticType - the type of the statistic
    
    statisticTitle - the title shown in the UI
    
    statisticSubtitle - the subtitle shown in the UI, or an empty string = not shown in the UI
    
    yAxisTitle - the Y-axis title of the diagram shown in the UI, or an empty string = not shown in the UI
    
    unitText - the text for the measured unit shown in the UI, or an empty string = not shown in the UI
    
    sortPosition - the UI sort position (sorting order: from small to large positions)
    
    addToSummaryStatistic - if true = add the number of passed/failed/pending samples to the summary statistic
    
    backgroundColor - the background color either as #hex-triplet or as bootstrap class, or an empty string = no special background color
    
    See Also:
    
    STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART, STATISTIC_TYPE_THROUGHPUT_TIME_CHART, STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG, STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT, STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE
  - registerSampleStart
```
public void registerSampleStart(long statisticId)
```
    All Purpose Interface: Register that the measuring of a long value sample has started
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    See Also:
    
    addSampleLong(long, long), addSampleError(long, String, String, String, String, String), STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART
  - addSampleLong
```
public void addSampleLong(long statisticId,
                          long value)
```
    All Purpose Interface: Add a measured long value to a statistic.
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    value - the measured long value
    
    See Also:
    
    registerSampleStart(long), STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART
  - addSampleError
```
public void addSampleError(long statisticId,
                           java.lang.String errorSubject,
                           java.lang.String errorSeverity,
                           java.lang.String errorType,
                           java.lang.String errorLog,
                           java.lang.String errorContext)
```
    All Purpose Interface: Add an error to a declared statistic (for example when measuring a data sample did fail).
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    errorSubject - the subject of the error. Note that multiple errors which contains the same subject can be grouped.
    
    errorSeverity - the error severity
    
    errorType - the (optional) type of the error which reflects why the error did occur. Note that multiple errors which contains the same error type can be grouped.
    
    errorLog - the (optional) error log
    
    errorContext - the (optional) error context that describes the circumstances under which the error occurred. It's recommended to pass a JSON object as string.
    
    See Also:
    
    ERROR_SEVERITY_WARNING, ERROR_SEVERITY_ERROR, ERROR_SEVERITY_FATAL, registerSampleStart(long), STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART
  - addThroughputDelta
```
public void addThroughputDelta(long statisticId,
                               double deltaValue)
```
    All Purpose Interface: Add a measured delta value to a throughput statistic.
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    deltaValue - the measured delta value
    
    See Also:
    
    STATISTIC_TYPE_THROUGHPUT_TIME_CHART
  - addCounterLong
```
public void addCounterLong(long statisticId,
                           long value)
```
    All Purpose Interface: Increment the counter of a declared 'cumulative-counter-long' statistic.
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    value - the value by which the counter is incremented
    
    See Also:
    
    STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG
  - addEfficiencyRatioDelta
```
public void addEfficiencyRatioDelta(long statisticId,
                                    long efficiencyDeltaValue,
                                    long inefficiencyDeltaValue)
```
    All Purpose Interface: Add efficiency ratio delta values to a 'efficiency-ratio-percent' statistic.
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    efficiencyDeltaValue - the efficiency delta value to add
    
    inefficiencyDeltaValue - the inefficiency delta value to add
    
    See Also:
    
    STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT
  - addAverageDeltaAndCurrentValue
```
public void addAverageDeltaAndCurrentValue(long statisticId,
                                           long sumValuesDelta,
                                           long numValuesDelta,
                                           long currentValue,
                                           long currentValueTimestamp)
```
    All Purpose Interface: Add delta values to the average and set the current value for a 'average-and-current-value' statistic.
    
    Parameters:
    
    statisticId - the unique ID of the statistic
    
    sumValuesDelta - the sum of delta values to add to the average
    
    numValuesDelta - the number of delta values to add to the average
    
    currentValue - the current value, or -1 if no such data is available
    
    currentValueTimestamp - the Unix-like timestamp of the current value, or -1 if no such data is available
    
    See Also:
    
    STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE
  - addTestResultAnnotationExecEvent
```
public int addTestResultAnnotationExecEvent(java.lang.String eventText)
```
    All Purpose Interface: Add an execution annotation event to the test result. Note that a maximum number of 999999 events can added.
    
    Parameters:
    
    eventText - the event text
    
    Returns:
    
    the event id, or 0 if the event is ignored because too many events have already added to the test result
  - abstractMain
```
public static void abstractMain(java.lang.String[] args)
```
    Static Main: Get all generic arguments passed from the command line of the main program. The generic program arguments are:
    - -users <integer> : The number of simulated users (>= 1).
    - -duration <integer> : The test duration in seconds (>= 1).
    - -maxLoops <integer> : The maximum number of session loops per simulated use (>= 1, or -1 = means infinite number of session loops).
    - -delayPerLoop <integer> : The delay in milliseconds before a simulated user starts a next session loop iteration (>= 0) – but not applied for the first session loop iteration of the user.
    - -rampupTime <integer> : The ramp up time in seconds until all simulated users are started (>=0). Example: If 10 users are started within 5 seconds then the first user is started immediately and then the remaining 9 users are started in (5 seconds / 9 users) = 0.55 seconds intervals.
    - -dataOutputDir <directory path> : The directory to which the measured data have to be written.
    - -description <string> : Optional, a short description about the test.
    - -debugExec : Optional, if set = debug test execution.
    - -debugData : Optional, if set = debug data measuring.
    Parameters:
    
    args - all arguments passed from the command line
    
    See Also:
    
    getArgNumberOfUsers(), getArgMaxTestDuration(), getArgMaxSessionLoopsPerUser(), getArgDelayPerSessionLoopMillis(), getArgRampUpTime(), getArgDataOutputDirectory(), getArgJobDescription(), isArgDebugExecution(), isArgDebugMeasuring()
  - getArgNumberOfUsers
```
public static int getArgNumberOfUsers()
```
    Get the number of users command line argument, or the default value if the argument was not passed.
    
    Returns:
    
    the number of users
    
    See Also:
    
    abstractMain(String[])
  - getArgMaxTestDuration
```
public static int getArgMaxTestDuration()
```
    Get the max test duration command line argument, or the default value if the argument was not passed,
    
    Returns:
    
    max test duration (in seconds)
    
    See Also:
    
    abstractMain(String[])
  - getArgMaxSessionLoopsPerUser
```
public static int getArgMaxSessionLoopsPerUser()
```
    Get the max session loops per user command line argument, or the default value if the argument was not passed.
    
    Returns:
    
    the max session loops per user (-1 = unlimited)
    
    See Also:
    
    abstractMain(String[])
  - getArgDelayPerSessionLoopMillis
```
public static int getArgDelayPerSessionLoopMillis()
```
    Get the delay per session loop command line argument, or the default value if the argument was not passed.
    
    Returns:
    
    the delay per session loop (in milliseconds)
    
    See Also:
    
    abstractMain(String[])
  - getArgRampUpTime
```
public static int getArgRampUpTime()
```
    Get the ramp up time command line argument.
    
    Returns:
    
    the ramp up time command line argument (in seconds), or the default value if the argument was not passed.
    
    See Also:
    
    abstractMain(String[])
  - getArgDataOutputDirectory
```
public static java.io.File getArgDataOutputDirectory()
```
    Get the data output directory command line argument.
    
    Returns:
    
    the data output directory command line argument
    
    See Also:
    
    abstractMain(String[])
  - getArgJobDescription
```
public static java.lang.String getArgJobDescription()
```
    Get the job description command line argument.
    
    Returns:
    
    the job description command line argument, or an empty string = no job description
    
    See Also:
    
    abstractMain(String[])
  - isArgDebugExecution
```
public static boolean isArgDebugExecution()
```
    Get if debug test execution is enabled.
    
    Returns:
    
    true if debug test execution is enabled.
    
    See Also:
    
    abstractMain(String[])
  - isArgDebugMeasuring
```
public static boolean isArgDebugMeasuring()
```
    Get if debug data measuring is enabled.
    
    Returns:
    
    if debug data measuring is enabled.
    
    See Also:
    
    abstractMain(String[])

Class AbstractJavaTest

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

LOG_DEBUG

LOG_TRACE

LOG_INFO

LOG_WARN

LOG_ERROR

LOG_FATAL

STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART

STATISTIC_TYPE_THROUGHPUT_TIME_CHART

STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG

STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT

STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE

SESSION_STATUS_SUCCESS

SESSION_STATUS_FAILED

SESSION_STATUS_END_OF_USER

SESSION_STATUS_END_OF_TEST

VALID_SESSION_STATUS_SET

ERROR_SEVERITY_WARNING

ERROR_SEVERITY_ERROR

ERROR_SEVERITY_FATAL

ENCODE_ALGORITHM_NONE

ENCODE_ALGORITHM_ENCODE

ENCODE_ALGORITHM_DECODE

VALID_ENCODE_ALGORITHM_SET

SUSPEND_TESTJOB_FILE_NAME

ABORT_TESTJOB_FILE_NAME

stdoutLog

Constructor Detail

AbstractJavaTest

Method Detail

logTestSpecificResourceFileNames

addSimulatedUser

startUserThreads

waitUserThreadsEnd

getTotalPassedSessions

getTotalFailedSessions

getExecuteStartTimestamp

getExecuteEndTimestamp

isGlobalAbortFlag

sleep

getUserNumber

getSessionLoopNumber

getStdoutLogAdapter

run

declareStatistics

executeUserStart

executeUserSession

executeUserSessionEnd

onUserSuspend

onUserResume

executeUserEnd

onUserTestAbort

declareStatistic

registerSampleStart

addSampleLong

addSampleError

addThroughputDelta

addCounterLong

addEfficiencyRatioDelta

addAverageDeltaAndCurrentValue

addTestResultAnnotationExecEvent

abstractMain

getArgNumberOfUsers

getArgMaxTestDuration

getArgMaxSessionLoopsPerUser

getArgDelayPerSessionLoopMillis

getArgRampUpTime

getArgDataOutputDirectory

getArgJobDescription

isArgDebugExecution

isArgDebugMeasuring