org.openqa.selenium.firefox

Class FirefoxDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.firefox.FirefoxDriver

All Implemented Interfaces:

HasCapabilities, HasInputDevices, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, Killable, JavascriptExecutor, SearchContext, TakesScreenshot, WebDriver

public class FirefoxDriver
extends RemoteWebDriver
implements Killable

An implementation of the {#link WebDriver} interface that drives Firefox. This works through a firefox extension, which gets installed automatically if necessary.

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

RemoteWebDriver.RemoteTargetLocator, RemoteWebDriver.RemoteWebDriverOptions, RemoteWebDriver.When

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

WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, 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 boolean	DEFAULT_ENABLE_NATIVE_EVENTS
static java.lang.String	MARIONETTE
static java.lang.String	PROFILE

Constructor Summary

Constructors

Constructor and Description
FirefoxDriver()
FirefoxDriver(Capabilities desiredCapabilities)
FirefoxDriver(Capabilities desiredCapabilities, Capabilities requiredCapabilities)
FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile)
FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile, Capabilities capabilities)
FirefoxDriver(FirefoxBinary binary, FirefoxProfile profile, Capabilities desiredCapabilities, Capabilities requiredCapabilities)
FirefoxDriver(FirefoxProfile profile)
FirefoxDriver(GeckoDriverService driverService, Capabilities desiredCapabilities, Capabilities requiredCapabilities)

Method Summary

Modifier and Type	Method and Description
protected ExtensionConnection	connectTo(FirefoxBinary binary, FirefoxProfile profile, java.lang.String host)
<X> X	getScreenshotAs(OutputType<X> target) Capture the screenshot and store it in the specified location.
void	kill() Attempt to forcibly kill this Killable at the OS level.
WebDriver.Options	manage() Gets the Option interface
protected Lock	obtainLock(FirefoxProfile profile)
void	setFileDetector(FileDetector detector) Set the file detector to be used when sending keyboard input.
protected void	startClient(Capabilities desiredCapabilities, Capabilities requiredCapabilities) Method called before starting a new session.
protected void	stopClient(Capabilities desiredCapabilities, Capabilities requiredCapabilities) Method called after executing a RemoteWebDriver.quit() command.

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, quit, 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

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

DEFAULT_ENABLE_NATIVE_EVENTS

public static final boolean DEFAULT_ENABLE_NATIVE_EVENTS

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(FirefoxProfile profile)

FirefoxDriver

public FirefoxDriver(Capabilities desiredCapabilities)

FirefoxDriver

public FirefoxDriver(Capabilities desiredCapabilities,
                     Capabilities requiredCapabilities)

FirefoxDriver

public FirefoxDriver(FirefoxBinary binary,
                     FirefoxProfile profile)

FirefoxDriver

public FirefoxDriver(FirefoxBinary binary,
                     FirefoxProfile profile,
                     Capabilities capabilities)

FirefoxDriver

public FirefoxDriver(FirefoxBinary binary,
                     FirefoxProfile profile,
                     Capabilities desiredCapabilities,
                     Capabilities requiredCapabilities)

FirefoxDriver

public FirefoxDriver(GeckoDriverService driverService,
                     Capabilities desiredCapabilities,
                     Capabilities requiredCapabilities)

Method Detail

setFileDetector

public void setFileDetector(FileDetector detector)

Description copied from class: RemoteWebDriver

Set the file detector to be used when sending keyboard input. By default, this is set to a file detector that does nothing.

Overrides:

setFileDetector in class RemoteWebDriver

Parameters:

detector - The detector to use. Must not be null.

See Also:

FileDetector, LocalFileDetector, UselessFileDetector

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 Killable

manage

public WebDriver.Options manage()

Description copied from interface: WebDriver

Gets the Option interface

Specified by:

manage in interface WebDriver

Overrides:

manage in class RemoteWebDriver

Returns:

An option interface

See Also:

WebDriver.Options

startClient

protected void startClient(Capabilities desiredCapabilities,
                           Capabilities requiredCapabilities)

Description copied from class: RemoteWebDriver

Method called before starting a new session. The default implementation is a no-op, but subtypes should override this method to define custom behavior.

Overrides:

startClient in class RemoteWebDriver

connectTo

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

obtainLock

protected Lock obtainLock(FirefoxProfile profile)

stopClient

protected void stopClient(Capabilities desiredCapabilities,
                          Capabilities requiredCapabilities)

Description copied from class: RemoteWebDriver

Method called after executing a RemoteWebDriver.quit() command. The default implementation is a no-op, but subtypes should override this method to define custom behavior.

Overrides:

stopClient in class RemoteWebDriver

getScreenshotAs

public <X> X getScreenshotAs(OutputType<X> target)

Description copied from interface: TakesScreenshot

Capture the screenshot and store it in the specified location.

For WebDriver extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference:

• Entire page
• Current window
• Visible portion of the current frame
• The screenshot of the entire display containing the browser

For WebElement extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference: - The entire content of the HTML element - The visible portion of the HTML element

Specified by:

getScreenshotAs in interface TakesScreenshot

Overrides:

getScreenshotAs in class RemoteWebDriver

Type Parameters:

X - Return type for getScreenshotAs.

Parameters:

target - target type, @see OutputType

Returns:

Object in which is stored information about the screenshot.