org.openqa.selenium.firefox

Class FirefoxDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.firefox.FirefoxDriver

All Implemented Interfaces:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.interactions.Interactive, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.internal.Killable, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class FirefoxDriver
extends org.openqa.selenium.remote.RemoteWebDriver
implements org.openqa.selenium.internal.Killable

An implementation of the {#link WebDriver} interface that drives Firefox.

The best way to construct a FirefoxDriver with various options is to make use of the FirefoxOptions, like so:

FirefoxOptions options = new FirefoxOptions()
    .setProfile(new FirefoxProfile());
WebDriver driver = new FirefoxDriver(options);
 

Property Summary

Type	Property and Description
private static java.lang.Boolean	forceMarionetteFromSystem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirefoxDriver.LazyCommandExecutor
static class	FirefoxDriver.SystemProperty

Nested classes/interfaces inherited from class org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.remote.RemoteWebDriver.RemoteTargetLocator, org.openqa.selenium.remote.RemoteWebDriver.RemoteWebDriverOptions, org.openqa.selenium.remote.RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ACCEPT_UNTRUSTED_CERTIFICATES Deprecated.
static boolean	ASSUME_UNTRUSTED_ISSUER Deprecated.
protected FirefoxBinary	binary
static java.lang.String	BINARY
static java.lang.String	MARIONETTE
static java.lang.String	PROFILE

Constructor Summary

Constructors

Modifier	Constructor and Description
	FirefoxDriver()
	FirefoxDriver(org.openqa.selenium.Capabilities desiredCapabilities)
	FirefoxDriver(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)
private	FirefoxDriver(org.openqa.selenium.remote.CommandExecutor executor, org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)
	FirefoxDriver(FirefoxBinary binary) Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary).
	FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile) Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary), and FirefoxOptions.setProfile(FirefoxProfile).
	FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile, org.openqa.selenium.Capabilities capabilities) Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary), FirefoxOptions.setProfile(FirefoxProfile)
	FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile, org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities) Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary), FirefoxOptions.setProfile(FirefoxProfile)
	FirefoxDriver(FirefoxOptions options)
	FirefoxDriver(FirefoxProfile profile)
	FirefoxDriver(GeckoDriverService driverService) Deprecated. No replacement.
	FirefoxDriver(GeckoDriverService driverService, org.openqa.selenium.Capabilities desiredCapabilities) Deprecated. No replacement.
	FirefoxDriver(GeckoDriverService driverService, org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities) Deprecated. No replacement.

Method Summary

Modifier and Type	Method and Description
protected ExtensionConnection	connectTo(FirefoxBinary binary, FirefoxProfile profile, java.lang.String host)
private static org.openqa.selenium.Capabilities	dropCapabilities(org.openqa.selenium.Capabilities capabilities) Drops capabilities that we shouldn't send over the wire.
private static java.lang.Boolean	forceMarionetteFromSystemProperty()
private static FirefoxOptions	getFirefoxOptions(org.openqa.selenium.Capabilities capabilities)
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> target)
private static boolean	isLegacy(org.openqa.selenium.Capabilities desiredCapabilities)
void	kill() Attempt to forcibly kill this Killable at the OS level.
org.openqa.selenium.WebDriver.Options	manage()
protected org.openqa.selenium.internal.Lock	obtainLock(FirefoxProfile profile)
void	setFileDetector(org.openqa.selenium.remote.FileDetector detector)
protected void	startClient(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)
protected void	stopClient()
private static org.openqa.selenium.remote.CommandExecutor	toExecutor(FirefoxOptions options)

Methods inherited from class org.openqa.selenium.remote.RemoteWebDriver

close, execute, execute, executeAsyncScript, executeScript, findElement, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getExecuteMethod, getFileDetector, getKeyboard, getMouse, getPageSource, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, navigate, perform, quit, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFoundBy, setLogLevel, setSessionId, startClient, startSession, startSession, stopClient, switchTo, toString

Methods inherited from class java.lang.Object

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

Property Detail

forceMarionetteFromSystem

private static java.lang.Boolean forceMarionetteFromSystemProperty

Field Detail

BINARY

public static final java.lang.String BINARY

See Also:

Constant Field Values

PROFILE

public static final java.lang.String PROFILE

See Also:

Constant Field Values

MARIONETTE

public static final java.lang.String MARIONETTE

See Also:

Constant Field Values

ACCEPT_UNTRUSTED_CERTIFICATES

@Deprecated
public static final boolean ACCEPT_UNTRUSTED_CERTIFICATES

Deprecated.

See Also:

Constant Field Values

ASSUME_UNTRUSTED_ISSUER

@Deprecated
public static final boolean ASSUME_UNTRUSTED_ISSUER

Deprecated.

See Also:

Constant Field Values

binary

protected FirefoxBinary binary

Constructor Detail

FirefoxDriver

public FirefoxDriver()

FirefoxDriver

public FirefoxDriver(FirefoxOptions options)

FirefoxDriver

@Deprecated
public FirefoxDriver(FirefoxBinary binary)

Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary).

FirefoxDriver

public FirefoxDriver(FirefoxProfile profile)

FirefoxDriver

@Deprecated
public FirefoxDriver(FirefoxBinary binary,
                                 FirefoxProfile profile)

Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary), and FirefoxOptions.setProfile(FirefoxProfile).

FirefoxDriver

public FirefoxDriver(org.openqa.selenium.Capabilities desiredCapabilities)

FirefoxDriver

public FirefoxDriver(org.openqa.selenium.Capabilities desiredCapabilities,
                     org.openqa.selenium.Capabilities requiredCapabilities)

FirefoxDriver

@Deprecated
public FirefoxDriver(FirefoxBinary binary,
                                 FirefoxProfile profile,
                                 org.openqa.selenium.Capabilities capabilities)

Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary), FirefoxOptions.setProfile(FirefoxProfile)

FirefoxDriver

@Deprecated
public FirefoxDriver(FirefoxBinary binary,
                                 FirefoxProfile profile,
                                 org.openqa.selenium.Capabilities desiredCapabilities,
                                 org.openqa.selenium.Capabilities requiredCapabilities)

Deprecated. Prefer FirefoxOptions.setBinary(FirefoxBinary), FirefoxOptions.setProfile(FirefoxProfile)

FirefoxDriver

@Deprecated
public FirefoxDriver(GeckoDriverService driverService)

Deprecated. No replacement.

FirefoxDriver

@Deprecated
public FirefoxDriver(GeckoDriverService driverService,
                                 org.openqa.selenium.Capabilities desiredCapabilities)

Deprecated. No replacement.

FirefoxDriver

@Deprecated
public FirefoxDriver(GeckoDriverService driverService,
                                 org.openqa.selenium.Capabilities desiredCapabilities,
                                 org.openqa.selenium.Capabilities requiredCapabilities)

Deprecated. No replacement.

FirefoxDriver

private FirefoxDriver(org.openqa.selenium.remote.CommandExecutor executor,
                      org.openqa.selenium.Capabilities desiredCapabilities,
                      org.openqa.selenium.Capabilities requiredCapabilities)

Method Detail

toExecutor

private static org.openqa.selenium.remote.CommandExecutor toExecutor(FirefoxOptions options)

getFirefoxOptions

private static FirefoxOptions getFirefoxOptions(org.openqa.selenium.Capabilities capabilities)

setFileDetector

public void setFileDetector(org.openqa.selenium.remote.FileDetector detector)

Overrides:

setFileDetector in class org.openqa.selenium.remote.RemoteWebDriver

kill

public void kill()

Attempt to forcibly kill this Killable at the OS level. Useful where the extension has stopped responding, and you don't want to leak resources. Should not ordinarily be called.

Specified by:

kill in interface org.openqa.selenium.internal.Killable

manage

public org.openqa.selenium.WebDriver.Options manage()

Specified by:

manage in interface org.openqa.selenium.WebDriver

Overrides:

manage in class org.openqa.selenium.remote.RemoteWebDriver

isLegacy

private static boolean isLegacy(org.openqa.selenium.Capabilities desiredCapabilities)

forceMarionetteFromSystemProperty

private static java.lang.Boolean forceMarionetteFromSystemProperty()

startClient

protected void startClient(org.openqa.selenium.Capabilities desiredCapabilities,
                           org.openqa.selenium.Capabilities requiredCapabilities)

Overrides:

startClient in class org.openqa.selenium.remote.RemoteWebDriver

connectTo

protected ExtensionConnection connectTo(FirefoxBinary binary,
                                        FirefoxProfile profile,
                                        java.lang.String host)

obtainLock

protected org.openqa.selenium.internal.Lock obtainLock(FirefoxProfile profile)

stopClient

protected void stopClient()

Overrides:

stopClient in class org.openqa.selenium.remote.RemoteWebDriver

dropCapabilities

private static org.openqa.selenium.Capabilities dropCapabilities(org.openqa.selenium.Capabilities capabilities)

Drops capabilities that we shouldn't send over the wire. Used for capabilities which aren't BeanToJson-convertable, and are only used by the local launcher.

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> target)

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Overrides:

getScreenshotAs in class org.openqa.selenium.remote.RemoteWebDriver