org.safs.tools.engines

Class TIDDriverFlowCommands

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.TIDDriverFlowCommands

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface

public class TIDDriverFlowCommands
extends GenericEngine

Provides local in-process support for DriverFlowCommands. 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

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	command
(package private) static java.lang.String	COMMAND_CALL_CYCLE "CallCycle"
(package private) static java.lang.String	COMMAND_CALL_STEP "CallStep"
(package private) static java.lang.String	COMMAND_CALL_SUITE "CallSuite"
(package private) static java.lang.String	COMMAND_CALLJUNIT "CallJUnit"
(package private) static java.lang.String	COMMAND_EXIT_CYCLE "ExitCycle"
(package private) static java.lang.String	COMMAND_EXIT_SUITE "ExitSuite"
(package private) static java.lang.String	COMMAND_EXIT_TABLE "ExitTable"
(package private) static java.lang.String	COMMAND_GOTO_BLOCKID "GotoBlockID"
(package private) static java.lang.String	COMMAND_ON_CONTAINS_GOTO_BLOCKID "OnContainsGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_DIRECTORY_EXIST_GOTO_BLOCKID "OnDirectoryExistGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_DIRECTORY_NOT_EXIST_GOTO_BLOCKID "OnDirectoryNotExistGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_EQUAL_GOTO_BLOCKID "OnEqualGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_FILE_EXIST_GOTO_BLOCKID "OnFileExistGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_FILE_NOT_EXIST_GOTO_BLOCKID "OnFileNotExistGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_GREATER_THAN_GOTO_BLOCKID "OnGreaterThanGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_IN_RANGE_GOTO_BLOCKID "OnInRangeGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_LESS_THAN_GOTO_BLOCKID "OnLessThanGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_NOT_CONTAINS_GOTO_BLOCKID "OnNotContainsGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_NOT_EQUAL_GOTO_BLOCKID "OnNotEqualGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_NOT_GREATER_THAN_GOTO_BLOCKID "OnNotGreaterThanGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_NOT_IN_RANGE_GOTO_BLOCKID "OnNotInRangeGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_NOT_LESS_THAN_GOTO_BLOCKID "OnNotLessThanGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_REGISTRY_KEY_EXIST_GOTO_BLOCKID "OnRegistryKeyExistGotoBlockID"
(package private) static java.lang.String	COMMAND_ON_REGISTRY_KEY_NOT_EXIST_GOTO_BLOCKID "OnRegistryKeyNotExistGotoBlockID"
(package private) static java.lang.String	COMMAND_ONGUIEXISTS_GOTO_BLOCKID "OnGuiExistsGotoBlockID"
(package private) static java.lang.String	COMMAND_ONGUINOTEXIST_GOTO_BLOCKID "OnGuiNotExistGotoBlockID"
(package private) static java.lang.String	COMMAND_SET_EXIT_TABLE_BLOCK Internal Driver Command: SetExitTableBlock
(package private) static java.lang.String	COMMAND_SET_GENERAL_SCRIPT_FAILURE_BLOCK Internal Driver Command: SetGeneralScriptFailureBlock
(package private) static java.lang.String	COMMAND_SET_INVALID_FILE_IO_BLOCK Internal Driver Command: SetInvalidFileIOBlock
(package private) static java.lang.String	COMMAND_SET_NO_SCRIPT_FAILURE_BLOCK Internal Driver Command: SetNoScriptFailureBlock
(package private) static java.lang.String	COMMAND_SET_SCRIPT_NOT_EXECUTED_BLOCK Internal Driver Command: SetScriptNotExecutedBlock
(package private) static java.lang.String	COMMAND_SET_SCRIPT_WARNING_BLOCK Internal Driver Command: SetScriptWarningBlock
(package private) static java.lang.String	COMMAND_USE_LOCAL_FLOW_CONTROL Internal Driver Command: UseLocalFlowControl
(package private) java.lang.String	detail
(package private) static java.lang.String	ENGINE_NAME "SAFS/TIDDriverFlowCommands"
(package private) java.lang.String	message
(package private) java.lang.String	rtype
(package private) static java.lang.String	SAFS_DATAPOOL_DIR

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

console, process, testRecordData, testrecordStackable

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
TIDDriverFlowCommands() Constructor for TIDDriverCommands
TIDDriverFlowCommands(DriverInterface driver) PREFERRED Constructor for TIDDriverCommands.

Method Summary

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, getEngineName, getVariable, isToolRunning, logMessage, makeQuotedPath, makeQuotedString, popTestRecord, postShutdownServiceDelay, pushTestRecord, reset, resetShutdownSemaphore, saveTestRecordScreenToTestDirectory, setTRDStatus, setVariable, shutdownService, waitHookShutdownAndReset

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

configureJSTAFServiceEmbeddedJVMOption, extendedGenericMessage, finalize, getCoreInterface, getEmbeddedJVMBinPath, getSTAFHelper, logMessage, setLogUtilities, setLogUtilities, shutdown, simpleGenericMessage, simpleGenericSuccessMessage, simpleGenericWarningMessage, simpleSuccessMessage, simpleSuccessMessage, simpleSuccessUsingMessage, standardErrorMessage, waitForServiceStartCompletion

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_EXIT_TABLE

static final java.lang.String COMMAND_EXIT_TABLE

"ExitTable"

See Also:

Constant Field Values

COMMAND_EXIT_SUITE

static final java.lang.String COMMAND_EXIT_SUITE

"ExitSuite"

See Also:

Constant Field Values

COMMAND_EXIT_CYCLE

static final java.lang.String COMMAND_EXIT_CYCLE

"ExitCycle"

See Also:

Constant Field Values

COMMAND_CALL_CYCLE

static final java.lang.String COMMAND_CALL_CYCLE

"CallCycle"

See Also:

Constant Field Values

COMMAND_CALL_SUITE

static final java.lang.String COMMAND_CALL_SUITE

"CallSuite"

See Also:

Constant Field Values

COMMAND_CALL_STEP

static final java.lang.String COMMAND_CALL_STEP

"CallStep"

See Also:

Constant Field Values

COMMAND_CALLJUNIT

static final java.lang.String COMMAND_CALLJUNIT

"CallJUnit"

See Also:

Constant Field Values

COMMAND_GOTO_BLOCKID

static final java.lang.String COMMAND_GOTO_BLOCKID

"GotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_CONTAINS_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_CONTAINS_GOTO_BLOCKID

"OnContainsGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_NOT_CONTAINS_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_NOT_CONTAINS_GOTO_BLOCKID

"OnNotContainsGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_EQUAL_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_EQUAL_GOTO_BLOCKID

"OnEqualGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_NOT_EQUAL_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_NOT_EQUAL_GOTO_BLOCKID

"OnNotEqualGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_GREATER_THAN_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_GREATER_THAN_GOTO_BLOCKID

"OnGreaterThanGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_NOT_GREATER_THAN_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_NOT_GREATER_THAN_GOTO_BLOCKID

"OnNotGreaterThanGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_LESS_THAN_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_LESS_THAN_GOTO_BLOCKID

"OnLessThanGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_NOT_LESS_THAN_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_NOT_LESS_THAN_GOTO_BLOCKID

"OnNotLessThanGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_IN_RANGE_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_IN_RANGE_GOTO_BLOCKID

"OnInRangeGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_NOT_IN_RANGE_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_NOT_IN_RANGE_GOTO_BLOCKID

"OnNotInRangeGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_FILE_EXIST_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_FILE_EXIST_GOTO_BLOCKID

"OnFileExistGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_FILE_NOT_EXIST_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_FILE_NOT_EXIST_GOTO_BLOCKID

"OnFileNotExistGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_REGISTRY_KEY_EXIST_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_REGISTRY_KEY_EXIST_GOTO_BLOCKID

"OnRegistryKeyExistGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_REGISTRY_KEY_NOT_EXIST_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_REGISTRY_KEY_NOT_EXIST_GOTO_BLOCKID

"OnRegistryKeyNotExistGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_DIRECTORY_EXIST_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_DIRECTORY_EXIST_GOTO_BLOCKID

"OnDirectoryExistGotoBlockID"

See Also:

Constant Field Values

COMMAND_ON_DIRECTORY_NOT_EXIST_GOTO_BLOCKID

static final java.lang.String COMMAND_ON_DIRECTORY_NOT_EXIST_GOTO_BLOCKID

"OnDirectoryNotExistGotoBlockID"

See Also:

Constant Field Values

COMMAND_ONGUIEXISTS_GOTO_BLOCKID

static final java.lang.String COMMAND_ONGUIEXISTS_GOTO_BLOCKID

"OnGuiExistsGotoBlockID"

See Also:

Constant Field Values

COMMAND_ONGUINOTEXIST_GOTO_BLOCKID

static final java.lang.String COMMAND_ONGUINOTEXIST_GOTO_BLOCKID

"OnGuiNotExistGotoBlockID"

See Also:

Constant Field Values

COMMAND_USE_LOCAL_FLOW_CONTROL

static final java.lang.String COMMAND_USE_LOCAL_FLOW_CONTROL

Internal Driver Command: UseLocalFlowControl

See Also:

Constant Field Values

COMMAND_SET_EXIT_TABLE_BLOCK

static final java.lang.String COMMAND_SET_EXIT_TABLE_BLOCK

Internal Driver Command: SetExitTableBlock

See Also:

Constant Field Values

COMMAND_SET_GENERAL_SCRIPT_FAILURE_BLOCK

static final java.lang.String COMMAND_SET_GENERAL_SCRIPT_FAILURE_BLOCK

Internal Driver Command: SetGeneralScriptFailureBlock

See Also:

Constant Field Values

COMMAND_SET_INVALID_FILE_IO_BLOCK

static final java.lang.String COMMAND_SET_INVALID_FILE_IO_BLOCK

Internal Driver Command: SetInvalidFileIOBlock

See Also:

Constant Field Values

COMMAND_SET_NO_SCRIPT_FAILURE_BLOCK

static final java.lang.String COMMAND_SET_NO_SCRIPT_FAILURE_BLOCK

Internal Driver Command: SetNoScriptFailureBlock

See Also:

Constant Field Values

COMMAND_SET_SCRIPT_NOT_EXECUTED_BLOCK

static final java.lang.String COMMAND_SET_SCRIPT_NOT_EXECUTED_BLOCK

Internal Driver Command: SetScriptNotExecutedBlock

See Also:

Constant Field Values

COMMAND_SET_SCRIPT_WARNING_BLOCK

static final java.lang.String COMMAND_SET_SCRIPT_WARNING_BLOCK

Internal Driver Command: SetScriptWarningBlock

See Also:

Constant Field Values

command

java.lang.String command

message

java.lang.String message

detail

java.lang.String detail

rtype

java.lang.String rtype

SAFS_DATAPOOL_DIR

static final java.lang.String SAFS_DATAPOOL_DIR

See Also:

Constant Field Values

Constructor Detail

TIDDriverFlowCommands

public TIDDriverFlowCommands()

Constructor for TIDDriverCommands

TIDDriverFlowCommands

public TIDDriverFlowCommands(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()