TIDDriverCounterCommands (SAFS API DOCUMENT)

java.lang.Object
- org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass
- - org.safs.tools.engines.GenericEngine
  - - org.safs.tools.engines.TIDDriverCounterCommands

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface, Versionable
```
public class TIDDriverCounterCommands
extends GenericEngine
```
Provides local in-process support for DriverCounterCommands. This class is normally only called by the overall TIDDriverCommands class.
This DriverCommands engine does not assume the use of STAF. Instead, it uses the various org.safs.tools Interfaces to talk with the rest of the framework (as made available via the DriverInterface configuration).

Author:

Carl Nagle DEC 14, 2005 Refactored with DriverConfiguredSTAFInterface superclass, Carl Nagle FEB 08, 2010 Fixed some status counter suspend\resume issues. Added support for more Start and Stop counter keywords. Carl Nagle SEP 17, 2014 Fixing SAFS Crashes due to incomplete initialization., Lei Wang MAR 30, 2018 Comment out the code of collection test data at runtime.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) java.lang.String`	`command`
`(package private) static java.lang.String`	`COMMAND_DELETE_COUNTER` "DeleteCounter"
`(package private) static java.lang.String`	`COMMAND_LOG_COUNTER_INFO` "LogCounterInfo"
`(package private) static java.lang.String`	`COMMAND_RESET_COUNTER` "ResetCounter"
`(package private) static java.lang.String`	`COMMAND_RESUME_STATUS_COUNTS` "ResumeStatusCounts"
`(package private) static java.lang.String`	`COMMAND_SET_COUNTER_MODE` "SetCounterMode"
`(package private) static java.lang.String`	`COMMAND_START_COUNTER` "StartCounter"
`(package private) static java.lang.String`	`COMMAND_START_CYCLE`
`(package private) static java.lang.String`	`COMMAND_START_PROCEDURE`
`(package private) static java.lang.String`	`COMMAND_START_REQUIREMENT`
`(package private) static java.lang.String`	`COMMAND_START_SUITE`
`(package private) static java.lang.String`	`COMMAND_START_TESTCASE`
`(package private) static java.lang.String`	`COMMAND_STOP_COUNTER` "StopCounter"
`(package private) static java.lang.String`	`COMMAND_STOP_CYCLE`
`(package private) static java.lang.String`	`COMMAND_STOP_PROCEDURE`
`(package private) static java.lang.String`	`COMMAND_STOP_REQUIREMENT`
`(package private) static java.lang.String`	`COMMAND_STOP_SUITE`
`(package private) static java.lang.String`	`COMMAND_STOP_TESTCASE`
`(package private) static java.lang.String`	`COMMAND_STORE_COUNTER_INFO` "StoreCounterInfo"
`(package private) static java.lang.String`	`COMMAND_SUSPEND_STATUS_COUNTS` "SuspendStatusCounts"
`static java.lang.String[]`	`COUNTER_MODE_TEXT` 'AllStatusInfo', 'StepTestsOnly'
`(package private) CountersInterface`	`counters`
`(package private) java.lang.String`	`desc`
`(package private) static java.lang.String`	`ENGINE_NAME` "SAFS/TIDDriverFlowCommands"
`(package private) java.lang.String`	`id`
`(package private) java.lang.String`	`message`
`(package private) java.lang.String`	`option1`
`(package private) java.lang.String`	`option2`
`(package private) java.lang.String`	`option3`
`(package private) java.lang.String`	`safsDataServiceId`
`(package private) VarsInterface`	`vars`

Fields inherited from class org.safs.tools.engines.GenericEngine
console, description, process, productName, testRecordData, testrecordStackable, version

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass
config, customStr, customText, debugStr, debugText, driver, DRIVER_TEMP_PROCESS, failedStr, failedText, genericStr, genericText, launchCount, log, machine, otherStr, otherText, passedStr, passedText, processName, running, SAFS_RESBUN_NAME, servicename, shutdownCount, staf, STAFPROC_EXE, warningStr, warningText, weStartedService, weStartedSTAF

Fields inherited from interface org.safs.tools.engines.EngineInterface
COMMAND_SHUTDOWN_HOOK

Constructor Summary

Constructors
Constructor and Description
`TIDDriverCounterCommands()` Constructor for TIDDriverCommands
`TIDDriverCounterCommands(DriverInterface driver)` PREFERRED Constructor for TIDDriverCommands.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`launchInterface(java.lang.Object configInfo)` Typically expects a DriverInterface object for initialization.
`long`	`processRecord(TestRecordHelper testRecordData)` Process the record present in the provided testRecordData.

Methods inherited from class org.safs.tools.engines.GenericEngine
deduceBenchFile, deduceProjectFile, deduceTestFile, getAppMapItem, getDescription, getEngineName, getProductName, getVariable, getVersion, isToolRunning, logMessage, makeQuotedPath, makeQuotedString, popTestRecord, postShutdownServiceDelay, pushTestRecord, reset, resetShutdownSemaphore, saveTestRecordScreenToTestDirectory, setDescription, setProductName, setTRDStatus, setVariable, setVersion, shutdownService, waitHookShutdownAndReset

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

Methods inherited from interface org.safs.tools.GenericToolsInterface
getCoreInterface, shutdown

- Field Detail
  - ENGINE_NAME
```
static final java.lang.String ENGINE_NAME
```
    "SAFS/TIDDriverFlowCommands"
    
    See Also:
    
    Constant Field Values
  - COMMAND_START_COUNTER
```
static final java.lang.String COMMAND_START_COUNTER
```
    "StartCounter"
    
    See Also:
    
    Constant Field Values
  - COMMAND_START_CYCLE
```
static final java.lang.String COMMAND_START_CYCLE
```
    See Also:
    
    Constant Field Values
  - COMMAND_START_PROCEDURE
```
static final java.lang.String COMMAND_START_PROCEDURE
```
    See Also:
    
    Constant Field Values
  - COMMAND_START_REQUIREMENT
```
static final java.lang.String COMMAND_START_REQUIREMENT
```
    See Also:
    
    Constant Field Values
  - COMMAND_START_SUITE
```
static final java.lang.String COMMAND_START_SUITE
```
    See Also:
    
    Constant Field Values
  - COMMAND_START_TESTCASE
```
static final java.lang.String COMMAND_START_TESTCASE
```
    See Also:
    
    Constant Field Values
  - COMMAND_STOP_COUNTER
```
static final java.lang.String COMMAND_STOP_COUNTER
```
    "StopCounter"
    
    See Also:
    
    Constant Field Values
  - COMMAND_STOP_CYCLE
```
static final java.lang.String COMMAND_STOP_CYCLE
```
    See Also:
    
    Constant Field Values
  - COMMAND_STOP_PROCEDURE
```
static final java.lang.String COMMAND_STOP_PROCEDURE
```
    See Also:
    
    Constant Field Values
  - COMMAND_STOP_REQUIREMENT
```
static final java.lang.String COMMAND_STOP_REQUIREMENT
```
    See Also:
    
    Constant Field Values
  - COMMAND_STOP_SUITE
```
static final java.lang.String COMMAND_STOP_SUITE
```
    See Also:
    
    Constant Field Values
  - COMMAND_STOP_TESTCASE
```
static final java.lang.String COMMAND_STOP_TESTCASE
```
    See Also:
    
    Constant Field Values
  - COMMAND_RESET_COUNTER
```
static final java.lang.String COMMAND_RESET_COUNTER
```
    "ResetCounter"
    
    See Also:
    
    Constant Field Values
  - COMMAND_DELETE_COUNTER
```
static final java.lang.String COMMAND_DELETE_COUNTER
```
    "DeleteCounter"
    
    See Also:
    
    Constant Field Values
  - COMMAND_SUSPEND_STATUS_COUNTS
```
static final java.lang.String COMMAND_SUSPEND_STATUS_COUNTS
```
    "SuspendStatusCounts"
    
    See Also:
    
    Constant Field Values
  - COMMAND_RESUME_STATUS_COUNTS
```
static final java.lang.String COMMAND_RESUME_STATUS_COUNTS
```
    "ResumeStatusCounts"
    
    See Also:
    
    Constant Field Values
  - COMMAND_SET_COUNTER_MODE
```
static final java.lang.String COMMAND_SET_COUNTER_MODE
```
    "SetCounterMode"
    
    See Also:
    
    Constant Field Values
  - COMMAND_STORE_COUNTER_INFO
```
static final java.lang.String COMMAND_STORE_COUNTER_INFO
```
    "StoreCounterInfo"
    
    See Also:
    
    Constant Field Values
  - COMMAND_LOG_COUNTER_INFO
```
static final java.lang.String COMMAND_LOG_COUNTER_INFO
```
    "LogCounterInfo"
    
    See Also:
    
    Constant Field Values
  - command
```
java.lang.String command
```
  - message
```
java.lang.String message
```
  - id
```
java.lang.String id
```
  - desc
```
java.lang.String desc
```
  - option1
```
java.lang.String option1
```
  - option2
```
java.lang.String option2
```
  - option3
```
java.lang.String option3
```
  - counters
```
CountersInterface counters
```
  - vars
```
VarsInterface vars
```
  - safsDataServiceId
```
java.lang.String safsDataServiceId
```
  - COUNTER_MODE_TEXT
```
public static final java.lang.String[] COUNTER_MODE_TEXT
```
    'AllStatusInfo', 'StepTestsOnly'
- Constructor Detail
  - TIDDriverCounterCommands
```
public TIDDriverCounterCommands()
```
    Constructor for TIDDriverCommands
  - TIDDriverCounterCommands
```
public TIDDriverCounterCommands(DriverInterface driver)
```
    PREFERRED Constructor for TIDDriverCommands. Constructs the instance and calls launchInterface to initialize.
- Method Detail
  - launchInterface
```
public void launchInterface(java.lang.Object configInfo)
```
    Description copied from class: GenericEngine
    
    Typically expects a DriverInterface object for initialization. Subclasses should indicate if an alternative type of object is required. This method will try to reset the "shutdown" semaphore remained by last hook shutdown.
    
    Specified by:
    
    launchInterface in interface ConfigurableToolsInterface
    
    Overrides:
    
    launchInterface in class GenericEngine
    
    Parameters:
    
    configInfo - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.
    
    See Also:
    
    GenericEngine.launchInterface(Object)
  - processRecord
```
public long processRecord(TestRecordHelper testRecordData)
```
    Process the record present in the provided testRecordData.
    Specified by:
    
    processRecord in interface EngineInterface
    
    Overrides:
    
    processRecord in class GenericEngine
    
    Returns:
    the status code resulting from the processing.
    
    4 -- SCRIPT NOT EXECUTED. "I did not process this record."
    -1 -- NO SCRIPT FAILURE. "I processed the record successfully."
    -2 -- SCRIPT WARNING. "I processed the record, issued warning(s)."
    0 -- SCRIPT FAILURE. "I processed the record, issued failure(s)."
    2 -- IO FAILURE. "I process the record, issued IO failure(s)."
    8 -- EXIT TABLE. "I processed the record, exit current table."
    16 -- IGNORE STATUS. "I processed the record, ignore code and continue."
    See Also:
    
    EngineInterface#processRecord()

Class TIDDriverCounterCommands

Field Summary

Fields inherited from class org.safs.tools.engines.GenericEngine

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

Fields inherited from interface org.safs.tools.engines.EngineInterface

Constructor Summary

Method Summary

Methods inherited from class org.safs.tools.engines.GenericEngine

Methods inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

Methods inherited from class java.lang.Object

Methods inherited from interface org.safs.tools.GenericToolsInterface

Field Detail

ENGINE_NAME

COMMAND_START_COUNTER

COMMAND_START_CYCLE

COMMAND_START_PROCEDURE

COMMAND_START_REQUIREMENT

COMMAND_START_SUITE

COMMAND_START_TESTCASE

COMMAND_STOP_COUNTER

COMMAND_STOP_CYCLE

COMMAND_STOP_PROCEDURE

COMMAND_STOP_REQUIREMENT

COMMAND_STOP_SUITE

COMMAND_STOP_TESTCASE

COMMAND_RESET_COUNTER

COMMAND_DELETE_COUNTER

COMMAND_SUSPEND_STATUS_COUNTS

COMMAND_RESUME_STATUS_COUNTS

COMMAND_SET_COUNTER_MODE

COMMAND_STORE_COUNTER_INFO

COMMAND_LOG_COUNTER_INFO

command

message

id

desc

option1

option2

option3

counters

vars

safsDataServiceId

COUNTER_MODE_TEXT

Constructor Detail

TIDDriverCounterCommands

TIDDriverCounterCommands

Method Detail

launchInterface

processRecord