org.safs.model.tools

Class EmbeddedHookDriverDriver

java.lang.Object

org.safs.model.tools.AbstractDriver

org.safs.model.tools.EmbeddedHookDriverDriver

public class EmbeddedHookDriverDriver
extends AbstractDriver

An EmbeddedHookDriver wrapper attempting to provide a minimalist (simple) interface--hiding a good bit of JSAFS complexity.

Since:

OCT 15, 2013

Author:

Carl Nagle

See Also:

JSAFSDriver

Field Summary

Fields

Modifier and Type	Field and Description
static EmbeddedHookDriver	driver An available reference to an EmbeddedHookDriver
java.lang.Thread	SHUTDOWN_HOOK This is an 'AfterAll' JVM ShutdownHook--if it is needed.

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

_instance, APPMAP_FILES_PROPERTY, APPMAP_ORDER_PROPERTY, BASH, COMMA, DEFAULT_APPMAP_ORDER, HASH, SEMI

Constructor Summary

Constructors

Constructor and Description
EmbeddedHookDriverDriver(java.lang.Class<?> clazz) Initialize an instance of the EmbedddedHookDriverDriver with the specific of EmbeddedHookDriver to instantiate.

Method Summary

Modifier and Type	Method and Description
TestRecordHelper	initializeTestRecordData(AbstractCommand model, java.lang.String separator)
protected JSAFSDriver	jsafs() Provided by our internal EmbeddedHookDriver.
protected InputProcessor	processor() Does not support storing or using an InputProcessor internally.
void	run() Must be called at least once to initialize the internal Driver.
TestRecordHelper	runComponentFunctionConverted(java.lang.String command, java.lang.String child, java.lang.String parent, java.lang.String... parameters) Run a SAFS Component Function on a child component in a parent (Window).
TestRecordHelper	runDriverCommandConverted(java.lang.String command, java.lang.String... parameters) Run a SAFS Driver Command.
void	shutdown() Used to invoke the Driver shutdown function.
void	shutdownDriver() Deprecated. Use the same method name defined in the super class. Please use shutdown() instead.

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

iDriver, preloadAppMapExpressions, preloadAppMaps, processExpression, processExpressions, runComponentFunction, runComponentFunction, runComponentFunction, runDriverCommand

Methods inherited from class java.lang.Object

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

Field Detail

driver

public static EmbeddedHookDriver driver

An available reference to an EmbeddedHookDriver

SHUTDOWN_HOOK

public final java.lang.Thread SHUTDOWN_HOOK

This is an 'AfterAll' JVM ShutdownHook--if it is needed.

Constructor Detail

EmbeddedHookDriverDriver

public EmbeddedHookDriverDriver(java.lang.Class<?> clazz)

Initialize an instance of the EmbedddedHookDriverDriver with the specific of EmbeddedHookDriver to instantiate.

Parameters:

clazz -

See Also:

EmbeddedDCHookDriver, org.safs.selenium.EmbeddedSeleniumHookDriver

Method Detail

jsafs

protected JSAFSDriver jsafs()

Provided by our internal EmbeddedHookDriver.

Specified by:

jsafs in class AbstractDriver

See Also:

EmbeddedHookDriver

processor

protected InputProcessor processor()

Does not support storing or using an InputProcessor internally.

Specified by:

processor in class AbstractDriver

run

public void run()
         throws java.lang.Exception

Must be called at least once to initialize the internal Driver. This will be called automatically when using AutoConfigureJSAFS and Runner.autorun appropriately.

It can be called automatically by annotations (dependency injection), or be called from an overriding test controller like a JUnit runner, if appropriate.

Specified by:

run in class AbstractDriver

Throws:

java.lang.Exception

See Also:

AutoConfigureJSAFS, AbstractRunner.autorun(String[])

shutdown

public void shutdown()
              throws java.lang.Exception

Used to invoke the Driver shutdown function.

Specified by:

shutdown in class AbstractDriver

Throws:

java.lang.Exception

See Also:

EmbeddedHookDriver.shutdown()

shutdownDriver

@Deprecated
public void shutdownDriver()
                                 throws java.lang.Exception

Deprecated. Use the same method name defined in the super class. Please use shutdown() instead.

Used to invoke the Driver shutdown function.

Throws:

java.lang.Exception

See Also:

EmbeddedHookDriver.shutdown()

initializeTestRecordData

public TestRecordHelper initializeTestRecordData(AbstractCommand model,
                                                 java.lang.String separator)

runDriverCommandConverted

public TestRecordHelper runDriverCommandConverted(java.lang.String command,
                                                  java.lang.String... parameters)
                                           throws java.lang.Throwable

Run a SAFS Driver Command. The safs command may take one or more parameters. This method is normally called internally by overloaded methods and performs no SAFS Expression processing on the input parameters.

Overrides:

runDriverCommandConverted in class AbstractDriver

Parameters:

command - The DriverCommand keyword (command) to perform

parameters - String[] of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, Success, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED

runComponentFunctionConverted

public TestRecordHelper runComponentFunctionConverted(java.lang.String command,
                                                      java.lang.String child,
                                                      java.lang.String parent,
                                                      java.lang.String... parameters)
                                               throws java.lang.Throwable

Run a SAFS Component Function on a child component in a parent (Window). The safs action may take one or more parameters. This method is typically called internally and performs no SAFS Expression processing on the input parameters.

Overrides:

runComponentFunctionConverted in class AbstractDriver

Parameters:

command - The ComponentFunction keyword (action) to perform

child - The ComponentFunction child component name to act on

parent - The ComponentFunction parent window name to act on

parameters - String[] of parameters used by the command. Can be null.

Throws:

java.lang.Throwable

See Also:

StatusCodes.GENERAL_SCRIPT_FAILURE, StatusCodes.OK, StatusCodes.SCRIPT_WARNING, StatusCodes.SCRIPT_NOT_EXECUTED