Processor (SAFS API DOCUMENT)

java.lang.Object
- org.safs.Processor

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

Direct Known Subclasses:

ComponentFunction, DriverCommand, DriverCommandProcessor, EngineCommandProcessor, TestStepProcessor
```
public abstract class Processor
extends java.lang.Object
implements RuntimeDataInterface, ITestRecordStackable
```
Abstract Processor, enforces that the 'process' and 'isSupportedRecordType' methods be implemented.

Since:

JUN 03, 2003

Author:

Doug Bauman

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`breakpointsOn` All processor instances may enable/disable and force breakpoints where they deem this appropriate.
`static java.lang.String`	`CASE_INSENSITIVE_FLAG`
`static java.lang.String`	`CASEINSENSITIVE_FLAG`
`protected static boolean`	`clearProxiesAlways`
`protected static boolean`	`commandLineBreakpoint`
`protected static java.lang.String`	`customStr`
`protected static GetText`	`customText`
`protected static int`	`DEBUG_MESSAGE` Convenience for local referencing instead of referencing AbstractLogFacility.
`protected static java.lang.String`	`debugStr`
`protected static GetText`	`debugText`
`static java.lang.String`	`DEFAULT_CUSTOM_PROCESSOR_PACKAGE`
`static java.lang.String`	`DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE`
`static java.lang.String`	`DEFAULT_PROCESSOR_PACKAGE` "org.safs" Default package for Processor subclasses used to execute test data.
`protected static int`	`FAILED_MESSAGE` Log MessageType for local referencing.
`protected static int`	`FAILED_OK_MESSAGE` Log MessageType for local referencing.
`protected static java.lang.String`	`failedStr`
`protected static GetText`	`failedText`
`protected static java.lang.String`	`FAILURE_DETAIL` GetText.text() keyword.
`protected static int`	`GENERIC_MESSAGE` Convenience for local referencing instead of referencing AbstractLogFacility.
`protected static java.lang.String`	`genericStr`
`protected static GetText`	`genericText`
`protected static java.lang.String`	`LINE_FAILURE_4` GetText.text() keyword.
`protected LogUtilities`	`log`
`protected boolean`	`myBreakpointsOn` Individual processor instances may enable/disable and force breakpoints where they deem this appropriate.
`protected static java.lang.String`	`otherStr`
`protected static GetText`	`otherText`
`protected static java.lang.String`	`PARAM_SIZE_1` GetText.text() keyword.
`protected static java.lang.String`	`PARAM_SIZE_2` GetText.text() keyword.
`protected static java.lang.String`	`PARAM_SIZE_3` GetText.text() keyword.
`protected static java.lang.String`	`PARAM_SIZE_4` GetText.text() keyword.
`protected java.util.Collection`	`params` Purpose: the collection of params Initialized: constructor
`protected static int`	`PASSED_MESSAGE` Log MessageType for local referencing.
`protected static java.lang.String`	`passedStr`
`protected static GetText`	`passedText`
`protected static java.lang.String`	`PRE_TXT_SUCCESS_4` GetText.text() keyword.
`protected static java.lang.String`	`PRE_TXT_SUCCESS_5` GetText.text() keyword.
`protected static boolean`	`processorConfigSet`
`protected java.util.Map`	`processorMap` keeps instantiated processors for reuse
`protected boolean`	`recordProcessed` Status for whether the processor processed the record, if the processor fails to support the record it has been given, then the processor should set this to false, so that any processor chain can continue to the next processor, if one is available.
`static java.lang.String`	`RECTYPE_DRIVER_COMMAND` "C" Record Type Constant
`static java.lang.String`	`RECTYPE_DRIVER_COMMAND_F` "CF" Record Type Constant
`static java.lang.String`	`RECTYPE_DRIVER_COMMAND_W` "CW" Record Type Constant
`static java.lang.String`	`RECTYPE_TEST_STEP` "T" Record Type Constant
`static java.lang.String`	`RECTYPE_TEST_STEP_F` "TF" Record Type Constant
`static java.lang.String`	`RECTYPE_TEST_STEP_W` "TW" Record Type Constant
`protected static boolean`	`RFSMCache`
`protected static boolean`	`RFSMOnly`
`static java.lang.String`	`RFT_FIND_SEARCH_MODE_ALGORITHM` "RFSMOnly"
`static java.lang.String`	`RFT_FIND_SEARCH_MODE_CACHE` "RFSMCache"
`static java.lang.String`	`SAFS_CLEARPROXIESALWAYS_ITEM` "clearProxiesAlways"
`static java.lang.String`	`SAFS_COMMANDLINEBREAKPOINT_ITEM` "commandLineBreakpoint"
`static java.lang.String`	`SAFS_COMMANDLINEBREAKPOINT_VARIABLE` "safs.commandLineBreakpoint"
`static java.lang.String`	`SAFS_PARAMS_FILE` "safsparams.dat"
`static java.lang.String`	`SAFS_RESBUN_NAME`
`static java.lang.String`	`SAFS_SECSWAITFORCOMPONENT_ITEM` "secsWaitForComponent"
`static java.lang.String`	`SAFS_SECSWAITFORCOMPONENT_VARIABLE` "safs.secsWaitForComponent"
`static java.lang.String`	`SAFS_SECSWAITFORWINDOW_ITEM` "secsWaitForWindow"
`static java.lang.String`	`SAFS_SECSWAITFORWINDOW_VARIABLE` "safs.secsWaitForWindow"
`static java.lang.String`	`SAFS_TESTDOMAINS_ITEM` "testDomains" Config setting should contain semi-colon delimited combinations of values: Java;Html;Net;Win
`static java.lang.String`	`SAFS_TESTDOMAINS_VARIABLE` "safs.testDomains"
`protected static int`	`secsWaitForComponent`
`protected static int`	`secsWaitForWindow`
`protected static java.lang.String`	`SENT_MSG_3` GetText.text() keyword.
`protected static java.lang.String`	`testDomains`
`protected TestRecordHelper`	`testRecordData` Purpose: holds the testRecordData info Initialized: constructor
`protected ITestRecordStackable`	`testrecordStackable` The ITestRecordStackable used to store 'Test Record' in a FILO.
`protected static java.lang.String`	`TXT_FAILURE_1` GetText.text() keyword.
`protected static java.lang.String`	`TXT_FAILURE_2` GetText.text() keyword.
`protected static java.lang.String`	`TXT_FAILURE_3` GetText.text() keyword.
`protected static java.lang.String`	`TXT_FAILURE_4` GetText.text() keyword.
`protected static java.lang.String`	`TXT_FAILURE_5` GetText.text() keyword.
`protected static java.lang.String`	`TXT_SUCCESS_1` GetText.text() keyword.
`protected static java.lang.String`	`TXT_SUCCESS_2` GetText.text() keyword.
`protected static java.lang.String`	`TXT_SUCCESS_2a` GetText.text() keyword.
`protected static java.lang.String`	`TXT_SUCCESS_3` GetText.text() keyword.
`protected static java.lang.String`	`TXT_SUCCESS_3a` GetText.text() keyword.
`protected static java.lang.String`	`TXT_SUCCESS_4` GetText.text() keyword.
`protected static java.lang.String`	`TXT_SUCCESS_5` GetText.text() keyword.
`protected static java.lang.String`	`unexpectedAlertBehaviour` How to handle the 'alert dialog' if it is visible unexpectedly, it could be set as 'accept' or 'dismiss' or 'ignore'
`protected static int`	`WARNING_MESSAGE` Log MessageType for local referencing.
`protected static int`	`WARNING_OK_MESSAGE` Log MessageType for local referencing.
`protected static java.lang.String`	`warningStr`
`protected static GetText`	`warningText`

Constructor Summary

Constructors
Constructor and Description

Processor()

Purpose: constructor

Constructors
Constructor and Description
`Processor()` Purpose: constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected static void`	`activateBreakpoint(java.lang.String breakpoint_message)` Activate the SAFSBreakpointException breakpoint.
`protected static void`	`checkBreakpoints(java.lang.String breakpoint_message)` test for enabled breakpoints and active a breakpoint if enabled.
`protected void`	`checkMyBreakpoints(java.lang.String breakpoint_message)` test for enabled breakpoints and active a breakpoint if enabled.
`protected java.io.File`	`deduceBenchFile(java.lang.String filename)` Deduce the absolute full path bench-relative file.
`protected java.io.File`	`deduceDiffFile(java.lang.String filename)` Deduce the absolute full path Diff-relative file.
`protected java.io.File`	`deduceProjectFile(java.lang.String filename)` Deduce the absolute full path to a project-relative file.
`protected java.io.File`	`deduceTestFile(java.lang.String filename)` Deduce the absolute full path test-relative file.
`protected boolean`	`delay(int millisec)`
`void`	`distributeConfigInformation()`
`protected java.lang.String`	`getAbsolutFileName(java.lang.String filename, java.lang.String directory)`
`java.util.Collection`	`getAlternateParams()`
`java.lang.String`	`getAppMapItem(java.lang.String appMapID, java.lang.String section, java.lang.String item)` Retrieve the resolved value of an item stored in the App Map chain (SAFSMAPS).
`Processor`	`getChainedProcessor()` Returns chained processor to interpret test data, if any.
`protected Processor`	`getClassInstance(java.lang.String classname)` Instance a given Processor from the provided classname.
`static boolean`	`getClearProxiesAlways()`
`protected java.util.ArrayList`	`getCustomProcClassNames()` Attempts to locate a class for the current customProcInstancePath.
`java.lang.String`	`getCustomProcInstancePath()` Return the current customProcInstancePath setting.
`LogUtilities`	`getLogUtilities()`
`java.util.Collection`	`getParams()`
`protected java.util.ArrayList`	`getProcClassNames()` Attempts to locate a class for the current procInstancePath.
`Processor`	`getProcInstance()` Return/Create an instance of the actual processor used to interpret test data.
`java.lang.String`	`getProcInstancePath()` Return the current procInstancePath setting.
`protected boolean`	`getRequiredField(int findex, java.lang.String fname, java.lang.String fvalue)` Retrieve a non-empty field value from the testRecordData inputrecord.
`static int`	`getSecsWaitForComponent()`
`static int`	`getSecsWaitForWindow()`
`protected java.lang.String`	`getStandardErrorMessage(java.lang.String failure)` Retrieve the standard "SOMETHING failure in filename FILENAME at line LINENUMBER" message.
`TestRecordHelper`	`getTestRecordData()`
`static java.lang.String`	`getUnexpectedAlertBehaviour()` Get how the 'alert dialog' will be handled if it is visible unexpectedly.
`java.lang.String`	`getVariable(java.lang.String var)` Retrieve the current runtime value of the global variable (SAFSVARS).
`boolean`	`hasChainedProcessor()` True if this processor has an instance of a chained processor to interpret test data if this one does not succeed in processing the data.
`protected boolean`	`initProcessorAndProcess(Processor aprocessor, java.util.Collection params)` Init the processor and process a record Initializes the processor by passing it the currently active LogUtilities, TestRecordHelper, and extracted record parameters.
`protected boolean`	`instanceProcessorAndProcess(java.lang.String instanceName, java.util.Collection params)` Tries to instance a processor and then process a record.
`static boolean`	`isBreakpointsOn()` test if breakpoints is enabled.
`static boolean`	`isComponentFunctionRecord(java.lang.String recordType)` Convenience routine for isSupportedRecordType to return true if the Processor supports standard Component Function records.
`static boolean`	`isDriverCommandRecord(java.lang.String recordType)` Convenience routine for isSupportedRecordType to return true if the Processor supports standard Driver Command records.
`boolean`	`isEngineCommandRecord(java.lang.String recordType)` Convenience routine for isSupportedRecordType to return true if the Processor supports standard Engine Command records.
`boolean`	`isMyBreakpointsOn()` test if breakpoints is enabled.
`boolean`	`isRecordProcessed()`
`static boolean`	`isRFSMCache()`
`static boolean`	`isRFSMOnly()`
`protected void`	`issueActionFailure(java.lang.String error)` Unable to perform [action].
`protected void`	`issueActionOnXFailure(java.lang.String x, java.lang.String error)` Unable to perform [action].
`protected void`	`issueErrorPerformingAction(java.lang.String error)` "Error performing [action]." "Error at line [number] in file [file]: [error]"
`protected void`	`issueErrorPerformingActionOnX(java.lang.String x, java.lang.String error)` "Error performing [action] on [x]." "Error at line [number] in file [file]: [error]"
`protected void`	`issueErrorPerformingActionUsing(java.lang.String x, java.lang.String error)` "[action] was not successful using [x]." "Error at line [number] in file [file]: [error]"
`protected void`	`issueInputRecordFailure(java.lang.String error)` Unable to perform [action].
`protected void`	`issueInputRecordFailure(java.lang.String message, java.lang.String error)` If [message]==null Unable to perform [action].
`protected void`	`issuePassedSuccess(java.lang.String message, java.lang.String detail)` issue OK status and PASSED message. If [message]==null [action] successful. [detail] If [message]!=null [message] [detail] string comment is expected to already be localized, but can be null.
`abstract boolean`	`isSupportedRecordType(java.lang.String recordType)` Determine support for a particular record type.
`protected void`	`logFailureMessage(java.lang.String aborttext, java.lang.String details, java.lang.String error)` Write failure to log. Write failure to debug log.
`protected java.lang.String`	`normalizeTestFileName(java.lang.String filename)` Deprecated. use `deduceTestFile(String)` instead
`protected void`	`paramsFailedMsg()` Purpose: log a FAILED_MESSAGE about the wrong number of parameters; this version is used by DriverCommands
`protected void`	`paramsFailedMsg(java.lang.String windowName, java.lang.String compName)` Purpose: log a FAILED_MESSAGE about the wrong number of parameters
`TestRecordData`	`popTestRecord()` Retrieve the Test-Record from the the Stack after the execution of a keyword.
`void`	`process()` The primary method that all subclasses must implement.
`protected boolean`	`processCustomProcessor(java.util.Collection params)`
`protected boolean`	`processSubclassProcessor(java.util.Collection params)`
`void`	`pushTestRecord(TestRecordData trd)` Push the current 'test record' into the Stack before the execution of a keyword.
`protected void`	`setAtEndOfProcess(int statusCode, java.lang.String message, java.lang.String detail)` At the end of processing a test-record, this method could be called to set the test-record's status code, and write the message to the Test Log. Currently, for `StatusCodes.NO_SCRIPT_FAILURE`, it calls `issuePassedSuccess(String, String)` `StatusCodes.GENERAL_SCRIPT_FAILURE`, it calls `issueInputRecordFailure(String, String)` Other status code, it simply writes a generic message to the test log.
`static void`	`setBreakpointsOn(boolean enabled)` This may be set by any means.
`void`	`setChainedProcessor(Processor aprocessor)` Set the instance of the chained processor to interpret test data if this one does not succeed in processing the data.
`static void`	`setClearProxiesAlways(boolean enabled)`
`static void`	`setCommandLineBreakpoint(boolean enabled)`
`void`	`setCustomProcInstancePath(java.lang.String pkgname)` Change the procInstancePath setting.
`void`	`setLogUtilities(LogUtilities log)`
`void`	`setMyBreakpointsOn(boolean enabled)` This may be set by any means.
`void`	`setParams(java.util.Collection params)`
`void`	`setProcInstance(Processor aprocessor)` Provide a Processor object to interpret test data.
`void`	`setProcInstancePath(java.lang.String pkgname)` Change the procInstancePath setting.
`void`	`setRecordProcessed(boolean processed)`
`static void`	`setRFSMCache(boolean enable)`
`static void`	`setRFSMOnly(boolean enable)`
`static void`	`setSecsWaitForComponent(int secs)`
`static void`	`setSecsWaitForWindow(int secs)`
`static void`	`setTestDomains(java.lang.String domains)`
`void`	`setTestRecordData(TestRecordHelper testRecordData)`
`static void`	`setUnexpectedAlertBehaviour(java.lang.String behaviour)` Set how to handle the 'alert dialog' if it is visible unexpectedly.
`boolean`	`setVariable(java.lang.String var, java.lang.String val)` Set a new runtime value of a global variable (SAFSVARS).
`protected void`	`standardFailureMessage(java.lang.String failure, java.lang.String detail)` log the more standard FAILED_MESSAGE with detail.
`java.lang.String`	`substituteVariable(java.lang.String str)` Purpose: if leading ^ found, then substitute variable.
`protected boolean`	`validateParamSize(int minparams)` check if params.size() < minparams If params.size() is insufficient we set testRecordData.setStatusCode to GENERAL_SCRIPT_FAILURE and log a paramsFailedMsg and return 'false'.
`protected boolean`	`validProcessorClassName(java.lang.String classname)` Validate that a given classname is valid and assignable to org.safs.Processor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PROCESSOR_PACKAGE
```
public static final java.lang.String DEFAULT_PROCESSOR_PACKAGE
```
    "org.safs" Default package for Processor subclasses used to execute test data.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CUSTOM_PROCESSOR_PACKAGE
```
public static final java.lang.String DEFAULT_CUSTOM_PROCESSOR_PACKAGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE
```
public static final java.lang.String DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE
```
    See Also:
    
    Constant Field Values
  - CASEINSENSITIVE_FLAG
```
public static final java.lang.String CASEINSENSITIVE_FLAG
```
    See Also:
    
    Constant Field Values
  - CASE_INSENSITIVE_FLAG
```
public static final java.lang.String CASE_INSENSITIVE_FLAG
```
    See Also:
    
    Constant Field Values
  - testrecordStackable
```
protected ITestRecordStackable testrecordStackable
```
    The ITestRecordStackable used to store 'Test Record' in a FILO.
  - breakpointsOn
```
protected static boolean breakpointsOn
```
    All processor instances may enable/disable and force breakpoints where they deem this appropriate. The static setting is shared by all processors. By default, breakpoints at all the coded locations are true.
  - myBreakpointsOn
```
protected boolean myBreakpointsOn
```
    Individual processor instances may enable/disable and force breakpoints where they deem this appropriate. The setting is specific to individual processors. By default, breakpoints on individual processors is disabled. However, a check is done for the static Processor.isBreakpoints enabled which overrides this setting. Processor breakpoints can be enabled separately when all other global breakpoints are disabled.
  - TXT_SUCCESS_1
```
protected static final java.lang.String TXT_SUCCESS_1
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_SUCCESS_2
```
protected static final java.lang.String TXT_SUCCESS_2
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_SUCCESS_2a
```
protected static final java.lang.String TXT_SUCCESS_2a
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_SUCCESS_3
```
protected static final java.lang.String TXT_SUCCESS_3
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_SUCCESS_3a
```
protected static final java.lang.String TXT_SUCCESS_3a
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_SUCCESS_4
```
protected static final java.lang.String TXT_SUCCESS_4
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - PRE_TXT_SUCCESS_4
```
protected static final java.lang.String PRE_TXT_SUCCESS_4
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_SUCCESS_5
```
protected static final java.lang.String TXT_SUCCESS_5
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - PRE_TXT_SUCCESS_5
```
protected static final java.lang.String PRE_TXT_SUCCESS_5
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - SENT_MSG_3
```
protected static final java.lang.String SENT_MSG_3
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_FAILURE_1
```
protected static final java.lang.String TXT_FAILURE_1
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_FAILURE_2
```
protected static final java.lang.String TXT_FAILURE_2
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_FAILURE_3
```
protected static final java.lang.String TXT_FAILURE_3
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_FAILURE_4
```
protected static final java.lang.String TXT_FAILURE_4
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - LINE_FAILURE_4
```
protected static final java.lang.String LINE_FAILURE_4
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - TXT_FAILURE_5
```
protected static final java.lang.String TXT_FAILURE_5
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - FAILURE_DETAIL
```
protected static final java.lang.String FAILURE_DETAIL
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - PARAM_SIZE_1
```
protected static final java.lang.String PARAM_SIZE_1
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - PARAM_SIZE_2
```
protected static final java.lang.String PARAM_SIZE_2
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - PARAM_SIZE_3
```
protected static final java.lang.String PARAM_SIZE_3
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - PARAM_SIZE_4
```
protected static final java.lang.String PARAM_SIZE_4
```
    GetText.text() keyword.
    
    See Also:
    
    Constant Field Values
  - RECTYPE_DRIVER_COMMAND
```
public static final java.lang.String RECTYPE_DRIVER_COMMAND
```
    "C" Record Type Constant
    
    See Also:
    
    Constant Field Values
  - RECTYPE_DRIVER_COMMAND_W
```
public static final java.lang.String RECTYPE_DRIVER_COMMAND_W
```
    "CW" Record Type Constant
    
    See Also:
    
    Constant Field Values
  - RECTYPE_DRIVER_COMMAND_F
```
public static final java.lang.String RECTYPE_DRIVER_COMMAND_F
```
    "CF" Record Type Constant
    
    See Also:
    
    Constant Field Values
  - RECTYPE_TEST_STEP
```
public static final java.lang.String RECTYPE_TEST_STEP
```
    "T" Record Type Constant
    
    See Also:
    
    Constant Field Values
  - RECTYPE_TEST_STEP_W
```
public static final java.lang.String RECTYPE_TEST_STEP_W
```
    "TW" Record Type Constant
    
    See Also:
    
    Constant Field Values
  - RECTYPE_TEST_STEP_F
```
public static final java.lang.String RECTYPE_TEST_STEP_F
```
    "TF" Record Type Constant
    
    See Also:
    
    Constant Field Values
  - DEBUG_MESSAGE
```
protected static final int DEBUG_MESSAGE
```
    Convenience for local referencing instead of referencing AbstractLogFacility.
    
    See Also:
    
    Constant Field Values
  - GENERIC_MESSAGE
```
protected static final int GENERIC_MESSAGE
```
    Convenience for local referencing instead of referencing AbstractLogFacility.
    
    See Also:
    
    Constant Field Values
  - FAILED_MESSAGE
```
protected static final int FAILED_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - FAILED_OK_MESSAGE
```
protected static final int FAILED_OK_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - PASSED_MESSAGE
```
protected static final int PASSED_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - WARNING_MESSAGE
```
protected static final int WARNING_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - WARNING_OK_MESSAGE
```
protected static final int WARNING_OK_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - testRecordData
```
protected TestRecordHelper testRecordData
```
    Purpose: holds the testRecordData info
    Initialized: constructor
  - log
```
protected LogUtilities log
```
  - SAFS_RESBUN_NAME
```
public static final java.lang.String SAFS_RESBUN_NAME
```
    See Also:
    
    Constant Field Values
  - genericStr
```
protected static final java.lang.String genericStr
```
    See Also:
    
    Constant Field Values
  - passedStr
```
protected static final java.lang.String passedStr
```
    See Also:
    
    Constant Field Values
  - failedStr
```
protected static final java.lang.String failedStr
```
    See Also:
    
    Constant Field Values
  - warningStr
```
protected static final java.lang.String warningStr
```
    See Also:
    
    Constant Field Values
  - otherStr
```
protected static final java.lang.String otherStr
```
    See Also:
    
    Constant Field Values
  - customStr
```
protected static final java.lang.String customStr
```
    See Also:
    
    Constant Field Values
  - debugStr
```
protected static final java.lang.String debugStr
```
    See Also:
    
    Constant Field Values
  - genericText
```
protected static GetText genericText
```
  - passedText
```
protected static GetText passedText
```
  - failedText
```
protected static GetText failedText
```
  - warningText
```
protected static GetText warningText
```
  - otherText
```
protected static GetText otherText
```
  - customText
```
protected static GetText customText
```
  - debugText
```
protected static GetText debugText
```
  - params
```
protected java.util.Collection params
```
    Purpose: the collection of params
    Initialized: constructor
  - processorMap
```
protected java.util.Map processorMap
```
    keeps instantiated processors for reuse
  - recordProcessed
```
protected boolean recordProcessed
```
    Status for whether the processor processed the record, if the processor fails to support the record it has been given, then the processor should set this to false, so that any processor chain can continue to the next processor, if one is available.
  - secsWaitForWindow
```
protected static int secsWaitForWindow
```
  - secsWaitForComponent
```
protected static int secsWaitForComponent
```
  - commandLineBreakpoint
```
protected static boolean commandLineBreakpoint
```
  - testDomains
```
protected static java.lang.String testDomains
```
  - clearProxiesAlways
```
protected static boolean clearProxiesAlways
```
  - RFSMOnly
```
protected static boolean RFSMOnly
```
  - RFSMCache
```
protected static boolean RFSMCache
```
  - unexpectedAlertBehaviour
```
protected static java.lang.String unexpectedAlertBehaviour
```
    How to handle the 'alert dialog' if it is visible unexpectedly, it could be set as 'accept' or 'dismiss' or 'ignore'
  - SAFS_PARAMS_FILE
```
public static final java.lang.String SAFS_PARAMS_FILE
```
    "safsparams.dat"
    
    See Also:
    
    Constant Field Values
  - SAFS_CLEARPROXIESALWAYS_ITEM
```
public static final java.lang.String SAFS_CLEARPROXIESALWAYS_ITEM
```
    "clearProxiesAlways"
    
    See Also:
    
    Constant Field Values
  - SAFS_TESTDOMAINS_ITEM
```
public static final java.lang.String SAFS_TESTDOMAINS_ITEM
```
    "testDomains" Config setting should contain semi-colon delimited combinations of values: Java;Html;Net;Win
    
    See Also:
    
    Constant Field Values
  - SAFS_SECSWAITFORWINDOW_ITEM
```
public static final java.lang.String SAFS_SECSWAITFORWINDOW_ITEM
```
    "secsWaitForWindow"
    
    See Also:
    
    Constant Field Values
  - SAFS_SECSWAITFORCOMPONENT_ITEM
```
public static final java.lang.String SAFS_SECSWAITFORCOMPONENT_ITEM
```
    "secsWaitForComponent"
    
    See Also:
    
    Constant Field Values
  - SAFS_COMMANDLINEBREAKPOINT_ITEM
```
public static final java.lang.String SAFS_COMMANDLINEBREAKPOINT_ITEM
```
    "commandLineBreakpoint"
    
    See Also:
    
    Constant Field Values
  - SAFS_SECSWAITFORWINDOW_VARIABLE
```
public static final java.lang.String SAFS_SECSWAITFORWINDOW_VARIABLE
```
    "safs.secsWaitForWindow"
    
    See Also:
    
    Constant Field Values
  - SAFS_SECSWAITFORCOMPONENT_VARIABLE
```
public static final java.lang.String SAFS_SECSWAITFORCOMPONENT_VARIABLE
```
    "safs.secsWaitForComponent"
    
    See Also:
    
    Constant Field Values
  - SAFS_COMMANDLINEBREAKPOINT_VARIABLE
```
public static final java.lang.String SAFS_COMMANDLINEBREAKPOINT_VARIABLE
```
    "safs.commandLineBreakpoint"
    
    See Also:
    
    Constant Field Values
  - SAFS_TESTDOMAINS_VARIABLE
```
public static final java.lang.String SAFS_TESTDOMAINS_VARIABLE
```
    "safs.testDomains"
    
    See Also:
    
    Constant Field Values
  - processorConfigSet
```
protected static boolean processorConfigSet
```
  - RFT_FIND_SEARCH_MODE_ALGORITHM
```
public static final java.lang.String RFT_FIND_SEARCH_MODE_ALGORITHM
```
    "RFSMOnly"
    
    See Also:
    
    Constant Field Values
  - RFT_FIND_SEARCH_MODE_CACHE
```
public static final java.lang.String RFT_FIND_SEARCH_MODE_CACHE
```
    "RFSMCache"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Processor
```
public Processor()
```
    Purpose: constructor
- Method Detail
  - getClassInstance
```
protected Processor getClassInstance(java.lang.String classname)
```
    Instance a given Processor from the provided classname.
    
    Parameters:
    
    classname - should not be null or 0 length
    
    Returns:
    
    Processor if the instanced object can be cast to org.safs.Processor; returns null if the object cannot be instanced or cast.
  - validProcessorClassName
```
protected boolean validProcessorClassName(java.lang.String classname)
```
    Validate that a given classname is valid and assignable to org.safs.Processor
  - getProcClassNames
```
protected java.util.ArrayList getProcClassNames()
```
    Attempts to locate a class for the current procInstancePath. For this superclass implementation, no additional information is appended to the procInstancePath data to attempt to locate a matching Processor class. The user can store a complete alternate classname with setProcInstancePath.
    Subclasses should override this method to return additional classnames that are based off a root package name stored in procInstancePath.
    Use validProcessorClassName before adding a classname to the list.
    
    Returns:
    
    a list of potential processor classnames to try.
  - getCustomProcClassNames
```
protected java.util.ArrayList getCustomProcClassNames()
```
    Attempts to locate a class for the current customProcInstancePath. For this superclass implementation, no additional information is appended to the customProcInstancePath data to attempt to locate a matching Processor class. The user can store a complete alternate classname with setCustomProcInstancePath.
    Subclasses, however, can also override this method to return specific classnames that are based off a root package name stored in customProcInstancePath.
    Use validProcessorClassName before adding a classname to the list.
    
    Returns:
    
    valid String name for processor class or null if the stored path is not a valid class name. This usually means the stored path is to the package only.
  - getProcInstance
```
public Processor getProcInstance()
```
    Return/Create an instance of the actual processor used to interpret test data. If we already have stored a procInstance object; that that will be returned. If all we have is a procInstancePath, then the routine will attempt to instance an object from that Path information. At this level, if no Processor can be instanced, then the subclass will need to override the getProcInstance method to provide the full functionality of instancing an appropriate test record processor. This will likely be different for each processor type.
    
    Returns:
    
    Processor object needed to process the test record, or null.
  - setProcInstance
```
public void setProcInstance(Processor aprocessor)
```
    Provide a Processor object to interpret test data.
  - hasChainedProcessor
```
public boolean hasChainedProcessor()
```
    True if this processor has an instance of a chained processor to interpret test data if this one does not succeed in processing the data.
    
    Since:
    
    Jan 29, 2007 Carl Nagle
  - getChainedProcessor
```
public Processor getChainedProcessor()
```
    Returns chained processor to interpret test data, if any. Can be null if no chainedProcessor has been set.
    
    Since:
    
    Jan 29, 2007 Carl Nagle
  - setChainedProcessor
```
public void setChainedProcessor(Processor aprocessor)
```
    Set the instance of the chained processor to interpret test data if this one does not succeed in processing the data.
    For example, we may store an org.safs.DriverCommandProcessor object to provide default handling of Driver Command records not overridden by some subclass.
    Can be set to null to remove any existing chainedProcessor.
    
    Since:
    
    Jan 29, 2007 Carl Nagle
  - getProcInstancePath
```
public java.lang.String getProcInstancePath()
```
    Return the current procInstancePath setting. It is possible for the procInstancePath setting to be overridden by a concrete subclass of TestRecordHelper.getCompInstancePath. Thus, the TestRecordHelper subclass must not provide a non-null value from that method if the user intends to specify alternative paths here.
  - setProcInstancePath
```
public void setProcInstancePath(java.lang.String pkgname)
```
    Change the procInstancePath setting. This may be called by some subclasses to provide a full class name or a different package name for instancing a processor to interpret test data.
  - getCustomProcInstancePath
```
public java.lang.String getCustomProcInstancePath()
```
    Return the current customProcInstancePath setting. It is possible for the this setting to be overridden by a concrete subclass of TestRecordHelper.getCompInstancePath. Thus, the TestRecordHelper subclass must not provide a non-null value from that method if the user intends to specify alternative paths here.
  - setCustomProcInstancePath
```
public void setCustomProcInstancePath(java.lang.String pkgname)
```
    Change the procInstancePath setting. This may be called by some subclasses to provide a full class name or a different package name for instancing a processor to interpret test data.
  - setBreakpointsOn
```
public static void setBreakpointsOn(boolean enabled)
```
    This may be set by any means. In a runtime debugging environment this will likely be set by a Driver Command. By default, breakpoints are enabled.
  - isBreakpointsOn
```
public static boolean isBreakpointsOn()
```
    test if breakpoints is enabled.
  - checkBreakpoints
```
protected static void checkBreakpoints(java.lang.String breakpoint_message)
```
    test for enabled breakpoints and active a breakpoint if enabled.
  - activateBreakpoint
```
protected static void activateBreakpoint(java.lang.String breakpoint_message)
```
    Activate the SAFSBreakpointException breakpoint.
  - setMyBreakpointsOn
```
public void setMyBreakpointsOn(boolean enabled)
```
    This may be set by any means. In a runtime debugging environment this will likely be set by a Driver Command or during construction. By default, these breakpoints are disabled.
  - isMyBreakpointsOn
```
public boolean isMyBreakpointsOn()
```
    test if breakpoints is enabled.
    
    Returns:
    
    true if myBreakpoints on is true.
  - checkMyBreakpoints
```
protected void checkMyBreakpoints(java.lang.String breakpoint_message)
```
    test for enabled breakpoints and active a breakpoint if enabled. Subclasses should override this method if they wish to add additional checks for enabled breakpoints.
  - getTestRecordData
```
public TestRecordHelper getTestRecordData()
```
  - setTestRecordData
```
public void setTestRecordData(TestRecordHelper testRecordData)
```
  - getLogUtilities
```
public LogUtilities getLogUtilities()
```
  - setLogUtilities
```
public void setLogUtilities(LogUtilities log)
```
  - getParams
```
public java.util.Collection getParams()
```
  - setParams
```
public void setParams(java.util.Collection params)
```
  - getAlternateParams
```
public java.util.Collection getAlternateParams()
```
  - isRecordProcessed
```
public boolean isRecordProcessed()
```
  - setRecordProcessed
```
public void setRecordProcessed(boolean processed)
```
  - instanceProcessorAndProcess
```
protected boolean instanceProcessorAndProcess(java.lang.String instanceName,
                                              java.util.Collection params)
```
    Tries to instance a processor and then process a record. Given a processor class name, the routine attempts to first locate a processor that already may exist in the processorMap. If none is found, then the routine attempts to make an instance of the class. If successful, the instance is stored in the processorMap and forwarded to the initProcessorAndProcess .method for record processing.
    
    Parameters:
    
    instanceName - String, the processor class name
    
    params - Collection, the parameters
    
    Returns:
    
    true if it processed the record, false otherwise
  - distributeConfigInformation
```
public void distributeConfigInformation()
```
  - initProcessorAndProcess
```
protected boolean initProcessorAndProcess(Processor aprocessor,
                                          java.util.Collection params)
```
    Init the processor and process a record Initializes the processor by passing it the currently active LogUtilities, TestRecordHelper, and extracted record parameters. It then invokes the .process method of the Processor. This routine is normally called by other routines that first instance or retrieve the processor to init (like instanceProcessorAndProcess).
    
    Parameters:
    
    aprocessor, - Processor
    
    params, - Collection
    
    Returns:
    
    true if it processed the record, false otherwise
  - delay
```
protected boolean delay(int millisec)
```
  - setVariable
```
public boolean setVariable(java.lang.String var,
                           java.lang.String val)
                    throws SAFSException
```
    Description copied from interface: RuntimeDataInterface
    
    Set a new runtime value of a global variable (SAFSVARS).
    
    Specified by:
    
    setVariable in interface RuntimeDataInterface
    
    Parameters:
    
    var - -- Variable names are NOT case-sensitive.
    
    val - -- value to set. Can be an empty string.
    
    Returns:
    
    value of the variable after it has been set. can be null if the set was not successful or some other error occurred.
    
    Throws:
    
    SAFSException
  - getVariable
```
public java.lang.String getVariable(java.lang.String var)
                             throws SAFSException
```
    Description copied from interface: RuntimeDataInterface
    
    Retrieve the current runtime value of the global variable (SAFSVARS).
    
    Specified by:
    
    getVariable in interface RuntimeDataInterface
    
    Parameters:
    
    var - -- Variable names are NOT case-sensitive.
    
    Returns:
    
    String value which can be a zero-length value. null if no such item was found or some type of error occurred during execution.
    
    Throws:
    
    SAFSException
  - getAppMapItem
```
public java.lang.String getAppMapItem(java.lang.String appMapID,
                                      java.lang.String section,
                                      java.lang.String item)
```
    Description copied from interface: RuntimeDataInterface
    
    Retrieve the resolved value of an item stored in the App Map chain (SAFSMAPS).
    
    Specified by:
    
    getAppMapItem in interface RuntimeDataInterface
    
    Parameters:
    
    appMapID - -- can be null to get from the "default/current" app map.
    
    section - -- section names are NOT case-sensitive.
    
    item - -- item names are NOT case-sensitive.
    
    Returns:
    
    String value which can be a zero-length value. null if no such item was found or some type of error occurred during execution.
  - substituteVariable
```
public java.lang.String substituteVariable(java.lang.String str)
```
    Purpose: if leading ^ found, then substitute variable. It will log a warning message, set statusCode to StatusCodes.GENERAL_SCRIPT_FAILURE and return null if variable not found.
    *NOTE* According to the chief architect for the SAFS framework, an engine should not use this method in a driver command or a component function; therefore be careful about it's use. Maybe this method should be moved to StringUtils or some other place so that when and if a java 'controller' is developed, it can be utilized.
    
    Parameters:
    
    str, - String string to search for ^ at beginning
    
    Returns:
    
    str if no ^, or variable value, or null if not found
  - processSubclassProcessor
```
protected boolean processSubclassProcessor(java.util.Collection params)
```
  - processCustomProcessor
```
protected boolean processCustomProcessor(java.util.Collection params)
```
  - process
```
public void process()
```
    The primary method that all subclasses must implement. The implementation here simply checks for any chainedProcessor,
    invokes chainedProcessor.setParams(this.getParams()),
    invokes chainedProcessor.process(),
    invokes setRecordProcessed(chainedProcessor.isRecordProcessed()).
    Thus, any subclassing Processor should attempt to process it's own commands and then invoke super.process() to try any chained Processor(s).
    Otherwise, by default executes setRecordProcessed(false) if no chainedProcessor is present.
    
    Since:
    
    Jan27, 2007 Carl Nagle
  - isSupportedRecordType
```
public abstract boolean isSupportedRecordType(java.lang.String recordType)
```
    Determine support for a particular record type.
    
    Parameters:
    
    recordType - -- String text of record type to match (ignoring case).
    
    Returns:
    
    'true' if the provided recordType is one this Processor can execute. Note, that SAFS record types are normally not case-sensitive. So the comparison to match the provided recordType should ignore case.
  - isDriverCommandRecord
```
public static boolean isDriverCommandRecord(java.lang.String recordType)
```
    Convenience routine for isSupportedRecordType to return true if the Processor supports standard Driver Command records.
  - isComponentFunctionRecord
```
public static boolean isComponentFunctionRecord(java.lang.String recordType)
```
    Convenience routine for isSupportedRecordType to return true if the Processor supports standard Component Function records.
  - isEngineCommandRecord
```
public boolean isEngineCommandRecord(java.lang.String recordType)
```
    Convenience routine for isSupportedRecordType to return true if the Processor supports standard Engine Command records.
  - paramsFailedMsg
```
protected void paramsFailedMsg()
                        throws SAFSException
```
    Purpose: log a FAILED_MESSAGE about the wrong number of parameters; this version is used by DriverCommands
    
    Throws:
    
    SAFSException
  - paramsFailedMsg
```
protected void paramsFailedMsg(java.lang.String windowName,
                               java.lang.String compName)
                        throws SAFSException
```
    Purpose: log a FAILED_MESSAGE about the wrong number of parameters
    
    Parameters:
    
    windowName, - String
    
    compName, - String
    
    Throws:
    
    SAFSException
  - validateParamSize
```
protected boolean validateParamSize(int minparams)
```
    check if params.size() < minparams If params.size() is insufficient we set testRecordData.setStatusCode to GENERAL_SCRIPT_FAILURE and log a paramsFailedMsg and return 'false'. Otherwise, we simply return 'true'.
    
    Parameters:
    
    minparams - - minimum number of parameters required for processing
    
    Returns:
    
    true if minimum number of parameters exist
  - getAbsolutFileName
```
protected java.lang.String getAbsolutFileName(java.lang.String filename,
                                              java.lang.String directory)
```
    Parameters:
    
    filename - A file name
    
    directory - This is a variable assigned in STAF system. It can be one of following: 1. STAFHelper.SAFS_VAR_BENCHDIRECTORY 2. STAFHelper.SAFS_VAR_DATAPOOLDIRECTORY 3. STAFHelper.SAFS_VAR_DIFDIRECTORY 4. STAFHelper.SAFS_VAR_LOGSDIRECTORY 5. STAFHelper.SAFS_VAR_PROJECTDIRECTORY 6. STAFHelper.SAFS_VAR_TESTDIRECTORY
    
    Returns:
    
    An absolute filename if the parameter filename is absolute, return the parameter filename itself. if the parameter filename is relative, return the file under parameter directory if that file exist; otherwise if that file does not exist, return file under directory STAFHelper.SAFS_VAR_PROJECTDIRECTORY
  - normalizeTestFileName
```
@Deprecated
protected java.lang.String normalizeTestFileName(java.lang.String filename)
```
    Deprecated. use deduceTestFile(String) instead
    
    Return an absolute file name. If the parameter 'filename' is relative, the returned absolute
    filename will use value of variable STAFHelper.SAFS_VAR_TESTDIRECTORY as parent folder.
    
    Parameters:
    
    filename - String, a file name. Can be relative or absolute.
    
    Returns:
    
    String, an absolute file name.
  - getRequiredField
```
protected boolean getRequiredField(int findex,
                                   java.lang.String fname,
                                   java.lang.String fvalue)
```
    Retrieve a non-empty field value from the testRecordData inputrecord. If successful, fvalue will exit with the retrieved value. On failure, the routine will set testRecordData.setStatusCode to GENERAL_SCRIPT_FAILURE and log a 'bad_param' standardFailureMessage.
    
    Parameters:
    
    findex - - 0-based index of field to extract from input record.
    
    fname - - field name to use in issuing any Invalid Parameter error messages.
    
    fvalue - - String to receive the desired field value on success.
    
    Returns:
    
    true if fvalue was successfully set to a non-empty value. false if it was not and standard failure logging was performed.
  - getStandardErrorMessage
```
protected java.lang.String getStandardErrorMessage(java.lang.String failure)
```
    Retrieve the standard "SOMETHING failure in filename FILENAME at line LINENUMBER" message. Expects testRecordData to already have filename and lineNumber.
    
    Parameters:
    
    failure - -- text to appear before the filename and line number info.
    
    Returns:
    
    String, the standard "SOMETHING failure in filename FILENAME at line LINENUMBER" message.
  - standardFailureMessage
```
protected void standardFailureMessage(java.lang.String failure,
                                      java.lang.String detail)
```
    log the more standard FAILED_MESSAGE with detail. "SOMETHING failure in filename FILENAME at line LINENUMBER"
    "DETAIL"
    Expects testRecordData to already have filename and lineNumber.
    
    Parameters:
    
    failure - -- the failure text that precedes the 'failure in filename' message.
    
    detail - -- the detail that will be used unmodified.
  - setSecsWaitForWindow
```
public static void setSecsWaitForWindow(int secs)
```
  - getSecsWaitForWindow
```
public static int getSecsWaitForWindow()
```
  - setSecsWaitForComponent
```
public static void setSecsWaitForComponent(int secs)
```
  - getSecsWaitForComponent
```
public static int getSecsWaitForComponent()
```
  - setCommandLineBreakpoint
```
public static void setCommandLineBreakpoint(boolean enabled)
```
  - setTestDomains
```
public static void setTestDomains(java.lang.String domains)
```
  - setClearProxiesAlways
```
public static void setClearProxiesAlways(boolean enabled)
```
  - getClearProxiesAlways
```
public static boolean getClearProxiesAlways()
```
  - setRFSMOnly
```
public static void setRFSMOnly(boolean enable)
```
  - isRFSMOnly
```
public static boolean isRFSMOnly()
```
  - setRFSMCache
```
public static void setRFSMCache(boolean enable)
```
  - isRFSMCache
```
public static boolean isRFSMCache()
```
  - getUnexpectedAlertBehaviour
```
public static java.lang.String getUnexpectedAlertBehaviour()
```
    Get how the 'alert dialog' will be handled if it is visible unexpectedly.
    
    Returns:
    
    String, 'accept' or 'dismiss' or 'ignore'
  - setUnexpectedAlertBehaviour
```
public static void setUnexpectedAlertBehaviour(java.lang.String behaviour)
```
    Set how to handle the 'alert dialog' if it is visible unexpectedly.
    
    Parameters:
    
    behaviour - String, it could be set as 'accept' or 'dismiss' or 'ignore'.
  - deduceTestFile
```
protected java.io.File deduceTestFile(java.lang.String filename)
                               throws SAFSException
```
    Deduce the absolute full path test-relative file.
    
    Parameters:
    
    filename, - String, the test/actual file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path.
    If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.
    If it is an absolute path, and contains a root path that includes the Bench directory, then the file will be converted to a comparable relative path off the Test directory.
    
    Returns:
    
    File, the absolute full path test file.
    
    Throws:
    
    SAFSException
    
    See Also:
    
    FileUtilities.deduceFile(String, int, RuntimeDataInterface)
  - deduceDiffFile
```
protected java.io.File deduceDiffFile(java.lang.String filename)
                               throws SAFSException
```
    Deduce the absolute full path Diff-relative file.
    
    Parameters:
    
    filename, - String, the diff file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path.
    If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.
    If it is an absolute path, and contains a root path that includes the Bench directory, then the file will be converted to a comparable relative path off the Diff directory.
    
    Returns:
    
    File, the absolute full path diff file.
    
    Throws:
    
    SAFSException
    
    See Also:
    
    FileUtilities.deduceFile(String, int, RuntimeDataInterface)
  - deduceBenchFile
```
protected java.io.File deduceBenchFile(java.lang.String filename)
                                throws SAFSException
```
    Deduce the absolute full path bench-relative file.
    
    Parameters:
    
    filename, - String, the test file name. If there are any File.separators in the relative path then the path is actually considered relative to the Datapool directory unless it does not exist, or is already an absolute file path. If a relative directory path does not exist relative to the Datapool directory then the final path will be relative to the Project directory.
    
    Returns:
    
    File, the absolute full path bench file.
    
    Throws:
    
    SAFSException
    
    See Also:
    
    FileUtilities.deduceFile(String, int, RuntimeDataInterface)
  - deduceProjectFile
```
protected java.io.File deduceProjectFile(java.lang.String filename)
                                  throws SAFSException
```
    Deduce the absolute full path to a project-relative file.
    
    Parameters:
    
    filename, - String, the test file name. The path is ALWAYS considered relative to the project root directory regardless of the absence or presence of File.separators unless the file is already an absolute path.
    
    Returns:
    
    File, the absolute full path bench file.
    
    Throws:
    
    SAFSException
    
    See Also:
    
    FileUtilities.deduceFile(String, int, RuntimeDataInterface)
  - logFailureMessage
```
protected void logFailureMessage(java.lang.String aborttext,
                                 java.lang.String details,
                                 java.lang.String error)
```
    Write failure to log.
    Write failure to debug log.
    
    Parameters:
    
    aborttext - String, the abort message
    
    details - String, the detail failure message
    
    error - String, the error message
  - issueInputRecordFailure
```
protected void issueInputRecordFailure(java.lang.String error)
```
    Unable to perform [action].
    "Error at line [number] in file [file]: [error]"
    Sets status to FAILURE and issues a FAILED message. called by other issueFailure routines
  - issueInputRecordFailure
```
protected void issueInputRecordFailure(java.lang.String message,
                                       java.lang.String error)
```
    If [message]==null
    Unable to perform [action].
    "Error at line [number] in file [file]: [error]"
    If [message]!=null
    [message]
    "Error at line [number] in file [file]: [error]"
    
    Sets status to FAILURE and issues a FAILED message. called by other issueFailure routines
  - issuePassedSuccess
```
protected void issuePassedSuccess(java.lang.String message,
                                  java.lang.String detail)
```
    issue OK status and PASSED message.
    If [message]==null
    [action] successful.
    [detail]
    If [message]!=null
    [message]
    [detail]
    string comment is expected to already be localized, but can be null.
  - setAtEndOfProcess
```
protected void setAtEndOfProcess(int statusCode,
                                 java.lang.String message,
                                 java.lang.String detail)
```
    At the end of processing a test-record, this method could be called to set the test-record's status code, and write the message to the Test Log.
    Currently, for
    - StatusCodes.NO_SCRIPT_FAILURE, it calls issuePassedSuccess(String, String)
    - StatusCodes.GENERAL_SCRIPT_FAILURE, it calls issueInputRecordFailure(String, String)
    - Other status code, it simply writes a generic message to the test log.
    Parameters:
    
    statusCode - int, the status code to set to test-record.
    
    message - String, the message to write to the Test Log. If it is null, then the default message will be used.
    
    detail - String, the detail message to write to the Test Log. If it is null, then the default detail message will be used.
    
    See Also:
    
    issueInputRecordFailure(String, String), issuePassedSuccess(String, String)
  - issueActionFailure
```
protected void issueActionFailure(java.lang.String error)
```
    Unable to perform [action].
    "Error at line [number] in file [file]: [error]"
    Sets status to FAILURE and issues a FAILED message. called by other issueFailure routines
  - issueActionOnXFailure
```
protected void issueActionOnXFailure(java.lang.String x,
                                     java.lang.String error)
```
    Unable to perform [action].
    "Error at line [number] in file [file]: [error]"
    Sets status to FAILURE and issues a FAILED message.
  - issueErrorPerformingAction
```
protected void issueErrorPerformingAction(java.lang.String error)
```
    "Error performing [action]."
    "Error at line [number] in file [file]: [error]"
  - issueErrorPerformingActionOnX
```
protected void issueErrorPerformingActionOnX(java.lang.String x,
                                             java.lang.String error)
```
    "Error performing [action] on [x]."
    "Error at line [number] in file [file]: [error]"
  - issueErrorPerformingActionUsing
```
protected void issueErrorPerformingActionUsing(java.lang.String x,
                                               java.lang.String error)
```
    "[action] was not successful using [x]."
    "Error at line [number] in file [file]: [error]"
  - pushTestRecord
```
public void pushTestRecord(TestRecordData trd)
```
    Push the current 'test record' into the Stack before the execution of a keyword. This should be called after the 'test record' is properly set.
    
    Specified by:
    
    pushTestRecord in interface ITestRecordStackable
    
    Parameters:
    
    trd - TestRecordData, the test record to push into a stack
    
    See Also:
    
    popTestRecord()
  - popTestRecord
```
public TestRecordData popTestRecord()
```
    Retrieve the Test-Record from the the Stack after the execution of a keyword.
    
    After execution of a keyword, pop the test record from Stack and return is as the result. Replace the class field 'Test Record' by that popped from the stack if they are not same.
    
    Specified by:
    
    popTestRecord in interface ITestRecordStackable
    
    Returns:
    
    TestRecordData, the 'Test Record' on top of the stack
    
    See Also:
    
    pushTestRecord(TestRecordData)

Class Processor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROCESSOR_PACKAGE

DEFAULT_CUSTOM_PROCESSOR_PACKAGE

DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE

CASEINSENSITIVE_FLAG

CASE_INSENSITIVE_FLAG

testrecordStackable

breakpointsOn

myBreakpointsOn

TXT_SUCCESS_1

TXT_SUCCESS_2

TXT_SUCCESS_2a

TXT_SUCCESS_3

TXT_SUCCESS_3a

TXT_SUCCESS_4

PRE_TXT_SUCCESS_4

TXT_SUCCESS_5

PRE_TXT_SUCCESS_5

SENT_MSG_3

TXT_FAILURE_1

TXT_FAILURE_2

TXT_FAILURE_3

TXT_FAILURE_4

LINE_FAILURE_4

TXT_FAILURE_5

FAILURE_DETAIL

PARAM_SIZE_1

PARAM_SIZE_2

PARAM_SIZE_3

PARAM_SIZE_4

RECTYPE_DRIVER_COMMAND

RECTYPE_DRIVER_COMMAND_W

RECTYPE_DRIVER_COMMAND_F

RECTYPE_TEST_STEP

RECTYPE_TEST_STEP_W

RECTYPE_TEST_STEP_F

DEBUG_MESSAGE

GENERIC_MESSAGE

FAILED_MESSAGE

FAILED_OK_MESSAGE

PASSED_MESSAGE

WARNING_MESSAGE

WARNING_OK_MESSAGE

testRecordData

log

SAFS_RESBUN_NAME

genericStr

passedStr

failedStr

warningStr

otherStr

customStr

debugStr

genericText

passedText

failedText

warningText

otherText

customText

debugText

params

processorMap

recordProcessed

secsWaitForWindow

secsWaitForComponent

commandLineBreakpoint

testDomains

clearProxiesAlways

RFSMOnly

RFSMCache

unexpectedAlertBehaviour

SAFS_PARAMS_FILE

SAFS_CLEARPROXIESALWAYS_ITEM

SAFS_TESTDOMAINS_ITEM

SAFS_SECSWAITFORWINDOW_ITEM