org.safs.tools.drivers

Class JSAFSDriver

java.lang.Object

org.safs.tools.drivers.AbstractDriver

org.safs.tools.drivers.DefaultDriver

org.safs.tools.drivers.JSAFSDriver

All Implemented Interfaces:

DriverInterface, ITestRecordStackable, PathInterface

public class JSAFSDriver
extends DefaultDriver
implements ITestRecordStackable

A class that provides easy access to SAFS functionality for non-SAFS programs and frameworks.

JSAFSDriver jsafs = new JSAFSDriver("JSAFS");
jsafs.run();
//do whatever you want with and without SAFS...
jsafs.processCommand(AbstractCommand, String);
jsafs.shutdown();

Using JSAFS.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADVANCED_RUNTIME_ID
static java.lang.String	ADVANCED_RUNTIME_LEVEL
static java.lang.String	ADVANCED_RUNTIME_PACKAGEROOT
static java.lang.String	ADVANCED_RUNTIME_TABLE
static boolean	AUTO_RESOLVE_TESTRECORD
java.lang.String	SEPARATOR "," The default separator that will be used when issuing SAFS commands.
StatusCounter	statuscounter
boolean	systemExitOnShutdown When SAFS Monitor usage is enabled (useSAFSMonitor=true), and the JSAFSDriver has detected the test or a user has initiated a JSAFSDriver shutdown through this mechanism, the default implementation of the JSAFSDriver processCommand(AbstractCommand, String) is to initiate System finalization followed by a System exit--a complete shutdown of the JVM running the tests.
TestRecordHelper	testRecordHelper
protected ITestRecordStackable	testrecordStackable The ITestRecordStackable used to store 'Test Record' in a FILO.

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

cycleLog, cycleStack, engineObjects, enginePreference, engines, safsmonitor, status, stepLog, stepStack, suiteLog, suiteStack, useSAFSMonitor

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

autoitcomponent, benchSource, configInfo, core, counterInfo, counts, cycleflowcontrol, cycleLinkedFac, cycleLogMode, cycleLogName, cycleSeparator, cycleSuffix, datapoolSource, debug, difSource, driverConfigPath, driverName, driverRootDir, exitCycle, exitSuite, expressionsOn, input, ipcommands, locator, logLevel, logs, logsSource, maps, millisBetweenRecords, perTableFlowControl, projectConfigPath, projectRootDir, statuscounts, stepflowcontrol, stepLinkedFac, stepLogMode, stepLogName, stepSeparator, stepSuffix, suiteflowcontrol, suiteLinkedFac, suiteLogMode, suiteLogName, suiteSeparator, suiteSuffix, testLevel, testName, testSource, tidcommands, tidcomponent, vars, verifySource

Fields inherited from interface org.safs.tools.drivers.DriverInterface

DRIVER_CONTROL_POF_VAR, DRIVER_CONTROL_POW_VAR, DRIVER_CONTROL_VAR

Constructor Summary

Constructors

Constructor and Description
JSAFSDriver(java.lang.String drivername)

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkSAFSMonitorStatus() Programmatically conform to user-initiated PAUSE, RUN, STEP, STEP RETRY input from SAFS Monitor.
void	closeMap(java.lang.String mapname) Convenience routine to close an App Map.
void	delayBetweenRecords() Try to delay a certain time AbstractDriver.getMillisBetweenRecords() between the executions. Normally, it is called after the execution of a command.
boolean	getAutomaticResolve()
CountStatusInterface	getCounterStatus(java.lang.String counterId) Retrieve a CounterStatusInterface object containing the current counts for the specified Counter.
static java.lang.StackTraceElement	getFirstNonSAFSStackTraceElement() Examine the calling Thread's Stack Trace and return the first StackTraceElement that is NOT from the org.safs...
java.lang.String	getMappedValue(java.lang.String mapid, java.lang.String section, java.lang.String item) Convenience routine to lookup the mapped value stored in the App Map chain.
java.lang.String	getVariable(java.lang.String varname) Convenience routine to retrieve the value of a SAFS Variable stored in SAFSVARS.
TestRecordHelper	initTestRecordData(TestRecordHelper store) Convienience (re)initializer for a TestRecordHelper.
void	logFAILED(java.lang.String message, java.lang.String description) Convenience routine to log FAILED message to the active SAFS log.
void	logGENERIC(java.lang.String message, java.lang.String description) Convenience routine to log GENERIC message to the active SAFS log.
void	logPASSED(java.lang.String message, java.lang.String description) Convenience routine to log PASSED message to the active SAFS log.
void	logWARNING(java.lang.String message, java.lang.String description) Convenience routine to log WARNING message to the active SAFS log.
static void	main(java.lang.String[] args) Self-Test some JSAFSDriver functionality.
void	openMap(java.lang.String mapname) Convenience routine to open an App Map.
TestRecordData	popTestRecord() Retrieve the Test-Record from the the Stack after the execution of a keyword.
TestRecordHelper	processCommand(AbstractCommand command) Execute the desired AbstractCommand using the default field separator for the record.
TestRecordHelper	processCommand(AbstractCommand command, java.lang.String separator) This method can process DriverCommand or ComponentFunction just as runDriverCommand() or runComponentFunction(), further more it includes the functionality of SAFSMonitor so users can interctively PAUSE, STEP, DEBUG their script and SHUTDOWN the engine hook.
protected TestRecordHelper	processCommandDirect(AbstractCommand command, java.lang.String separator) Execute the desired AbstractCommand using the specified field separator for the record.
protected long	processComponentFunction() Note: Before calling this method, you must call setGlobalTestRecordHelper(AbstractCommand, String, String) Execute the desired ComponentFunction using the specified field separator for the record.
protected long	processDriverCommand() Note: Before calling this method, you must call setGlobalTestRecordHelper(AbstractCommand, String, String) Execute the desired DriverCommand using the specified field separator for the record.
java.lang.String	processExpression(java.lang.String expression) Convenience routine to retrieve the value resulting from a standard SAFS Expression, The routine provides support identical to SAFS InputRecord expression processing.
protected java.lang.String	processExpression(java.lang.String testRecord, java.lang.String separator) This method is used to resolve the expressions within a test record, something like ^var=Text or ^varPrefix & ^varSuffix will be processed by the VariableService, some works like assignment of variable will be done during that period.
protected StatusInterface	processTest() Required abstract method is never really called since we have overridden run()
void	pushTestRecord(TestRecordData trd) Push the current 'test record' into the Stack before the execution of a keyword.
boolean	reinstateShutdownHook()
boolean	removeShutdownHook()
java.lang.String	resolveExpression(java.lang.String expression) Resolve an expression, which is an ONE-FIELD expression.
protected java.lang.String	resolveExpression(java.lang.String expressions, java.lang.String separator) Resolve a set of expressions delimited by separator.
static java.lang.String	resolveExpression(java.lang.String testRecord, java.lang.String separator, VarsInterface varService) Resolve the testRecord for supported "numeric/string expressions" and "DDVariable". If AbstractDriver.isExpressionsEnabled() is false, then "numeric/string expressions" will not be resolved; But the "DDVariable" will be always evaluated. The input record fields are delimited by the provided separator, and each field is separately processed for expressions. Note: How the wrapping-double-quotes are handled after evaluation?
protected long	routeToEngines(TestRecordHelper trd, boolean sendAll) Route the input record to one or more engines, or all engines.
protected long	routeToPreferredEngines(TestRecordHelper trd) Route the input record to preferred engines only in the order of preference.
void	run() Called to initialize the JSAFSDriver and make it ready for use.
TestRecordHelper	runComponentFunction(ComponentFunction command) Execute the desired ComponentFunction using the default field separator for the record.
TestRecordHelper	runComponentFunction(ComponentFunction command, java.lang.String separator) Execute the desired ComponentFunction using the specified field separator for the record.
protected TestRecordHelper	runComponentFunctionDirect(ComponentFunction command, java.lang.String separator) Deprecated. call processCommandDirect(AbstractCommand, String) instead
TestRecordHelper	runDriverCommand(DriverCommand command) Execute the desired DriverCommand using the default field separator for the record.
TestRecordHelper	runDriverCommand(DriverCommand command, java.lang.String separator) Execute the desired DriverCommand using the specified field separator for the record. This implementation tries following engines in this order:
protected TestRecordHelper	runDriverCommandDirect(DriverCommand command, java.lang.String separator) Deprecated. call processCommandDirect(AbstractCommand, String) instead
void	setAutomaticResolve(boolean automaticResolve)
protected void	setGlobalTestRecordHelper(AbstractCommand command, java.lang.String separator, java.lang.String record) Note: Before calling method processDriverCommand() and processComponentFunction() you MUST call this method to initialize the global variable testRecordHelper.
void	setVariable(java.lang.String varname, java.lang.String value) Convenience routine to set the value of a SAFS Variable stored in SAFSVARS.
void	shutdown() Used to shutdown the the driver and, potentially, all of SAFS once testing is complete.
protected void	validateTestParameters() Try to set the test parameters in the super class method. Then set the separator SEPARATOR according to current test level.

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

clearEnginePreferences, closeTestLogs, endEnginePreference, getEngineInterface, getEnginePreferences, getEngines, getFullEngineClass, getGenericInterface, getLogID, getPreferredEngine, getPreferredEngineIndex, getTestLevelSeparator, hasEnginePreferences, initializeMiscConfigInfo, initializePresetVariables, initializeRuntimeEngines, initializeRuntimeInterface, initLog, insertConfigureInterfaceSource, isPreferredEngine, isPreferredEngine, isUseSAFSMonitor, launchSAFSMonitor, openTestLogs, parseLogMode, setUseSAFSMonitor, shutdownRuntimeEngines, shutdownRuntimeInterface, startEnginePreference, validateLogParameters

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

addConfigureInterfaceSource, addStatusCounts, getAutoItComponentSupport, getBenchDir, getConfigureInterface, getConfigureLocator, getCoreInterface, getCountersInterface, getCycleLogMode, getCycleLogName, getCycleSeparator, getCycleSuffix, getDatapoolDir, getDebugInterface, getDifDir, getDriverName, getDriverRootDir, getFlowControlInterface, getInputInterface, getIPDriverCommands, getLogLevel, getLogsDir, getLogsInterface, getMapsInterface, getMillisBetweenRecords, getParameterValue, getProjectDirectoryInfo, getProjectRootDir, getRootDirectoryInfo, getRootVerifyDir, getStatusInterface, getStepLogMode, getStepLogName, getStepSeparator, getStepSuffix, getSuiteLogMode, getSuiteLogName, getSuiteSeparator, getSuiteSuffix, getTestDir, getTestLevel, getTestName, getTIDDriverCommands, getTIDGUIlessComponentSupport, getVarsInterface, incrementGeneralStatus, incrementTestStatus, isExitCycle, isExitSuite, isExpressionsEnabled, isModifiedConfig, isModifiedRoot, isPerTableFlowControl, logMessage, processEmbeddedVariable, resetModifiedProperties, setBenchDir, setDatapoolDir, setDifDir, setExitCycle, setExitSuite, setExpressionsEnabled, setLogsDir, setMillisBetweenRecords, setPerTableFlowControl, setProjectRootDir, setRootVerifyDir, setTestDir, validateRootConfigureParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADVANCED_RUNTIME_ID

public static final java.lang.String ADVANCED_RUNTIME_ID

See Also:

Constant Field Values

ADVANCED_RUNTIME_TABLE

public static final java.lang.String ADVANCED_RUNTIME_TABLE

See Also:

Constant Field Values

ADVANCED_RUNTIME_LEVEL

public static final java.lang.String ADVANCED_RUNTIME_LEVEL

See Also:

Constant Field Values

ADVANCED_RUNTIME_PACKAGEROOT

public static final java.lang.String ADVANCED_RUNTIME_PACKAGEROOT

See Also:

Constant Field Values

statuscounter

public StatusCounter statuscounter

testRecordHelper

public TestRecordHelper testRecordHelper

testrecordStackable

protected ITestRecordStackable testrecordStackable

The ITestRecordStackable used to store 'Test Record' in a FILO.

systemExitOnShutdown

public boolean systemExitOnShutdown

When SAFS Monitor usage is enabled (useSAFSMonitor=true), and the JSAFSDriver has detected the test or a user has initiated a JSAFSDriver shutdown through this mechanism, the default implementation of the JSAFSDriver processCommand(AbstractCommand, String) is to initiate System finalization followed by a System exit--a complete shutdown of the JVM running the tests.

If the developer does NOT want a such a complete shutdown to occur upon a JSAFSDriver shutdown, then this field should be set to 'false'.
The default setting is 'true'.

See Also:

DefaultDriver.useSAFSMonitor, processCommand(AbstractCommand, String)

SEPARATOR

public java.lang.String SEPARATOR

"," The default separator that will be used when issuing SAFS commands.

AUTO_RESOLVE_TESTRECORD

public static boolean AUTO_RESOLVE_TESTRECORD

Constructor Detail

JSAFSDriver

public JSAFSDriver(java.lang.String drivername)

Method Detail

removeShutdownHook

public boolean removeShutdownHook()

reinstateShutdownHook

public boolean reinstateShutdownHook()

getAutomaticResolve

public boolean getAutomaticResolve()

setAutomaticResolve

public void setAutomaticResolve(boolean automaticResolve)

logGENERIC

public void logGENERIC(java.lang.String message,
                       java.lang.String description)

Convenience routine to log GENERIC message to the active SAFS log.
The routine uses the AbstractLogFacility.GENERIC_MESSAGE type.

Parameters:

message - String message

description - String (optional) for more detailed info. Can be null.

See Also:

AbstractDriver.logMessage(String, String, int)

logPASSED

public void logPASSED(java.lang.String message,
                      java.lang.String description)

Convenience routine to log PASSED message to the active SAFS log.
The routine uses the AbstractLogFacility.PASSED_MESSAGE type.

Parameters:

message - String message

description - String (optional) for more detailed info. Can be null.

See Also:

AbstractDriver.logMessage(String, String, int)

logFAILED

public void logFAILED(java.lang.String message,
                      java.lang.String description)

Convenience routine to log FAILED message to the active SAFS log.
The routine uses the AbstractLogFacility.FAILED_MESSAGE type.

Parameters:

message - String message

description - String (optional) for more detailed info. Can be null.

See Also:

AbstractDriver.logMessage(String, String, int)

logWARNING

public void logWARNING(java.lang.String message,
                       java.lang.String description)

Convenience routine to log WARNING message to the active SAFS log.
The routine uses the AbstractLogFacility.WARNING_MESSAGE type.

Parameters:

message - String message

description - String (optional) for more detailed info. Can be null.

See Also:

AbstractDriver.logMessage(String, String, int)

getVariable

public java.lang.String getVariable(java.lang.String varname)

Convenience routine to retrieve the value of a SAFS Variable stored in SAFSVARS.
This will exploit the SAFSMAPS look-thru and app map chaining mechanism.
That is, any variable that does NOT exist in SAFSVARS will be sought as an ApplicationConstant in the SAFSMAPS service.

See Test Design Guidelines for Localization.

Parameters:

varname -

Returns:

String value, or an empty String.

See Also:

AbstractDriver.getVarsInterface()

setVariable

public void setVariable(java.lang.String varname,
                        java.lang.String value)

Convenience routine to set the value of a SAFS Variable stored in SAFSVARS.

Parameters:

varname - -- Name of variable to set.

value - to store for varname.

See Also:

AbstractDriver.getVarsInterface()

openMap

public void openMap(java.lang.String mapname)
             throws java.lang.IllegalArgumentException

Convenience routine to open an App Map. This can be used instead of using the Driver Command "SetApplicationMap". Note: opening an App Map and app map chaining works in LIFO order. The last App Map opened becomes the "default" App Map.

Parameters:

mapname - -- Name of app map to open and add to any app map chain. The exact same mapname (not case-sensitive) must be used to closeAppMap.

Throws:

java.lang.IllegalArgumentException - if mapname is null or cannot be resolved to a valid App Map filepath by the driver.

See Also:

#closeAppMap(String), SAFSMAPS.openMap(org.safs.tools.input.UniqueMapInterface)

closeMap

public void closeMap(java.lang.String mapname)
              throws java.lang.IllegalArgumentException

Convenience routine to close an App Map. This can be used instead of using the Driver Command "CloseApplicationMap". Note: Closing an app map removes it from any App Map chain. If the closed App Map was the "default" app map then the last App Map still existing in the App Map chain becomes the "default" App Map.

Parameters:

mapname - -- Name of app map to close and remove from any app map chain. The name used must be the same name used in the openMap call or the SetApplicationMap Driver Command. The mapname, however, is not case-sensitive.

Throws:

java.lang.IllegalArgumentException - if mapname is null or cannot be resolved to a valid App Map filepath by the driver.

See Also:

#openAppMap(String), SAFSMAPS.closeMap(org.safs.tools.UniqueIDInterface)

processExpression

public java.lang.String processExpression(java.lang.String expression)

Convenience routine to retrieve the value resulting from a standard SAFS Expression,
The routine provides support identical to SAFS InputRecord expression processing. However, it assumes (and requires) that only a single value/expression/field is being processed.
Note: if AbstractDriver.isExpressionsEnabled() is false, the expression will be returned directly.
Note: if the expression is double-quoted, then it will NOT be evaluated.

Parameters:

expression - -- a standard SAFS expression to process.

Returns:

String value after the expression has been processed. This can result in an empty String or null if the expression is null. May return the expression unmodified if we cannot resolve an unused character to pass to SAFS as an unused separator for the expression.

See Also:

AbstractDriver.getVarsInterface(), AbstractDriver.isExpressionsEnabled(), resolveExpression(String)

processExpression

protected java.lang.String processExpression(java.lang.String testRecord,
                                             java.lang.String separator)

This method is used to resolve the expressions within a test record, something like ^var=Text or ^varPrefix & ^varSuffix will be processed by the VariableService, some works like assignment of variable will be done during that period. One thing to take care: after the resolveExpression, each field will be quoted by ", for example, "C, AppMapResolve, OFF" --> ""C", "AppMapResolve", "OFF"" we should call TestRecordData.getTrimmedUnquotedInputRecordToken(int) to get each field.

Parameters:

testRecord - a normal test record string

separator - the separator used in the test record

Returns:

the resolved test record string

resolveExpression

public java.lang.String resolveExpression(java.lang.String expression)

Resolve an expression, which is an ONE-FIELD expression. "DDVariable" will be always evaluated.
Note: Only when AbstractDriver.isExpressionsEnabled() is true, the expression will be resolved as "numeric/string expression".
No mater what AbstractDriver.isExpressionsEnabled() is, the expression will be resolved as "DDVariable"
For example, String result = resolveExpression("^var=3+5");
If AbstractDriver.isExpressionsEnabled() is false, the result is "3+5", and variable "var" contains string "3+5"
If AbstractDriver.isExpressionsEnabled() is true, the result is "8", and variable "var" contains string "8"
Note: Be careful, the expression will be TRIMMED and then evaluated.
For example, String result = resolveExpression(" 3+5 ");
If AbstractDriver.isExpressionsEnabled() is false, the result is string "3+5".
If AbstractDriver.isExpressionsEnabled() is true, the result is string "8".

Parameters:

expression - String, the expression to be resolved.

Returns:

String, the resolved expressions.

resolveExpression

protected java.lang.String resolveExpression(java.lang.String expressions,
                                             java.lang.String separator)

Resolve a set of expressions delimited by separator. "DDVariable" will be always evaluated.
Please refer to description of method resolveExpression(String, String, VarsInterface).

Parameters:

expressions - String, a set of expression delimited by separator, such as "expression1, expression2, expression3"

separator - String, the separator used to delimit expressions

Returns:

String, the resolved expressions.

See Also:

resolveExpression(String, String, VarsInterface)

resolveExpression

public static java.lang.String resolveExpression(java.lang.String testRecord,
                                                 java.lang.String separator,
                                                 VarsInterface varService)

Resolve the testRecord for supported "numeric/string expressions" and "DDVariable".
If AbstractDriver.isExpressionsEnabled() is false, then "numeric/string expressions" will not be resolved; But the "DDVariable" will be always evaluated.
The input record fields are delimited by the provided separator, and each field is separately processed for expressions.

Note: How the wrapping-double-quotes are handled after evaluation?

   After evaluation, each field will be double-quoted, but sometimes we don't want that wrapping double quote.
   Below is the strategy to handle the wrapping double quotes in the evaluated result.
   If testRecord contains more than one field, the wrapping double quote will be kept for each field.
   If testRecord contains only one field,
     if the original field is double-quoted, then do NOT remove the wrapping double quote
     otherwise (single-field and not-double-quoted) , remove the wrapping double quote
 

Note: How the double-quoted field is handled?

   If the field has already been double-quoted, it will NOT be trimmed and evaluated (which means untouched).
   For example, String result = resolveExpression("\" 3+5  \",\" >  \",\"9-3  \"", ",");
   Whether AbstractDriver.isExpressionsEnabled() is true or false, the result is always string "" 3+5  "," >  ","9-3  "", each field remains untouched.
 

Note: How AbstractDriver.isExpressionsEnabled() affects the result?

   Only when AbstractDriver.isExpressionsEnabled() is true, each field will be resolved as "numeric/string expressions".
   No mater what AbstractDriver.isExpressionsEnabled() is, each field will be resolved as "DDVariable".
   For example, String result = resolveExpression("^var=3+5", ",");
   If AbstractDriver.isExpressionsEnabled() is false, the result is "3+5", and variable "var" contains string "3+5"
   If AbstractDriver.isExpressionsEnabled() is true, the result is "8", and variable "var" contains string "8"
 

Note: How non-double-quoted field is handled?

   Each field will be TRIMMED and then evaluated, the evaluated value will be WRAPPED in DOUBLE-QUOTE to return.
   For example, String result = resolveExpression(" 3+5  , >  ,9-3  ", ",");
   If AbstractDriver.isExpressionsEnabled() is false, the result is string ""3+5",">","9-3"", each field has been wrapped in double quote.
   If AbstractDriver.isExpressionsEnabled() is true, the result is string ""8",">","6"", each field has been wrapped in double quote.
 

Parameters:

testRecord - String, the test record. It can contain more than one field, these fields are delimited by a separator indicated by the 2th parameter 'separator'.

separator - String, the separator to split the testRecord

varService - VarsInterface, the variable service instance used to resolve testRecord

Returns:

String, the resolved expression.
null if testRecord is null.
testRecord itself if separator is null.

See Also:

AbstractDriver.isExpressionsEnabled()

getMappedValue

public java.lang.String getMappedValue(java.lang.String mapid,
                                       java.lang.String section,
                                       java.lang.String item)

Convenience routine to lookup the mapped value stored in the App Map chain.
This should support dynamic recognition strings.

See Test Design Guidelines for Localization.

Parameters:

mapid - -- Name\ID of the Map to use for the lookup. Use null for Default Map.

section - -- Name of the Section in the Map for the lookup. Use null for Default Section [ApplicationConstants].

item - -- Name of the Item to lookup in the define Map Section.

Returns:

String value, or an empty String.

See Also:

AbstractDriver.getMapsInterface()

initTestRecordData

public TestRecordHelper initTestRecordData(TestRecordHelper store)

Convienience (re)initializer for a TestRecordHelper.
Most users don't need to call this if using methods like runDriverCommand(DriverCommand) and runComponentFunction(ComponentFunction).

Instantiates and\or reinits a TestRecordHelper and initializes key properties:

• setFac=cycleLog ID (required)
• setFileID="JSAFS" (arbitrary ID since we are not processing a test table)
• setFilename="Advanced Runtime" (arbitrary since we are not processing a test table)
• setTestLevel="STEP"
• setSeparator=SEPARATOR (current value of SEPARATOR)
• setStatusCode=DriverConstant.STATUS_SCRIPT_NOT_EXECUTED
• setStatusInfo="" (empty)

Parameters:

store - - A TestRecordHelper to reinitialize or null to get a new one initialized.

Returns:

TestRecordHelper

See Also:

TestRecordData.reinit();

validateTestParameters

protected void validateTestParameters()

Try to set the test parameters in the super class method.
Then set the separator SEPARATOR according to current test level.

Overrides:

validateTestParameters in class DefaultDriver

See Also:

DefaultDriver.validateTestParameters()

setGlobalTestRecordHelper

protected void setGlobalTestRecordHelper(AbstractCommand command,
                                         java.lang.String separator,
                                         java.lang.String record)

Note: Before calling method processDriverCommand() and processComponentFunction()
you MUST call this method to initialize the global variable testRecordHelper.

Parameters:

command - An instance of AbstractCommand which is abstract, so it is indeed
an instance of its child class, DriverCommand or ComponentFunction

separator - The separator used to create test-record from AbstractCommand.

record - If it is null, a test-record generated from AbstractCommand
will be set as the input-record to TestRecordHelper.
Otherwise, if it is not null, it will be set as the input-record to TestRecordHelper.

processDriverCommand

protected long processDriverCommand()

Note: Before calling this method,
you must call setGlobalTestRecordHelper(AbstractCommand, String, String)
Execute the desired DriverCommand using the specified field separator for the record.
This implementation tries following engines in this order:

AbstractDriver.getTIDDriverCommands()
routeToPreferredEngines(TestRecordHelper)
routeToEngines(TestRecordHelper, boolean)

Returns:

A long value to represent the status of execution.
It is a constant defined in DriverConstant, such as STATUS_SCRIPT_NOT_EXECUTED

processComponentFunction

protected long processComponentFunction()

Note: Before calling this method,
you must call setGlobalTestRecordHelper(AbstractCommand, String, String)
Execute the desired ComponentFunction using the specified field separator for the record.
This implementation tries various possible engines based on the standard usage of:

AbstractDriver.getTIDGUIlessComponentSupport()
routeToPreferredEngines(TestRecordHelper)
routeToEngines(TestRecordHelper, boolean)

Returns:

A long value to represent the status of execution.
It is a constant defined in DriverConstant, such as STATUS_SCRIPT_NOT_EXECUTED

getCounterStatus

public CountStatusInterface getCounterStatus(java.lang.String counterId)

Retrieve a CounterStatusInterface object containing the current counts for the specified Counter.

Parameters:

counterId - -- the Id of the Counter from which to get status counts.

Returns:

CounterStatusInterface Object or null if no such Counter is known.

checkSAFSMonitorStatus

public java.lang.String checkSAFSMonitorStatus()
                                        throws SAFSException

Programmatically conform to user-initiated PAUSE, RUN, STEP, STEP RETRY input from SAFS Monitor.

This method is used to check for and comply with user input to SAFS Monitor, but cannot provide PAUSE_ON_FAILURE support.

The PAUSE and other features are only checked if DefaultDriver.useSAFSMonitor is 'true'.

A given status will perform the following functions:

STOP (SHUTDOWN_HOOK) - Throw the SAFSException.
PAUSE - sleep 1 second and loop to check again (indefinitely).
RUNNING - Do nothing. Immediately return with RUNNING status.
STEP - While PAUSED, immediately return with STEPPING status.
STEPPING - Enter PAUSE mode when this method is called again.
STEP_RETRY - While PAUSED, immediately return with STEPPING_RETRY status.
STEPPING_RETRY - Enter PAUSE mode when this method is called again.

Returns:

the current status of the SAFS_DRIVER_CONTROL variable.

Throws:

SAFSException - if SHUTDOWN_HOOK was detected. This routine only throws the Exception. It does not attempt a JVM shutdown.

processCommand

public TestRecordHelper processCommand(AbstractCommand command,
                                       java.lang.String separator)

This method can process DriverCommand or ComponentFunction just as runDriverCommand() or runComponentFunction(), further more it includes the functionality of SAFSMonitor so users can interctively PAUSE, STEP, DEBUG their script and SHUTDOWN the engine hook.

This method will automatically be called from runDriverCommand or runComponentFunction if DefaultDriver.useSAFSMonitor=true -- which it is by default. If the developer wants to disable this feature the developer should set useSAFSMonitor to 'false'.

If this method detects a user initiated shutdown request via SAFS Monitor, or if the running test initiates the same type of shutdown request, this method will initiate a full JVM finalization and System.exit if systemExitOnShutdown=true -- which it is by default. If the developer wants to disable the automatic JVM finalization and shutdown feature then the developer should set systemExitOnShutdown to 'false'.

Parameters:

command - An instance of AbstractCommand which is abstract, so it is
an instance of its child class, DriverCommand or ComponentFunction

separator - The separator used to create test-record from AbstractCommand.

Returns:

TestRecordHelper with result information. TestRecordData.getStatusCode() and TestRecordData.getStatusInfo()

See Also:

DefaultDriver.useSAFSMonitor, systemExitOnShutdown, runDriverCommand(DriverCommand), runComponentFunction(ComponentFunction)

processCommand

public TestRecordHelper processCommand(AbstractCommand command)

Execute the desired AbstractCommand using the default field separator for the record.
Calls processCommand(AbstractCommand, String).

Parameters:

command - AbstractCommand command to execute

Returns:

TestRecordHelper with result information in TestRecordData.getStatusCode() and TestRecordData.getStatusInfo()

processCommandDirect

protected TestRecordHelper processCommandDirect(AbstractCommand command,
                                                java.lang.String separator)

Execute the desired AbstractCommand using the specified field separator for the record. This execution will not be controlled by SAFSMonitor
This method should be used internally, not by JSAFS user.

Parameters:

command - AbstractCommand command to execute

separator - for test record fields

Returns:

TestRecordHelper with result information in TestRecordData.getStatusCode() and TestRecordData.getStatusInfo()

runDriverCommandDirect

protected TestRecordHelper runDriverCommandDirect(DriverCommand command,
                                                  java.lang.String separator)

Deprecated. call processCommandDirect(AbstractCommand, String) instead

Execute the desired DriverCommand using the specified field separator for the record.
This execution will not be controlled by SAFSMonitor
This method should be used internally, not by JSAFS user.

Parameters:

command -

separator -

Returns:

TestRecordHelper with result information in TestRecordData.getStatusCode() and TestRecordData.getStatusInfo()

runDriverCommand

public TestRecordHelper runDriverCommand(DriverCommand command,
                                         java.lang.String separator)

Execute the desired DriverCommand using the specified field separator for the record.

This implementation tries following engines in this order:

AbstractDriver.getTIDDriverCommands()
routeToPreferredEngines(TestRecordHelper)
routeToEngines(TestRecordHelper, boolean)

Parameters:

command -

separator -

Returns:

TestRecordHelper with result information in TestRecordData.getStatusCode() and TestRecordData.getStatusInfo()

runDriverCommand

public TestRecordHelper runDriverCommand(DriverCommand command)

Execute the desired DriverCommand using the default field separator for the record.
Calls runDriverCommand(DriverCommand, String)

Parameters:

command -

Returns:

TestRecordHelper with result information in TestRecordData.getStatusCode() and TestRecordData.getStatusInfo()

runComponentFunctionDirect

protected TestRecordHelper runComponentFunctionDirect(ComponentFunction command,
                                                      java.lang.String separator)

Deprecated. call processCommandDirect(AbstractCommand, String) instead

Execute the desired ComponentFunction using the specified field separator for the record. This execution will not be controlled by SAFSMonitor
This method should be used internally, not by JSAFS user.