org.safs

Class DCDriverTimerCommands

java.lang.Object

org.safs.Processor

org.safs.DriverCommand

org.safs.DCDriverTimerCommands

All Implemented Interfaces:

ITestRecordStackable, RuntimeDataInterface

public class DCDriverTimerCommands
extends DriverCommand

Process a timer commands. Instantiated by DCDriverCommand
Sep 16, 2005 (MCasebeer) Original Release

Since:

Dec 16, 2005

Author:

Matt Casebeer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMAND_RESET_TIMER
static java.lang.String	COMMAND_START_TIMER
static java.lang.String	COMMAND_STOP_TIMER
static java.lang.String	COMMAND_STORE_TIMER
static java.lang.String	COMMAND_STORE_TIMER_FILE
static java.lang.String	COMMAND_VERIFY_TIMER
static java.lang.String	COMMAND_VERIFY_TIMER_LESS
static java.lang.String	COMMAND_VERIFY_TIMER_MORE
static java.lang.String	COMMAND_VERIFY_TIMER_RANGE
static java.lang.String	TIMER_END_SUFFIX
static java.lang.String	TIMER_FAILURES_SUFFIX
static java.lang.String	TIMER_START_SUFFIX
static java.lang.String	TIMER_STATUS_ACTIVE
static java.lang.String	TIMER_STATUS_RESET
static java.lang.String	TIMER_STATUS_STOPPED
static java.lang.String	TIMER_VERIFY_SUFFIX
static java.lang.String	VAR_ELAPSED_SUFFIX
static java.lang.String	VAR_END_SUFFIX
static java.lang.String	VAR_FAILURES_SUFFIX
static java.lang.String	VAR_START_SUFFIX
static int	VERIFY_GREATER_THEN
static int	VERIFY_LESS_THEN
static int	VERIFY_RANGE

Fields inherited from class org.safs.DriverCommand

command, iterator, utils

Fields inherited from class org.safs.Processor

breakpointsOn, CASE_INSENSITIVE_FLAG, CASEINSENSITIVE_FLAG, clearProxiesAlways, commandLineBreakpoint, customStr, customText, DEBUG_MESSAGE, debugStr, debugText, DEFAULT_CUSTOM_PROCESSOR_PACKAGE, DEFAULT_CUSTOM_PROCESSOR_SUBPACKAGE, DEFAULT_PROCESSOR_PACKAGE, FAILED_MESSAGE, FAILED_OK_MESSAGE, failedStr, failedText, FAILURE_DETAIL, GENERIC_MESSAGE, genericStr, genericText, LINE_FAILURE_4, log, myBreakpointsOn, otherStr, otherText, PARAM_SIZE_1, PARAM_SIZE_2, PARAM_SIZE_3, PARAM_SIZE_4, params, PASSED_MESSAGE, passedStr, passedText, PRE_TXT_SUCCESS_4, PRE_TXT_SUCCESS_5, processorConfigSet, processorMap, recordProcessed, RECTYPE_DRIVER_COMMAND, RECTYPE_DRIVER_COMMAND_F, RECTYPE_DRIVER_COMMAND_W, RECTYPE_TEST_STEP, RECTYPE_TEST_STEP_F, RECTYPE_TEST_STEP_W, RFSMCache, RFSMOnly, RFT_FIND_SEARCH_MODE_ALGORITHM, RFT_FIND_SEARCH_MODE_CACHE, SAFS_CLEARPROXIESALWAYS_ITEM, SAFS_COMMANDLINEBREAKPOINT_ITEM, SAFS_COMMANDLINEBREAKPOINT_VARIABLE, SAFS_PARAMS_FILE, SAFS_RESBUN_NAME, SAFS_SECSWAITFORCOMPONENT_ITEM, SAFS_SECSWAITFORCOMPONENT_VARIABLE, SAFS_SECSWAITFORWINDOW_ITEM, SAFS_SECSWAITFORWINDOW_VARIABLE, SAFS_TESTDOMAINS_ITEM, SAFS_TESTDOMAINS_VARIABLE, secsWaitForComponent, secsWaitForWindow, SENT_MSG_3, testDomains, testRecordData, testrecordStackable, TXT_FAILURE_1, TXT_FAILURE_2, TXT_FAILURE_3, TXT_FAILURE_4, TXT_FAILURE_5, TXT_SUCCESS_1, TXT_SUCCESS_2, TXT_SUCCESS_2a, TXT_SUCCESS_3, TXT_SUCCESS_3a, TXT_SUCCESS_4, TXT_SUCCESS_5, unexpectedAlertBehaviour, WARNING_MESSAGE, WARNING_OK_MESSAGE, warningStr, warningText

Constructor Summary

Constructors

Constructor and Description
DCDriverTimerCommands() Purpose: constructor, calls super

Method Summary

Modifier and Type	Method and Description
void	cmdResetTimer() Purpose:Handles command ResetTimer. Resets a stopped timer of the given unique name.
void	cmdStartTimer() Purpose:Handles command StartTimer. Starts a timer using the given unique name.
void	cmdStopTimer() Purpose:Handles command StopTimer.
void	cmdStoreTimer() Purpose: Handles StoreTimerInfo command by storing the following standard timer information: .elapsed .startTime .endTime .failures under the given variable name.
void	cmdStoreTimerFile() Purpose:Handles the command StoreTimerInfoFile.
void	cmdVerifyTimer(int actionType) Purpose:Handles commands VerifyTimer, VerifyElapsedTimeIsLess, VerifyElapsedTimeIsMore, VerifyElapsedTimeInRange.
protected void	evaluateTimer(int diff, java.lang.String uid, java.lang.String verifyValue, java.lang.String verifyValue2, int actionType) Issue pass or fail status and log messages for diff and verify values compared agains VERIFY_LESS_THAN, VERIFY_GREATER_THAN,and VERIFY_RANGE.
void	process() Purpose: process: process the testRecordData This is the driver command processor for timer commands.

Methods inherited from class org.safs.DriverCommand

checkGUIExistence, commandProcess, getStandardFailureDetail, getStandardWarningDetail, init, interpretFields, issueActionUsingNegativeMessage, issueActionWarning, issueExecutionNegativeMessage, issueFileErrorFailure, issueGenericSuccess, issueGenericSuccess, issueGenericSuccessUsing, issueParameterCountFailure, issueParameterCountFailure, issueParameterValueFailure, issuePassedSuccess, issueUnknownErrorFailure, isSupportedRecordType, localProcess

Methods inherited from class org.safs.Processor

activateBreakpoint, checkBreakpoints, checkMyBreakpoints, deduceBenchFile, deduceDiffFile, deduceProjectFile, deduceTestFile, delay, distributeConfigInformation, getAbsolutFileName, getAlternateParams, getAppMapItem, getChainedProcessor, getClassInstance, getClearProxiesAlways, getCustomProcClassNames, getCustomProcInstancePath, getLogUtilities, getParams, getProcClassNames, getProcInstance, getProcInstancePath, getRequiredField, getSecsWaitForComponent, getSecsWaitForWindow, getStandardErrorMessage, getTestRecordData, getUnexpectedAlertBehaviour, getVariable, hasChainedProcessor, initProcessorAndProcess, instanceProcessorAndProcess, isBreakpointsOn, isComponentFunctionRecord, isDriverCommandRecord, isEngineCommandRecord, isMyBreakpointsOn, isRecordProcessed, isRFSMCache, isRFSMOnly, issueActionFailure, issueActionOnXFailure, issueErrorPerformingAction, issueErrorPerformingActionOnX, issueErrorPerformingActionUsing, issueInputRecordFailure, issueInputRecordFailure, issuePassedSuccess, logFailureMessage, normalizeTestFileName, paramsFailedMsg, paramsFailedMsg, popTestRecord, processCustomProcessor, processSubclassProcessor, pushTestRecord, setAtEndOfProcess, setBreakpointsOn, setChainedProcessor, setClearProxiesAlways, setCommandLineBreakpoint, setCustomProcInstancePath, setLogUtilities, setMyBreakpointsOn, setParams, setProcInstance, setProcInstancePath, setRecordProcessed, setRFSMCache, setRFSMOnly, setSecsWaitForComponent, setSecsWaitForWindow, setTestDomains, setTestRecordData, setUnexpectedAlertBehaviour, setVariable, standardFailureMessage, substituteVariable, validateParamSize, validProcessorClassName

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_START_TIMER

public static final java.lang.String COMMAND_START_TIMER

See Also:

Constant Field Values

COMMAND_STOP_TIMER

public static final java.lang.String COMMAND_STOP_TIMER

See Also:

Constant Field Values

COMMAND_RESET_TIMER

public static final java.lang.String COMMAND_RESET_TIMER

See Also:

Constant Field Values

COMMAND_VERIFY_TIMER

public static final java.lang.String COMMAND_VERIFY_TIMER

See Also:

Constant Field Values

COMMAND_VERIFY_TIMER_LESS

public static final java.lang.String COMMAND_VERIFY_TIMER_LESS

See Also:

Constant Field Values

COMMAND_VERIFY_TIMER_MORE

public static final java.lang.String COMMAND_VERIFY_TIMER_MORE

See Also:

Constant Field Values

COMMAND_VERIFY_TIMER_RANGE

public static final java.lang.String COMMAND_VERIFY_TIMER_RANGE

See Also:

Constant Field Values

COMMAND_STORE_TIMER

public static final java.lang.String COMMAND_STORE_TIMER

See Also:

Constant Field Values

COMMAND_STORE_TIMER_FILE

public static final java.lang.String COMMAND_STORE_TIMER_FILE

See Also:

Constant Field Values

VERIFY_LESS_THEN

public static final int VERIFY_LESS_THEN

See Also:

Constant Field Values

VERIFY_GREATER_THEN

public static final int VERIFY_GREATER_THEN

See Also:

Constant Field Values

VERIFY_RANGE

public static final int VERIFY_RANGE

See Also:

Constant Field Values

TIMER_START_SUFFIX

public static final java.lang.String TIMER_START_SUFFIX

See Also:

Constant Field Values

TIMER_END_SUFFIX

public static final java.lang.String TIMER_END_SUFFIX

See Also:

Constant Field Values

TIMER_FAILURES_SUFFIX

public static final java.lang.String TIMER_FAILURES_SUFFIX

See Also:

Constant Field Values

TIMER_VERIFY_SUFFIX

public static final java.lang.String TIMER_VERIFY_SUFFIX

See Also:

Constant Field Values

TIMER_STATUS_ACTIVE

public static final java.lang.String TIMER_STATUS_ACTIVE

See Also:

Constant Field Values

TIMER_STATUS_STOPPED

public static final java.lang.String TIMER_STATUS_STOPPED

See Also:

Constant Field Values

TIMER_STATUS_RESET

public static final java.lang.String TIMER_STATUS_RESET

See Also:

Constant Field Values

VAR_START_SUFFIX

public static final java.lang.String VAR_START_SUFFIX

See Also:

Constant Field Values

VAR_END_SUFFIX

public static final java.lang.String VAR_END_SUFFIX

See Also:

Constant Field Values

VAR_FAILURES_SUFFIX

public static final java.lang.String VAR_FAILURES_SUFFIX

See Also:

Constant Field Values

VAR_ELAPSED_SUFFIX

public static final java.lang.String VAR_ELAPSED_SUFFIX

See Also:

Constant Field Values

Constructor Detail

DCDriverTimerCommands

public DCDriverTimerCommands()

Purpose: constructor, calls super

Method Detail

process

public void process()

Purpose: process: process the testRecordData
This is the driver command processor for timer commands. Current commands :

StartTimer
StopTimer
ResetTimer
VerifyTimer
VerifyElapsedTimeIsLess
VerifyElapsedTimeIsMore
VerifyElapsedTimeInRange
StoreTimerInfo
StoreTimerInfoFile

Overrides:

process in class DriverCommand

cmdStartTimer

public void cmdStartTimer()
                   throws SAFSException

Purpose:Handles command StartTimer. Starts a timer using the given unique name. If the unique name has already been activated the method will fail. However, if a timer with the name is "stopped", it will be allowed to be restarted with a new start time, but a warning will be logged that it is being restarted.

Throws:

SAFSException

cmdResetTimer

public void cmdResetTimer()
                   throws SAFSException

Purpose:Handles command ResetTimer. Resets a stopped timer of the given unique name. If the timer is not "stopped" the method will fail.

Throws:

SAFSException

cmdStoreTimerFile

public void cmdStoreTimerFile()
                       throws SAFSException

Purpose:Handles the command StoreTimerInfoFile. Stores all standard information about a given timer plus any additional information located within TimerStorageVariables.

Throws:

SAFSException

cmdStoreTimer

public void cmdStoreTimer()
                   throws SAFSException

Purpose: Handles StoreTimerInfo command by storing the following standard timer information: .elapsed .startTime .endTime .failures under the given variable name.

Throws:

SAFSException

cmdStopTimer

public void cmdStopTimer()
                  throws SAFSException

Purpose:Handles command StopTimer. It will stop the given timer and set its status to "stopped". If a verify value was set it will attempt to verify if the timer was successful.

Throws:

SAFSException

evaluateTimer

protected void evaluateTimer(int diff,
                             java.lang.String uid,
                             java.lang.String verifyValue,
                             java.lang.String verifyValue2,
                             int actionType)
                      throws SAFSException

Issue pass or fail status and log messages for diff and verify values compared agains VERIFY_LESS_THAN, VERIFY_GREATER_THAN,and VERIFY_RANGE.

Parameters:

diff -

uid -

verifyValue -

verifyValue2 -

actionType -

Throws:

SAFSException

cmdVerifyTimer

public void cmdVerifyTimer(int actionType)
                    throws SAFSException

Purpose:Handles commands VerifyTimer, VerifyElapsedTimeIsLess, VerifyElapsedTimeIsMore, VerifyElapsedTimeInRange. Uses given values to run the correct checks to Verify if the timer passed or failed.

Parameters:

actionType - int, Which type of action the Verify: 1 greater, 2 less, 3 range.

Throws:

SAFSException