ru.stqa.selenium.factory

Interface WebDriverPool

All Known Implementing Classes:

AbstractWebDriverPool, LooseWebDriverPool, SingleWebDriverPool, ThreadLocalSingleWebDriverPool

public interface WebDriverPool

An utility that helps to create, reuse and dismiss WebDriver instances. The WebDriver instances created by the pool and stored in the pool are called "managed instances". There are three ways to manage instances, three classes that implement WebDriverPool interface:

• SingleWebDriverPool allows a single managed instance of WebDriver to exist at any given moment,
• ThreadLocalSingleWebDriverPool allows a single managed instance of WebDriver to exist for each thread,
• LooseWebDriverPool does not impose any restrictions, it creates a new managed instance on each request

See documentation at https://github.com/barancev/webdriver-factory/ See usage examples at https://github.com/barancev/webdriver-factory-samples/

Field Summary

Fields

Modifier and Type	Field and Description
static WebDriverPool	DEFAULT Default pool

Method Summary

Modifier and Type	Method and Description
void	dismissAll() Quits all the managed drivers and empties the pool.
void	dismissDriver(org.openqa.selenium.WebDriver driver) Quits the driver and removes it from the pool, if it is a managed instance.
default org.openqa.selenium.WebDriver	getDriver(org.openqa.selenium.Capabilities capabilities) Returns a managed local instance of WebDriver with the given capabilities.
default org.openqa.selenium.WebDriver	getDriver(String browser) Returns a managed local instance of WebDriver for the given browser.
org.openqa.selenium.WebDriver	getDriver(URL hub, org.openqa.selenium.Capabilities capabilities) Returns a managed remote instance of WebDriver with the given capabilities.
default org.openqa.selenium.WebDriver	getDriver(URL hub, String browser) Returns a managed remote instance of WebDriver for the given browser.
boolean	isEmpty() Checks if the pool is empty.
void	setDriverAlivenessChecker(DriverAlivenessChecker alivenessChecker)
void	setLocalDriverProvider(LocalDriverProvider localDriverProvider)
void	setRemoteDriverProvider(RemoteDriverProvider remoteDriverProvider)

Field Detail

DEFAULT

static final WebDriverPool DEFAULT

Default pool

Method Detail

getDriver

default org.openqa.selenium.WebDriver getDriver(String browser)

Returns a managed local instance of WebDriver for the given browser.

Parameters:

browser - The desired browser

getDriver

default org.openqa.selenium.WebDriver getDriver(URL hub,
                                                String browser)

Returns a managed remote instance of WebDriver for the given browser.

Parameters:

hub - The Selenium Server Hub address

browser - The desired browser

getDriver

default org.openqa.selenium.WebDriver getDriver(org.openqa.selenium.Capabilities capabilities)

Returns a managed local instance of WebDriver with the given capabilities.

Parameters:

capabilities - The desired driver capabilities

getDriver

org.openqa.selenium.WebDriver getDriver(URL hub,
                                        org.openqa.selenium.Capabilities capabilities)

Returns a managed remote instance of WebDriver with the given capabilities.

Parameters:

hub - The Selenium Server Hub address

capabilities - The desired driver capabilities

dismissDriver

void dismissDriver(org.openqa.selenium.WebDriver driver)

Quits the driver and removes it from the pool, if it is a managed instance. Throws an Error on attempt to dismiss an unmanaged instance of WebDriver.

Parameters:

driver - The driver that is not in use anymore and should be dismissed

dismissAll

void dismissAll()

Quits all the managed drivers and empties the pool.

isEmpty

boolean isEmpty()

Checks if the pool is empty.

setDriverAlivenessChecker

void setDriverAlivenessChecker(DriverAlivenessChecker alivenessChecker)

setLocalDriverProvider

void setLocalDriverProvider(LocalDriverProvider localDriverProvider)

setRemoteDriverProvider

void setRemoteDriverProvider(RemoteDriverProvider remoteDriverProvider)