org.safs.tools.engines

Class SAFSDRIVERCOMMANDS

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.SAFSDRIVERCOMMANDS

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface, Versionable

public class SAFSDRIVERCOMMANDS
extends GenericEngine

Provides support for comprehensive, in-process Driver Commands.

Here we are going to use the existing org.safs.DriverCommandsProcessor.
We are going to attempt to use them in-process, rather than starting up the STAF SAFS/DriverCommands version of the same. This mimics how RobotJ is able to use these same Driver Command classes.

Note, the current implementation of DriverCommandsProcessor requires access to a STAFHelper. So this class can only be used when such a STAFHelper is accessible from tools associated with the Driver, or via the STAFProcessHelpers class.

Author:

Carl Nagle DEC 14, 2005 Refactored with DriverConfiguredSTAFInterface superclass

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	ENGINE_NAME 'SAFS/IPDriverCommands'
protected DDGUIUtilities	guiUtils Needed by command Processors.
protected LogUtilities	logUtils Needed by STAF-centric DriverCommandProcessor.
protected DriverCommandProcessor	processor Standard Java-based Driver Command processor.

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

Method Summary

Modifier and Type	Method and Description
void	launchInterface(java.lang.Object configInfo) 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 org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

configureJSTAFServiceEmbeddedJVMOption, extendedGenericMessage, finalize, getCoreInterface, getEmbedded64JVMBinPath, 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/IPDriverCommands'

See Also:

Constant Field Values

logUtils

protected LogUtilities logUtils

Needed by STAF-centric DriverCommandProcessor.

guiUtils

protected DDGUIUtilities guiUtils

Needed by command Processors.

processor

protected DriverCommandProcessor processor

Standard Java-based Driver Command processor.

Constructor Detail

SAFSDRIVERCOMMANDS

public SAFSDRIVERCOMMANDS()

Constructor for SAFSDRIVERCOMMANDS

SAFSDRIVERCOMMANDS

public SAFSDRIVERCOMMANDS(DriverInterface driver)

PREFERRED Constructor for SAFSDriverCommands. Constructs the instance and calls launchInterface to initialize.

Method Detail

launchInterface

public void launchInterface(java.lang.Object configInfo)

Expects a DriverInterface object for initialization.

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), DriverInterface

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