Package org.safs

Interface Summary

Interface	Description
DDGUtilsInterface	Purpose:static DDG utilities, concept taken from SQABasic version
HookConfig	In SAFS, the engine and hook will normally run in different JVM.
Printable
SAFSVersion	version of the SAFS package

Class Summary

Class	Description
ApplicationMap	The Application Map (App Map) provides storage for Objects referencing the Application being tested.
CFDefaultComponent	Purpose: CFDefaultComponent, process a default generic component Lifetime: instantiated by TestStepProcessor
ComponentFunction	Purpose: abstract ComponentFunction, enforces that the 'process' method be implemented COMPONENT FUNCTIONS (so far...): CFButton CFCheckBox check Example: T,Frame,rememberPasswordCheckBox,check uncheck Example: TF,Frame,rememberPasswordCheckBox,uncheck CFComboBox selectIndex 1st param: index into the combobox of the item to select Example: T,Frame,nameComboComboBox,selectIndex,2 select/selectTextItem/selectUnverified/selectUnverifiedTextItem 1st param: name of the item to select Example: T,Frame,nameComboComboBox,select,Karen Farrell setTextValue (not sure if this one actually works, does guiObj.setProperty("text", val);) 1st param: name of the item to select Example: T,Frame,nameComboComboBox,selectPartialMatch,Sammy The Fish showlist/hidelist - shows or hides the list Example: T,Frame,nameComboComboBox,showlist CFComponent (Available to nearly all components) click/rightClick Example: T,Frame,radioButtonARadioButton,click closeWindow/restore/minimize/maximize Example: T,Frame,radioButtonARadioButton,restore verifyProperty - verify that a property exists and exactly matches specified value 1st param: property name 2nd param: property value to verify against Example: TW,PlaceOrder,totalPriceLabel,VerifyProperty,text,$19.99 verifyPropertyContains - verify that a property exists and contains specified value 1st param: property name 2nd param: property value to look for containment (substring of actual) Example: TW,PlaceOrder,totalPriceLabel,VerifyPropertyContains,text,19 verifyValue - verify that a value exactly matches specified value 1st param: property name 2nd param: property value to verify against Example: TW,PlaceOrder,totalPriceLabel,VerifyValue,$19.99,^variable verifyValueContains - verify that a value contains specified value 1st param: property name 2nd param: property value to look for containment (substring of actual) Example: TW,PlaceOrder,totalPriceLabel,VerifyPropertyContains,^variable,$19 clearAppMapCache - clear the cache of testobjects, normally not needed.
ComponentFunction.Window	An inner class to encapsulate a window information for adjusting window size, position etc. It includes also some static methods to restore, maximize, minimize or close current focused window. These methods may only work on Windows system, it uses java Robot to trigger shortcut menu.
Constants	Containing different kinds of Constant.
Constants.AutoItConstants
Constants.BrowserConstants
Constants.EclipseConstants
Constants.JSONConstants
Constants.LogConstants
Constants.RestConstants
Constants.SeleniumConstants
Constants.XMLConstants
DatabaseCommandsHelper	Purpose: DatabaseCommandsHelper, used by DCDriverCommands.
DatabaseUtils	Purpose: Utilities to find a database connection using java.sql.DriverManager; can also getValues.
DCDriverDatabaseCommands	Purpose: DCDriverDatabaseCommands, process a database driver commands Lifetime: instantiated by DCDriverCommand im
DCDriverFileCommands	DCDriverFileCommands, process a file driver commands instantiated by DCDriverCommand
DCDriverFlowCommands	Purpose: DCDriverFlowCommands, process driver flow commands Lifetime: instantiated by DCDriverCommand im
DCDriverMiscCommands	Purpose: DCDriverMiscCommands, process a miscellaneous driver commands, like pause Lifetime: instantiated by DCDriverCommand
DCDriverStringCommands	Process a string driver commands.
DCDriverTimerCommands	Process a timer commands.
DCGUIUtilities	Concrete subclass of DDGUIUtilities that provides no real implementation for the handling of GUI components.
DCJavaHook
DCTestRecordHelper	Concrete subclass of TestRecordHelper that provides no additional functionality.
DDGUIUtilities	Here we provide the basis for handling Application Maps through the SAFSMAPS service in STAF.
DefaultDDGUtils	Purpose:DDG utilities, concept taken from SQABasic version
DefaultHookConfig
Domains
DriverCommand	Purpose: abstract DriverCommand, enforces that the 'process' method be implemented
DriverCommandProcessor	Purpose: DriverCommandProcessor Lifetime: instantiated by ProcessRequest
EmbeddedDCHookDriver	Default EmbeddedHookDriver subclass for the SAFS DriverCommands Engine.
EngineCommandProcessor	EngineCommandProcessor for Record Type: 'E' Instantiated by ProcessRequest.
GetText	Purpose: GetText, get text from a resource bundle Lifetime: must be instantiated before it can be used
GuiChildIterator
GuiClassData	This class is primarily used to open and read in external data files that map class names to supported class types as well as mapping class types to the library supporting the mapped class type.
GuiObjectRecognition	Used internally. Manages and manipulates object recognition string information.
GuiObjectVector	This class is intended to maintain critical component recognition information for each level of the application GUI hierarchy represented in a standard component recognition string.
IndependantLog	Use reflection for org.safs.Log to do the Log work.
IndependantLog.ConsoleDebugListener	an implementation of interface DebugListener, output debug message to console.
JavaConstant
JavaHook	Generic Java Hook for tool-independent SAFS Engines.
JavaSocketsHook	A class to extend the standard JavaHook allowing the integration/control of a "remote" engine controlled via TCP Sockets where STAF is NOT available.
JavaSocketsUtils	Constants and utilities used by a JavaSocketsHook and a remote SocketProtocol client.
Log	SAFS Debug Log
MatchData	This class is used to fill the matches Vector with match data.
PCTree	PCTree, used by various testing tool's ProcessContainer, is used to produce consistent recognition strings across all tools.
Processor	Abstract Processor, enforces that the 'process' and 'isSupportedRecordType' methods be implemented.
ProcessRequest	Purpose: ProcessRequest does a request when intantiated with a TestRecordData; it acts like a factory which first grabs the request (recordType), then routes it by instantiating the appropriate processor Lifetime: instantiated by a hook script or some kind of controller.
RobotJHook	Description : RobotJ Hook Script *** This class needs to be eliminated with RRobotJHook subclassing 'JavaHook' ***
RSA	This class provides the functionality to generate the RSA public/private key pair encrypt the secrete data with public key decrypt the encrypted data by private key Usage: //generate a pair (public-key and private-key) and print them to console //user needs to move the mouse on the screen to provide random data for generating keys java org.safs.RSA -gen //generate a pair (public-key and private-key) and print them to file 'outputfile' java org.safs.RSA -gen -out outputfile
SAFSPlus	This class will provide a general JAVA API to access the SAFS keywords.
SAFSPlus.Assert	A set of assertions methods for tests.
SAFSPlus.CheckBox	Wrapper class providing APIs to handle CheckBox keywords, like Check, UnCheck.
SAFSPlus.ComboBox	Wrapper class providing APIs to handle ComboBox keywords, like Select, ShowList, SetTextValue etc.
SAFSPlus.Component	Wrapper class providing APIs to handle GenericMasterFunctions Reference and GenericObjectFunctions Reference, like VerifyProperty, IsPropertyExist etc.
SAFSPlus.Counters	Wrapper class providing APIs to handle DriverCounter keywords, like StartTestSuite, StartCounter, LogCounterInfo etc. It also provides: some convenient APIs, like SAFSPlus.Counters.PrintTestCaseSummary(String), SAFSPlus.Counters.PrintTestSuiteSummary(String) etc.
SAFSPlus.DriverCommand	Wrapper class providing APIs to handle Driver keywords, like StartWebBrowser, UseWebBrowser, SetPosition etc.
SAFSPlus.EditBox	Wrapper class providing APIs to handle EditBox keywords, like SetTextValue, SetTextCharacters etc.
SAFSPlus.Files	Wrapper class providing APIs to handle File keywords, like OpenFile, ReadFileLine etc.
SAFSPlus.ListView	Wrapper class providing APIs to handle ListView keywords, like ClickIndex, VerifyListContains etc.
SAFSPlus.Logging	Wrapper class providing APIs to handle Logging keywords, like LogMessage, LogTestWarning etc.
SAFSPlus.Menu	Wrapper class providing APIs to handle MenuBar/Menu keywords, like SelectMenuItem, VerifyMenuItemContains etc.
SAFSPlus.Misc	Class for miscellaneous Driver Commands. This is a sub-class of DriverCommand and it provides more convenient wrapper APIs.
SAFSPlus.Rest	Wrapper class providing APIs to handle TIDRestFunctions Reference and DriverRestCommands Reference, like RestGetBinary, RestStoreResponse etc.
SAFSPlus.ScrollBar	Wrapper class providing APIs to handle ScrollBar keywords, like OneDown, PageDown, PageUp etc.
SAFSPlus.Strings	Wrapper class providing APIs to handle String keywords, like Compare, GetMultiDelimitedField etc.
SAFSPlus.TabControl	Wrapper class providing APIs to handle TabControl keywords, like ClickTab, SelectTabIndex etc.
SAFSPlus.Tree	Wrapper class providing APIs to handle Tree keywords, like ClickTextNode, ExpandTextNode etc.
SAFSPlus.Window	Wrapper class providing APIs to handle Window keywords, like Maximize, Minimize, SetPosition etc.
SAFSStringTokenizer	All Implemented Interfaces: Enumeration
SingletonSTAFHelper	Purpose: a wrapper class for the STAFHandle, includes some common functionality used many places associated with the SAFSVARS and SAFSMAPS; This is the Singleton version.
SocketTestRecordHelper
STAFHelper	Purpose: a wrapper class for the STAFHandle, includes some common functionality used many places associated with the SAFSVARS and SAFSMAPS
STAFRequester	A superclass for objects that will need a reference to a STAFHandle for STAF requests.
StatusCodes	Purpose: holds the status codes (static final int fields)
StringMBTokenizer	All Implemented Interfaces: Enumeration
StringUtils	This class provides different kinds of utilities to handle string.
StringUtils.ErrorLineParser	This class is used to parse the test error message.
StringUtils.ErrorLinkTrace	This class encapsulate the test error message.
TestRecordData	Purpose:TestRecordData: holds key data used by a driver, like step driver.
TestRecordHelper	Purpose:TestRecordHelper: helper class which can populate data in TestRecordData It can be populated from a STAF Variables pool.
TestRecordHelper.MySTAFRequester
TestStepProcessor	Purpose: TestStepProcessor Lifetime: instantiated by ProcessRequest
Tree	Purpose: generic tree object
Utils

Exception Summary

Exception	Description
SAFSBreakpointException
SAFSException	Purpose: our user defined application exception used with this package.
SAFSNullPointerException	A simple extension stub for Application Object problems
SAFSObjectNotFoundException	A simple extension stub for Application Object problems
SAFSObjectRecognitionException	A simple extension stub for Application Object problems
SAFSParamException
SAFSPersistableNotEnableException
SAFSProcessorInitializationException	Flags the ommission of proper initialization of a ProcessRequester.
SAFSRegExException	A simple extension stub for Application Object problems
SAFSRegExNotFoundException	Flags the ommission of support for Regular Expressions needed by StringUtils and other classes.
SAFSRuntimeException	Purpose: our user defined application exception used with this package.
SAFSSTAFRegistrationException	A simple extension stub for STAF Registration problems
SAFSVerificationException	A simple extension stub for verification problems