Package org.openqa.selenium.firefox

Class GeckoDriverInfo

java.lang.Object

org.openqa.selenium.firefox.GeckoDriverInfo

All Implemented Interfaces:

WebDriverInfo

@AutoService(WebDriverInfo.class)
public class GeckoDriverInfo
extends Object
implements WebDriverInfo

Constructor Summary

Constructors

Constructor	Description
GeckoDriverInfo()

Method Summary

Modifier and Type	Method	Description
Optional<WebDriver>	createDriver(Capabilities capabilities)	Creates a new instance of the WebDriver implementation.
Capabilities	getCanonicalCapabilities()	Describes the smallest set of Capabilities that could be used to create an instance of this WebDriver implementation.
String	getDisplayName()
int	getMaximumSimultaneousSessions()	Some browsers require all the resources of the current system in order to run (for example, Safari on iOS) and so do not support multiple simultaneous sessions on the same system.
boolean	isAvailable()	Often, a WebDriver instance needs one or more supporting files or executables to be present (such as a vendor-provided executable which speaks the WebDriver Protocol).
boolean	isPresent()	Checks whether the browser driver is already present on the host machine.
boolean	isSupporting(Capabilities capabilities)
boolean	isSupportingBiDi()
boolean	isSupportingCdp()

Methods inherited from class java.lang.Object

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

Constructor Details

GeckoDriverInfo

public GeckoDriverInfo()

Method Details

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface WebDriverInfo

Returns:

A human-readable name that describes the browser.

getCanonicalCapabilities

public Capabilities getCanonicalCapabilities()

Description copied from interface: WebDriverInfo

Describes the smallest set of Capabilities that could be used to create an instance of this WebDriver implementation.

Note, this set does not need to be exhaustive: the only requirement is that if WebDriverInfo.isAvailable() returns true, the returned Capabilities can be passed to WebDriverInfo.createDriver(Capabilities) and a session will be created.

Specified by:

getCanonicalCapabilities in interface WebDriverInfo

Returns:

The smallest set of Capabilities required to create an instance of this WebDriver implementation.

isSupporting

public boolean isSupporting(Capabilities capabilities)

Specified by:

isSupporting in interface WebDriverInfo

Returns:

Whether a call to WebDriverInfo.createDriver(Capabilities) would succeed if given capabilities.

isSupportingCdp

public boolean isSupportingCdp()

Specified by:

isSupportingCdp in interface WebDriverInfo

Returns:

Whether the driver has enabled the CDP interface.

isSupportingBiDi

public boolean isSupportingBiDi()

Specified by:

isSupportingBiDi in interface WebDriverInfo

Returns:

Whether the driver has enabled the BiDi interface.

isAvailable

public boolean isAvailable()

Description copied from interface: WebDriverInfo

Often, a WebDriver instance needs one or more supporting files or executables to be present (such as a vendor-provided executable which speaks the WebDriver Protocol). This means that even though the driver classes might be present in Java, it would make no sense to attempt to instantiate the driver itself.

Specified by:

isAvailable in interface WebDriverInfo

Returns:

Whether the prerequisites required for this WebDriver are present.

isPresent

public boolean isPresent()

Description copied from interface: WebDriverInfo

Checks whether the browser driver is already present on the host machine. Different from WebDriverInfo.isAvailable() which uses Selenium Manager to obtain the driver when not present.

Specified by:

isPresent in interface WebDriverInfo

Returns:

Whether the browser driver is present on the host machine.

getMaximumSimultaneousSessions

public int getMaximumSimultaneousSessions()

Description copied from interface: WebDriverInfo

Some browsers require all the resources of the current system in order to run (for example, Safari on iOS) and so do not support multiple simultaneous sessions on the same system. Other browsers can create isolated state for each new WebDriver instance.

The count of simultaneous sessions is typically 1, some multiple of the available number of cores, or Integer.MAX_VALUE if the number is unbounded or no-one cares.

Specified by:

getMaximumSimultaneousSessions in interface WebDriverInfo

createDriver

public Optional<WebDriver> createDriver(Capabilities capabilities)
                                 throws SessionNotCreatedException

Description copied from interface: WebDriverInfo

Creates a new instance of the WebDriver implementation. The instance must be killed by sending the "quit" command. If the instance cannot be created because WebDriverInfo.isAvailable() is false, then Optional.empty() is returned. Otherwise, an attempt to start the session is made and the result returned.

Specified by:

createDriver in interface WebDriverInfo

Throws:

SessionNotCreatedException