org.safs.tools.engines

Class TIDDriverLogCommands

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.TIDDriverLogCommands

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface, Versionable

public class TIDDriverLogCommands
extends GenericEngine

Provides local in-process support for DriverLogCommands. 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 Bob Lawler Jan 18, 2006 Updated cmdLogMessage to better handle empty descriptions (RJL) Lei Wang Apr 08, 2008 Add SuspendLogging and ResumeLogging Carl Nagle FEB 04, 2010 Added missing SuspendLogging and ResumeLogging messages Carl Nagle SEP 17, 2014 Fixing SAFS Crashes due to incomplete initialization.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	COMMAND_LOGFAILUREOK "LogFailureOK"
(package private) static java.lang.String	COMMAND_LOGMESSAGE "LogMessage"
(package private) static java.lang.String	COMMAND_LOGTESTFAILURE "LogTestFailure"
(package private) static java.lang.String	COMMAND_LOGTESTSUCCESS "LogTestSuccess"
(package private) static java.lang.String	COMMAND_LOGTESTWARNING "LogTestWarning"
(package private) static java.lang.String	COMMAND_LOGWARNINGOK "LogWarningOK"
(package private) static java.lang.String	ENGINE_NAME "SAFS/TIDDriverLogCommands"
(package private) static java.lang.String	RESUMELOGGING
(package private) static java.lang.String	SUSPENDLOGGING

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
TIDDriverLogCommands() Constructor for TIDDriverCommands
TIDDriverLogCommands(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, 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/TIDDriverLogCommands"

See Also:

Constant Field Values

COMMAND_LOGMESSAGE

static final java.lang.String COMMAND_LOGMESSAGE

"LogMessage"

See Also:

Constant Field Values

COMMAND_LOGTESTFAILURE

static final java.lang.String COMMAND_LOGTESTFAILURE

"LogTestFailure"

See Also:

Constant Field Values

COMMAND_LOGTESTSUCCESS

static final java.lang.String COMMAND_LOGTESTSUCCESS

"LogTestSuccess"

See Also:

Constant Field Values

COMMAND_LOGTESTWARNING

static final java.lang.String COMMAND_LOGTESTWARNING

"LogTestWarning"

See Also:

Constant Field Values

COMMAND_LOGFAILUREOK

static final java.lang.String COMMAND_LOGFAILUREOK

"LogFailureOK"

See Also:

Constant Field Values

COMMAND_LOGWARNINGOK

static final java.lang.String COMMAND_LOGWARNINGOK

"LogWarningOK"

See Also:

Constant Field Values

SUSPENDLOGGING

static final java.lang.String SUSPENDLOGGING

See Also:

Constant Field Values

RESUMELOGGING

static final java.lang.String RESUMELOGGING

See Also:

Constant Field Values

Constructor Detail

TIDDriverLogCommands

public TIDDriverLogCommands()

Constructor for TIDDriverCommands

TIDDriverLogCommands

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