org.safs.tools.engines

Class SAFSABBOT

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.SAFSABBOT

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface

public class SAFSABBOT
extends GenericEngine

A wrapper to the Abbot SAFS engine--the "Abbot" engine. This engine can only be used if you have a valid install of Abbot (http://abbot.sourceforge.net)

The default SAFSDRIVER Tool-Independent Driver (TID) does not provide for any command-line options to configure the Engine. All configuration information must be provided in config files. By default, these are SAFSTID.INI files. See {@link SAFSTID Config Files for more information.

The Abbot supported config file items:

 [SAFS_ABBOT]
 AUTOLAUNCH=FALSE            Defaults to FALSE because config info must be valid.
 ;JVM=JVMpath                If "java" is not sufficient.
 ;CLASSPATH=altClasspath     Generally overrides system classpath.
 ;HOOK=org.safs.abbot.AbbotJavaHook  Class used as the engine Hook.
 ;OPTIONS=                   Normally never used.
 

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/RobotJ" -- The name of this engine as registered with STAF.
(package private) static java.lang.String	HOOK_CLASS "com.rational.test.ft.rational_ft" -- The Rational class that is RobotJ/XDE Tester.

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

Method Summary

Modifier and Type	Method and Description
void	launchInterface(java.lang.Object configInfo) Extracts configuration information and launches RobotJ/XDE Tester in a new process.
long	processRecord(TestRecordHelper testRecordData) Override superclass to catch unsuccessful initialization scenarios.

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/RobotJ" -- The name of this engine as registered with STAF.

See Also:

Constant Field Values

HOOK_CLASS

static final java.lang.String HOOK_CLASS

"com.rational.test.ft.rational_ft" -- The Rational class that is RobotJ/XDE Tester.

See Also:

Constant Field Values

Constructor Detail

SAFSABBOT

public SAFSABBOT()

Constructor for SAFSROBOTJ. Call launchInterface with an appropriate DriverInterface before attempting to use this minimally initialized object.

SAFSABBOT

public SAFSABBOT(DriverInterface driver)

PREFERRED Constructor for SAFSROBOTJ.

Method Detail

launchInterface

public void launchInterface(java.lang.Object configInfo)

Extracts configuration information and launches RobotJ/XDE Tester in a new process.

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)

Override superclass to catch unsuccessful initialization scenarios.

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