org.safs.tools.engines

Class TIDComponent

java.lang.Object

org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

org.safs.tools.engines.GenericEngine

org.safs.tools.engines.TIDComponent

All Implemented Interfaces:

ConfigurableToolsInterface, EngineInterface, GenericToolsInterface, ITestRecordStackable, RuntimeDataInterface, Versionable

public class TIDComponent
extends GenericEngine

Provides local in-process support for GUIless Component Functions.

These are Component Functions that do not actually reference any GUI component. Some examples of these are commands like VerifyValues and certain database commands that allow the Window and Component references to be "Anything" "At All".

This engine does not assume the use of STAF. Instead, it uses the various org.safs.tools Interfaces to talk with the rest of the framework (as made available via the DriverInterface configuration).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	TIDComponent.CFComponent Local CFComponent
protected class	TIDComponent.RESTComponent Internal Component Function Processor to handle REST actions.

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentFunction	cf The special Processor for handling TID Component Function keywords.
(package private) static java.lang.String	COMMAND_CLEARAPPMAPCACHE "VerifyValues"
(package private) static java.lang.String	COMMAND_CLICK "Click"
(package private) static java.lang.String	COMMAND_CLICKSCREENIMAGE "ClickScreenImage"
(package private) static java.lang.String	COMMAND_CLICKSCREENLOCATION "ClickScreenLocation"
(package private) static java.lang.String	COMMAND_CLICKSCREENPOINT "ClickScreenPoint"
(package private) static java.lang.String	COMMAND_CTRLCLICK "CtrlClick"
(package private) static java.lang.String	COMMAND_CTRLCLICKSCREENIMAGE "CtrlClickScreenImage"
(package private) static java.lang.String	COMMAND_CTRLRIGHTCLICK "CtrlRightClick"
(package private) static java.lang.String	COMMAND_CTRLRIGHTCLICKSCREENIMAGE "CtrlRightClickScreenImage"
(package private) static java.lang.String	COMMAND_DOUBLECLICK "DoubleClick"
(package private) static java.lang.String	COMMAND_DOUBLECLICKSCREENIMAGE "DoubleClickScreenImage"
(package private) static java.lang.String	COMMAND_DOUBLECLICKSCREENLOCATION "DoubleClickScreenLocation"
(package private) static java.lang.String	COMMAND_DOUBLECLICKSCREENPOINT "DoubleClickScreenPoint"
(package private) static java.lang.String	COMMAND_GETGUIIMAGE "GetGUIImage"
(package private) static java.lang.String	COMMAND_GETTEXTFROMGUI "GetTextFromGUI"
(package private) static java.lang.String	COMMAND_GUIDOESEXIST "GUIDoesExist"
(package private) static java.lang.String	COMMAND_GUIDOESNOTEXIST "GUIDoesNotExist"
(package private) static java.lang.String	COMMAND_HOVERMOUSE "HoverMouse"
(package private) static java.lang.String	COMMAND_HOVERSCREENLOCATION "HoverScreenLocation"
(package private) static java.lang.String	COMMAND_INPUTCHARS "InputCharacterss"
(package private) static java.lang.String	COMMAND_INPUTKEYS "InputKeys"
(package private) static java.lang.String	COMMAND_LEFTDRAG "LeftDrag"
(package private) static java.lang.String	COMMAND_LOCATESCREENIMAGE "LocateScreenImage"
(package private) static java.lang.String	COMMAND_MULTICLICK "MultiClick"
(package private) static java.lang.String	COMMAND_MULTICLICKSCREENIMAGE "MultiClickScreenImage"
(package private) static java.lang.String	COMMAND_RIGHTCLICK "RightClick"
(package private) static java.lang.String	COMMAND_RIGHTCLICKSCREENIMAGE "RightClickScreenImage"
(package private) static java.lang.String	COMMAND_RIGHTCLICKSCREENLOCATION "RightClickScreenLocation"
(package private) static java.lang.String	COMMAND_RIGHTCLICKSCREENPOINT "RightClickScreenPoint"
(package private) static java.lang.String	COMMAND_RIGHTDRAG "RightDrag"
(package private) static java.lang.String	COMMAND_SAVETEXTFROMGUI "SaveTextFromGUI"
(package private) static java.lang.String	COMMAND_SHIFTCLICK "ShiftClick"
(package private) static java.lang.String	COMMAND_SHIFTCLICKSCREENIMAGE "ShiftClickScreenImage"
(package private) static java.lang.String	COMMAND_TYPECHARS "TypeChars"
(package private) static java.lang.String	COMMAND_TYPEENCRYPTION "TypeEncryption"
(package private) static java.lang.String	COMMAND_TYPEKEYS "TypeKeys"
(package private) static java.lang.String	COMMAND_VERIFYBINARYFILETOFILE "VerifyBinaryFileToFile"
(package private) static java.lang.String	COMMAND_VERIFYCLIPBOARDTOFILE "VerifyValues"
(package private) static java.lang.String	COMMAND_VERIFYFILETOFILE "VerifyFileToFile"
(package private) static java.lang.String	COMMAND_VERIFYGUIIMAGETOFILE "VerifyGUIImageToFile"
(package private) static java.lang.String	COMMAND_VERIFYTEXTFILETOFILE "VerifyTextFileToFile"
(package private) static java.lang.String	COMMAND_VERIFYVALUECONTAINS "VerifyValueContains"
(package private) static java.lang.String	COMMAND_VERIFYVALUECONTAINSIGNORECASE "VerifyValueContainsIgnoreCase"
(package private) static java.lang.String	COMMAND_VERIFYVALUEDOESNOTCONTAIN "VerifyValueDoesNotContain"
(package private) static java.lang.String	COMMAND_VERIFYVALUEEQUALS "VerifyValueEquals"
(package private) static java.lang.String	COMMAND_VERIFYVALUES "VerifyValues"
(package private) static java.lang.String	COMMAND_VERIFYVALUESIGNORECASE "VerifyValuesIgnoreCase"
(package private) static java.lang.String	COMMAND_VERIFYVALUESNOTEQUAL "VerifyValuesNotEqual"
(package private) static java.lang.String	ENGINE_NAME "SAFS/TIDComponent"
static java.lang.String	FLAG_SAFSREST "SAFSREST"
(package private) static java.lang.String	PARAM_SUPPRESSVALUE "SuppressValue"
protected ComponentFunction	restCF The special Processor for handling REST Component Function keywords.
(package private) static java.lang.String	TIDCOMPONENT_ENGINE "TIDComponent"

Fields inherited from class org.safs.tools.engines.GenericEngine

console, description, process, productName, testRecordData, testrecordStackable, version

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

config, customStr, customText, debugStr, debugText, driver, DRIVER_TEMP_PROCESS, failedStr, failedText, genericStr, genericText, launchCount, log, machine, otherStr, otherText, passedStr, passedText, processName, running, SAFS_RESBUN_NAME, servicename, shutdownCount, staf, STAFPROC_EXE, warningStr, warningText, weStartedService, weStartedSTAF

Fields inherited from interface org.safs.tools.engines.EngineInterface

COMMAND_SHUTDOWN_HOOK

Constructor Summary

Constructors

Constructor and Description
TIDComponent() Constructor for TIDComponent
TIDComponent(DriverInterface driver) PREFERRED Constructor for TIDComponent.

Method Summary

Modifier and Type	Method and Description
static Response	deleteRestResponse(java.lang.String responseID)
static void	deleteRestResponseStore() Clean the whole Map, all Responses will be removed.
static Response	getRestResponse(java.lang.String responseID)
protected java.util.Collection<java.lang.String>	interpretFields(TestRecordHelper testRecordData)
static boolean	isCheckGUIExistence(java.lang.String action) Note: We don't if the GUI exist or not, so we will NOT force to wait for GUI's existence.
static boolean	isGUILess(java.lang.String action) Note: As these are GUILess actions, so we will NOT force to wait for GUI's existence.
static boolean	isRESTFunction(java.lang.String flag) Check if the action is a REST action.
void	launchInterface(java.lang.Object configInfo) Typically expects a DriverInterface object for initialization.
static boolean	noWaitGUIExistence(java.lang.String action) Note: For some component keywords, the existence of GUI is required, like Click, GetGUIImage etc. While for others, the existence of GUI in NOT necessary, like VerifyValues, TypeKeys etc., for this kind of keywords, we will not wait for GUI existence in TestStepProcessor.process(). If the GUI existence is not necessary, then this method will return true.
void	processIndependently(TestRecordHelper testRecordData) Note: Now this method is called only by a special processor CFTIDComponent Before calling this method, you must make sure the test record data is correctly initialized.
long	processRecord(TestRecordHelper testRecordData) Initiate the event-driven protocol to send the test record to the engine.

Methods inherited from class org.safs.tools.engines.GenericEngine

deduceBenchFile, deduceProjectFile, deduceTestFile, getAppMapItem, getDescription, getEngineName, getProductName, getVariable, getVersion, isToolRunning, logMessage, makeQuotedPath, makeQuotedString, popTestRecord, postShutdownServiceDelay, pushTestRecord, reset, resetShutdownSemaphore, saveTestRecordScreenToTestDirectory, setDescription, setProductName, setTRDStatus, setVariable, setVersion, shutdownService, waitHookShutdownAndReset

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

configureJSTAFServiceEmbeddedJVMOption, extendedGenericMessage, finalize, getCoreInterface, getEmbedded64JVMBinPath, getEmbeddedJVMBinPath, getSTAFHelper, logMessage, setLogUtilities, setLogUtilities, shutdown, simpleGenericMessage, simpleGenericSuccessMessage, simpleGenericWarningMessage, simpleSuccessMessage, simpleSuccessMessage, simpleSuccessUsingMessage, standardErrorMessage, waitForServiceStartCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.tools.GenericToolsInterface

getCoreInterface, shutdown

Field Detail

ENGINE_NAME

static final java.lang.String ENGINE_NAME

"SAFS/TIDComponent"

See Also:

Constant Field Values

TIDCOMPONENT_ENGINE

static final java.lang.String TIDCOMPONENT_ENGINE

"TIDComponent"

See Also:

Constant Field Values

FLAG_SAFSREST

public static final java.lang.String FLAG_SAFSREST

"SAFSREST"

See Also:

Constant Field Values

COMMAND_CLEARAPPMAPCACHE

static final java.lang.String COMMAND_CLEARAPPMAPCACHE

"VerifyValues"

See Also:

Constant Field Values

COMMAND_VERIFYCLIPBOARDTOFILE

static final java.lang.String COMMAND_VERIFYCLIPBOARDTOFILE

"VerifyValues"

See Also:

Constant Field Values

COMMAND_VERIFYVALUES

static final java.lang.String COMMAND_VERIFYVALUES

"VerifyValues"

See Also:

Constant Field Values

COMMAND_VERIFYVALUESNOTEQUAL

static final java.lang.String COMMAND_VERIFYVALUESNOTEQUAL

"VerifyValuesNotEqual"

See Also:

Constant Field Values

COMMAND_VERIFYVALUESIGNORECASE

static final java.lang.String COMMAND_VERIFYVALUESIGNORECASE

"VerifyValuesIgnoreCase"

See Also:

Constant Field Values

COMMAND_VERIFYVALUECONTAINS

static final java.lang.String COMMAND_VERIFYVALUECONTAINS

"VerifyValueContains"

See Also:

Constant Field Values

COMMAND_VERIFYVALUECONTAINSIGNORECASE

static final java.lang.String COMMAND_VERIFYVALUECONTAINSIGNORECASE

"VerifyValueContainsIgnoreCase"

See Also:

Constant Field Values

COMMAND_VERIFYVALUEDOESNOTCONTAIN

static final java.lang.String COMMAND_VERIFYVALUEDOESNOTCONTAIN

"VerifyValueDoesNotContain"

See Also:

Constant Field Values

COMMAND_VERIFYVALUEEQUALS

static final java.lang.String COMMAND_VERIFYVALUEEQUALS

"VerifyValueEquals"

See Also:

Constant Field Values

COMMAND_VERIFYBINARYFILETOFILE

static final java.lang.String COMMAND_VERIFYBINARYFILETOFILE

"VerifyBinaryFileToFile"

See Also:

Constant Field Values

COMMAND_VERIFYFILETOFILE

static final java.lang.String COMMAND_VERIFYFILETOFILE

"VerifyFileToFile"

See Also:

Constant Field Values

COMMAND_VERIFYTEXTFILETOFILE

static final java.lang.String COMMAND_VERIFYTEXTFILETOFILE

"VerifyTextFileToFile"

See Also:

Constant Field Values

COMMAND_CLICK

static final java.lang.String COMMAND_CLICK

"Click"

See Also:

Constant Field Values

COMMAND_CTRLCLICK

static final java.lang.String COMMAND_CTRLCLICK

"CtrlClick"

See Also:

Constant Field Values

COMMAND_SHIFTCLICK

static final java.lang.String COMMAND_SHIFTCLICK

"ShiftClick"

See Also:

Constant Field Values

COMMAND_MULTICLICK

static final java.lang.String COMMAND_MULTICLICK

"MultiClick"

See Also:

Constant Field Values

COMMAND_CLICKSCREENIMAGE

static final java.lang.String COMMAND_CLICKSCREENIMAGE

"ClickScreenImage"

See Also:

Constant Field Values

COMMAND_CTRLCLICKSCREENIMAGE

static final java.lang.String COMMAND_CTRLCLICKSCREENIMAGE

"CtrlClickScreenImage"

See Also:

Constant Field Values

COMMAND_SHIFTCLICKSCREENIMAGE

static final java.lang.String COMMAND_SHIFTCLICKSCREENIMAGE

"ShiftClickScreenImage"

See Also:

Constant Field Values

COMMAND_RIGHTCLICK

static final java.lang.String COMMAND_RIGHTCLICK

"RightClick"

See Also:

Constant Field Values

COMMAND_CTRLRIGHTCLICK

static final java.lang.String COMMAND_CTRLRIGHTCLICK

"CtrlRightClick"

See Also:

Constant Field Values

COMMAND_LEFTDRAG

static final java.lang.String COMMAND_LEFTDRAG

"LeftDrag"

See Also:

Constant Field Values

COMMAND_RIGHTDRAG

static final java.lang.String COMMAND_RIGHTDRAG

"RightDrag"

See Also:

Constant Field Values

COMMAND_RIGHTCLICKSCREENIMAGE

static final java.lang.String COMMAND_RIGHTCLICKSCREENIMAGE

"RightClickScreenImage"

See Also:

Constant Field Values

COMMAND_CTRLRIGHTCLICKSCREENIMAGE

static final java.lang.String COMMAND_CTRLRIGHTCLICKSCREENIMAGE

"CtrlRightClickScreenImage"

See Also:

Constant Field Values

COMMAND_DOUBLECLICK

static final java.lang.String COMMAND_DOUBLECLICK

"DoubleClick"

See Also:

Constant Field Values

COMMAND_DOUBLECLICKSCREENIMAGE

static final java.lang.String COMMAND_DOUBLECLICKSCREENIMAGE

"DoubleClickScreenImage"

See Also:

Constant Field Values

COMMAND_MULTICLICKSCREENIMAGE

static final java.lang.String COMMAND_MULTICLICKSCREENIMAGE

"MultiClickScreenImage"

See Also:

Constant Field Values

COMMAND_LOCATESCREENIMAGE

static final java.lang.String COMMAND_LOCATESCREENIMAGE

"LocateScreenImage"

See Also:

Constant Field Values

COMMAND_GETGUIIMAGE

static final java.lang.String COMMAND_GETGUIIMAGE

"GetGUIImage"

See Also:

Constant Field Values

COMMAND_HOVERMOUSE

static final java.lang.String COMMAND_HOVERMOUSE

"HoverMouse"

See Also:

Constant Field Values

COMMAND_VERIFYGUIIMAGETOFILE

static final java.lang.String COMMAND_VERIFYGUIIMAGETOFILE

"VerifyGUIImageToFile"

See Also:

Constant Field Values

COMMAND_GUIDOESEXIST

static final java.lang.String COMMAND_GUIDOESEXIST

"GUIDoesExist"

See Also:

Constant Field Values

COMMAND_GUIDOESNOTEXIST

static final java.lang.String COMMAND_GUIDOESNOTEXIST

"GUIDoesNotExist"

See Also:

Constant Field Values

COMMAND_CLICKSCREENPOINT

static final java.lang.String COMMAND_CLICKSCREENPOINT

"ClickScreenPoint"

See Also:

Constant Field Values

COMMAND_RIGHTCLICKSCREENPOINT

static final java.lang.String COMMAND_RIGHTCLICKSCREENPOINT

"RightClickScreenPoint"

See Also:

Constant Field Values

COMMAND_DOUBLECLICKSCREENPOINT

static final java.lang.String COMMAND_DOUBLECLICKSCREENPOINT

"DoubleClickScreenPoint"

See Also:

Constant Field Values

COMMAND_HOVERSCREENLOCATION

static final java.lang.String COMMAND_HOVERSCREENLOCATION

"HoverScreenLocation"

See Also:

Constant Field Values

COMMAND_CLICKSCREENLOCATION

static final java.lang.String COMMAND_CLICKSCREENLOCATION

"ClickScreenLocation"

See Also:

Constant Field Values

COMMAND_RIGHTCLICKSCREENLOCATION

static final java.lang.String COMMAND_RIGHTCLICKSCREENLOCATION

"RightClickScreenLocation"

See Also:

Constant Field Values

COMMAND_DOUBLECLICKSCREENLOCATION

static final java.lang.String COMMAND_DOUBLECLICKSCREENLOCATION

"DoubleClickScreenLocation"

See Also:

Constant Field Values

COMMAND_TYPEKEYS

static final java.lang.String COMMAND_TYPEKEYS

"TypeKeys"

See Also:

Constant Field Values

COMMAND_INPUTKEYS

static final java.lang.String COMMAND_INPUTKEYS

"InputKeys"

See Also:

Constant Field Values

COMMAND_TYPECHARS

static final java.lang.String COMMAND_TYPECHARS

"TypeChars"

See Also:

Constant Field Values

COMMAND_TYPEENCRYPTION

static final java.lang.String COMMAND_TYPEENCRYPTION

"TypeEncryption"

See Also:

Constant Field Values

COMMAND_INPUTCHARS

static final java.lang.String COMMAND_INPUTCHARS

"InputCharacterss"

See Also:

Constant Field Values

COMMAND_GETTEXTFROMGUI

static final java.lang.String COMMAND_GETTEXTFROMGUI

"GetTextFromGUI"

See Also:

Constant Field Values

COMMAND_SAVETEXTFROMGUI

static final java.lang.String COMMAND_SAVETEXTFROMGUI

"SaveTextFromGUI"

See Also:

Constant Field Values

PARAM_SUPPRESSVALUE

static final java.lang.String PARAM_SUPPRESSVALUE

"SuppressValue"

See Also:

Constant Field Values

cf

protected ComponentFunction cf

The special Processor for handling TID Component Function keywords.

restCF

protected ComponentFunction restCF

The special Processor for handling REST Component Function keywords.

Constructor Detail

TIDComponent

public TIDComponent()

Constructor for TIDComponent

TIDComponent

public TIDComponent(DriverInterface driver)

PREFERRED Constructor for TIDComponent. Constructs the instance and calls launchInterface to initialize.

Method Detail

launchInterface

public void launchInterface(java.lang.Object configInfo)

Description copied from class: GenericEngine

Typically expects a DriverInterface object for initialization. Subclasses should indicate if an alternative type of object is required. This method will try to reset the "shutdown" semaphore remained by last hook shutdown.

Specified by:

launchInterface in interface ConfigurableToolsInterface

Overrides:

launchInterface in class GenericEngine

Parameters:

configInfo - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.

See Also:

GenericEngine.launchInterface(Object)

processRecord

public long processRecord(TestRecordHelper testRecordData)

Description copied from class: GenericEngine

Initiate the event-driven protocol to send the test record to the engine. All official engines conform to this protocol. So this function rarely needs to be overridden..

Specified by:

processRecord in interface EngineInterface

Overrides:

processRecord in class GenericEngine

Returns:

the status code resulting from the processing.

• 4 -- SCRIPT NOT EXECUTED. "I did not process this record."
• -1 -- NO SCRIPT FAILURE. "I processed the record successfully."
• -2 -- SCRIPT WARNING. "I processed the record, issued warning(s)."
• 0 -- SCRIPT FAILURE. "I processed the record, issued failure(s)."
• 2 -- IO FAILURE. "I process the record, issued IO failure(s)."
• 8 -- EXIT TABLE. "I processed the record, exit current table."
• 16 -- IGNORE STATUS. "I processed the record, ignore code and continue."

See Also:

EngineInterface#processRecord()

processIndependently

public void processIndependently(TestRecordHelper testRecordData)

Note: Now this method is called only by a special processor CFTIDComponent Before calling this method, you must make sure the test record data is correctly initialized.

Parameters:

testRecordData -

interpretFields

protected java.util.Collection<java.lang.String> interpretFields(TestRecordHelper testRecordData)

isGUILess

public static boolean isGUILess(java.lang.String action)

Note: As these are GUILess actions, so we will NOT force to wait for GUI's existence.

Parameters:

action - String, the keyword to execute

Returns:

boolean true if the keyword is GUI independant, means it can be executed without 'Window' and 'Component'.

isCheckGUIExistence

public static boolean isCheckGUIExistence(java.lang.String action)

Note: We don't if the GUI exist or not, so we will NOT force to wait for GUI's existence.

Parameters:

action - String, the keyword to execute

Returns:

boolean, true if the keyword is to check GUI's existence

noWaitGUIExistence

public static boolean noWaitGUIExistence(java.lang.String action)

Note: For some component keywords, the existence of GUI is required, like Click, GetGUIImage etc.
While for others, the existence of GUI in NOT necessary, like VerifyValues, TypeKeys etc., for this
kind of keywords, we will not wait for GUI existence in TestStepProcessor.process().
If the GUI existence is not necessary, then this method will return true.

Parameters:

action - String, the keyword to execute

Returns:

boolean, true if there is no need to wait the existence of GUI.

See Also:

TestStepProcessor.process()

isRESTFunction

public static boolean isRESTFunction(java.lang.String flag)

Check if the action is a REST action.

Parameters:

flag - String, it could be the WindowID or the WindowName

Returns:

boolean true if the action is RESTful.

getRestResponse

public static Response getRestResponse(java.lang.String responseID)

Parameters:

responseID - String, the unique ID to identify the rest service Response.

Returns:

Response, a cached Response returned from a rest service. null if it doesn't exist.

deleteRestResponse

public static Response deleteRestResponse(java.lang.String responseID)

Parameters:

responseID - String, the unique ID to identify the rest service Response.

Returns:

Response, a cached Response deleted from the internal Map. null if it doesn't exist.

deleteRestResponseStore

public static void deleteRestResponseStore()

Clean the whole Map, all Responses will be removed.