org.imaginea.test.automation.framework.driver

Class CacheDriverFactory

java.lang.Object

org.imaginea.test.automation.framework.driver.CacheDriverFactory

public class CacheDriverFactory
extends Object

CacheDriverFactory provides a utility for creating and maintaining Selenium WebDriver instance.

Driver Creation

The framework supports an in-build implementation of driver creation as well as provide the flexibility to allow user to provide his own driver implementation.

In-build driver supports firefox,ie,chrome,htmlunit. Thes values can be set to the property test.name inside taf.properties file. For user defined driver, User have to implement a class implementing the IDriverProvider interface and add the path to the said class onto the property userdefined.driverclass inside taf.properties file.

Driver Management

The class provides two different implementation of driver factory:

1. Simple Driver Instance - In this driver instance management mode the driver object will be same across all the threads.
2. Threaded Driver Instance - In this driver instance management mode the driver will be different for each thread instance that is getting executed.

By default "Simple Driver Instance" management is chosen by the framework. But in case you need a "Threaded Driver Instance" management you can configure it by setting property thread.based.driver to true inside taf.properties file.

Author:

Varun Menon

Constructor Summary

Constructors

Constructor and Description
CacheDriverFactory() Default Constructor which will create the CacheDriverFactory object and uses the default config class object.
CacheDriverFactory(DefaultConfig config) Default Constructor which will create the CacheDriverFactory object using the DefaultConfig class object provided.

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearCacheAndQuitDriver() Clears the current driver from the factory and then quits the said driver object
org.openqa.selenium.WebDriver	clearDriver() Clears the current driver from the factory and return the old driver back
org.openqa.selenium.WebDriver	getDriver() Create or return the current driver based on the configuration provided inside the taf.properties file.
IDriverProvider	getDriverProvider() Returns the driver provider to be used for the execution.
boolean	getThreadBasedDriver() Return true or false based on the condition whether the driver object is thread based or not
IDriverProvider	getUserDefinedDriverProvider() Returns the Driver Provider class object of the class that has been provided by the user for Driver creation
void	setDriverProvider(IDriverProvider driverProvider) Sets the Driver Provider
void	setThreadBasedDriver(boolean value) Sets the thread based driver configuration with the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheDriverFactory

public CacheDriverFactory()

Default Constructor which will create the CacheDriverFactory object and uses the default config class object.

CacheDriverFactory

public CacheDriverFactory(DefaultConfig config)

Default Constructor which will create the CacheDriverFactory object using the DefaultConfig class object provided.

Parameters:

config - DefaultConfig class object that needs to be used by this class.

Method Detail

getThreadBasedDriver

public boolean getThreadBasedDriver()

Return true or false based on the condition whether the driver object is thread based or not

Returns:

true or false

setThreadBasedDriver

public void setThreadBasedDriver(boolean value)

Sets the thread based driver configuration with the given value.

Parameters:

value -

getDriver

public org.openqa.selenium.WebDriver getDriver()

Create or return the current driver based on the configuration provided inside the taf.properties file.

Returns:

WebDriver object

clearDriver

public org.openqa.selenium.WebDriver clearDriver()

Clears the current driver from the factory and return the old driver back

Returns:

WebDriver object

clearCacheAndQuitDriver

public static void clearCacheAndQuitDriver()

Clears the current driver from the factory and then quits the said driver object

getUserDefinedDriverProvider

public IDriverProvider getUserDefinedDriverProvider()

Returns the Driver Provider class object of the class that has been provided by the user for Driver creation

Returns:

IDriverProvider object or null if no class have been defined.

getDriverProvider

public IDriverProvider getDriverProvider()

Returns the driver provider to be used for the execution. In case a user defined driver provider is available the said class object is returned else it will return the InbuiltDriverProvider class instance.

Returns:

IDriverProvider object of the driver provider class.

setDriverProvider

public void setDriverProvider(IDriverProvider driverProvider)

Sets the Driver Provider

Parameters:

driverProvider - A IDriverProvider implementation object