com.machinepublishers.jbrowserdriver

Class JBrowserDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

com.machinepublishers.jbrowserdriver.JBrowserDriver

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.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class JBrowserDriver
extends org.openqa.selenium.remote.RemoteWebDriver

A Selenium-compatible and WebKit-based web driver written in pure Java.

See https://github.com/machinepublishers/jbrowserdriver#usage for basic usage info.

Licensed under the Apache License version 2.0.

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
JBrowserDriver() Constructs a browser with default settings, UTC timezone, and no proxy.
JBrowserDriver(org.openqa.selenium.Capabilities capabilities) Use Settings.builder() ...buildCapabilities() to create settings to pass to this constructor.
JBrowserDriver(Settings settings) Use Settings.builder() ...build() to create settings to pass to this constructor.

Method Summary

Modifier and Type	Method and Description
File	attachmentsDir()
File	cacheDir()
void	close()
Object	executeAsyncScript(String script, Object... args)
Object	executeScript(String script, Object... args)
protected void	finalize()
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
org.openqa.selenium.WebElement	findElementByClassName(String cssClass)
org.openqa.selenium.WebElement	findElementByCssSelector(String expr)
org.openqa.selenium.WebElement	findElementById(String id)
org.openqa.selenium.WebElement	findElementByLinkText(String text)
org.openqa.selenium.WebElement	findElementByName(String name)
org.openqa.selenium.WebElement	findElementByPartialLinkText(String text)
org.openqa.selenium.WebElement	findElementByTagName(String tagName)
org.openqa.selenium.WebElement	findElementByXPath(String expr)
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElementsByClassName(String cssClass)
List<org.openqa.selenium.WebElement>	findElementsByCssSelector(String expr)
List<org.openqa.selenium.WebElement>	findElementsById(String id)
List<org.openqa.selenium.WebElement>	findElementsByLinkText(String text)
List<org.openqa.selenium.WebElement>	findElementsByName(String name)
List<org.openqa.selenium.WebElement>	findElementsByPartialLinkText(String text)
List<org.openqa.selenium.WebElement>	findElementsByTagName(String tagName)
List<org.openqa.selenium.WebElement>	findElementsByXPath(String expr)
void	get(String url)
org.openqa.selenium.Capabilities	getCapabilities()
org.openqa.selenium.remote.CommandExecutor	getCommandExecutor()
String	getCurrentUrl()
org.openqa.selenium.remote.ErrorHandler	getErrorHandler()
org.openqa.selenium.remote.FileDetector	getFileDetector()
org.openqa.selenium.interactions.Keyboard	getKeyboard()
org.openqa.selenium.interactions.Mouse	getMouse()
String	getPageSource()
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
org.openqa.selenium.remote.SessionId	getSessionId()
int	getStatusCode()
String	getTitle()
String	getWindowHandle()
Set<String>	getWindowHandles()
void	init() Optionally call this method if you want JavaFX initialized and the browser window opened immediately.
static void	initWorkThread()
void	kill()
org.openqa.selenium.WebDriver.Options	manage()
File	mediaDir()
org.openqa.selenium.WebDriver.Navigation	navigate()
void	pageWait() Waits until requests are completed and idle for a certain amount of time.
void	perform(Collection<org.openqa.selenium.interactions.Sequence> actions)
void	quit()
void	reset() Reset the state of the browser.
void	reset(org.openqa.selenium.Capabilities capabilities) Reset the state of the browser.
void	reset(Settings settings) Reset the state of the browser.
org.openqa.selenium.WebDriver.TargetLocator	switchTo()
static List<String>	test() Run diagnostic tests.

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

builder, execute, execute, findElement, findElements, getElementConverter, getExecuteMethod, log, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, startSession, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JBrowserDriver

public JBrowserDriver()

Constructs a browser with default settings, UTC timezone, and no proxy.

JBrowserDriver

public JBrowserDriver(org.openqa.selenium.Capabilities capabilities)

Use Settings.builder() ...buildCapabilities() to create settings to pass to this constructor. This constructor is mostly useful for Selenium Server itself to use.

Parameters:

capabilities -

JBrowserDriver

public JBrowserDriver(Settings settings)

Use Settings.builder() ...build() to create settings to pass to this constructor.

Parameters:

settings -

Method Detail

attachmentsDir

public File attachmentsDir()

Returns:

Temporary directory where downloaded files are saved.

cacheDir

public File cacheDir()

Returns:

Temporary directory where cached pages are saved.

close

public void close()

Specified by:

close in interface org.openqa.selenium.WebDriver

Overrides:

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

executeAsyncScript

public Object executeAsyncScript(String script,
                                 Object... args)

Specified by:

executeAsyncScript in interface org.openqa.selenium.JavascriptExecutor

Overrides:

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

executeScript

public Object executeScript(String script,
                            Object... args)

Specified by:

executeScript in interface org.openqa.selenium.JavascriptExecutor

Overrides:

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

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

findElement

public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebDriver

Overrides:

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

findElementByClassName

public org.openqa.selenium.WebElement findElementByClassName(String cssClass)

Specified by:

findElementByClassName in interface org.openqa.selenium.internal.FindsByClassName

Overrides:

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

findElementByCssSelector

public org.openqa.selenium.WebElement findElementByCssSelector(String expr)

Specified by:

findElementByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

Overrides:

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

findElementById

public org.openqa.selenium.WebElement findElementById(String id)

Specified by:

findElementById in interface org.openqa.selenium.internal.FindsById

Overrides:

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

findElementByLinkText

public org.openqa.selenium.WebElement findElementByLinkText(String text)

Specified by:

findElementByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

findElementByName

public org.openqa.selenium.WebElement findElementByName(String name)

Specified by:

findElementByName in interface org.openqa.selenium.internal.FindsByName

Overrides:

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

findElementByPartialLinkText

public org.openqa.selenium.WebElement findElementByPartialLinkText(String text)

Specified by:

findElementByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

findElementByTagName

public org.openqa.selenium.WebElement findElementByTagName(String tagName)

Specified by:

findElementByTagName in interface org.openqa.selenium.internal.FindsByTagName

Overrides:

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

findElementByXPath

public org.openqa.selenium.WebElement findElementByXPath(String expr)

Specified by:

findElementByXPath in interface org.openqa.selenium.internal.FindsByXPath

Overrides:

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

findElements

public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebDriver

Overrides:

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

findElementsByClassName

public List<org.openqa.selenium.WebElement> findElementsByClassName(String cssClass)

Specified by:

findElementsByClassName in interface org.openqa.selenium.internal.FindsByClassName

Overrides:

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

findElementsByCssSelector

public List<org.openqa.selenium.WebElement> findElementsByCssSelector(String expr)

Specified by:

findElementsByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

Overrides:

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

findElementsById

public List<org.openqa.selenium.WebElement> findElementsById(String id)

Specified by:

findElementsById in interface org.openqa.selenium.internal.FindsById

Overrides:

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

findElementsByLinkText

public List<org.openqa.selenium.WebElement> findElementsByLinkText(String text)

Specified by:

findElementsByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

findElementsByName

public List<org.openqa.selenium.WebElement> findElementsByName(String name)

Specified by:

findElementsByName in interface org.openqa.selenium.internal.FindsByName

Overrides:

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

findElementsByPartialLinkText

public List<org.openqa.selenium.WebElement> findElementsByPartialLinkText(String text)

Specified by:

findElementsByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

findElementsByTagName

public List<org.openqa.selenium.WebElement> findElementsByTagName(String tagName)

Specified by:

findElementsByTagName in interface org.openqa.selenium.internal.FindsByTagName

Overrides:

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

findElementsByXPath

public List<org.openqa.selenium.WebElement> findElementsByXPath(String expr)

Specified by:

findElementsByXPath in interface org.openqa.selenium.internal.FindsByXPath

Overrides:

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

get

public void get(String url)

Specified by:

get in interface org.openqa.selenium.WebDriver

Overrides:

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

getCapabilities

public org.openqa.selenium.Capabilities getCapabilities()

Specified by:

getCapabilities in interface org.openqa.selenium.HasCapabilities

Overrides:

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

getCommandExecutor

public org.openqa.selenium.remote.CommandExecutor getCommandExecutor()

Overrides:

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

getCurrentUrl

public String getCurrentUrl()

Specified by:

getCurrentUrl in interface org.openqa.selenium.WebDriver

Overrides:

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

getErrorHandler

public org.openqa.selenium.remote.ErrorHandler getErrorHandler()

Overrides:

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

getFileDetector

public org.openqa.selenium.remote.FileDetector getFileDetector()

Overrides:

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

getKeyboard

public org.openqa.selenium.interactions.Keyboard getKeyboard()

Specified by:

getKeyboard in interface org.openqa.selenium.interactions.HasInputDevices

Overrides:

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

getMouse

public org.openqa.selenium.interactions.Mouse getMouse()

Specified by:

getMouse in interface org.openqa.selenium.interactions.HasInputDevices

Overrides:

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

getPageSource

public String getPageSource()

Specified by:

getPageSource in interface org.openqa.selenium.WebDriver

Overrides:

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

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
                      throws org.openqa.selenium.WebDriverException

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException

getSessionId

public org.openqa.selenium.remote.SessionId getSessionId()

Overrides:

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

getStatusCode

public int getStatusCode()

Returns:

Status code of the response

getTitle

public String getTitle()

Specified by:

getTitle in interface org.openqa.selenium.WebDriver

Overrides:

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

getWindowHandle

public String getWindowHandle()

Specified by:

getWindowHandle in interface org.openqa.selenium.WebDriver

Overrides:

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

getWindowHandles

public Set<String> getWindowHandles()

Specified by:

getWindowHandles in interface org.openqa.selenium.WebDriver

Overrides:

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

init

public void init()

Optionally call this method if you want JavaFX initialized and the browser window opened immediately. Otherwise, initialization will happen lazily.

initWorkThread

public static void initWorkThread()

kill

public void kill()

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

mediaDir

public File mediaDir()

Returns:

Temporary directory where media files are saved.

navigate

public org.openqa.selenium.WebDriver.Navigation navigate()

Specified by:

navigate in interface org.openqa.selenium.WebDriver

Overrides:

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

pageWait

public void pageWait()

Waits until requests are completed and idle for a certain amount of time. This type of waiting happens automatically on form submissions, page loads, mouse clicks, and text/keyboard entry, so in those cases there's usually no need to call this method. However, calling this method may be useful when requests are triggered under other circumstances or if a more conservative wait is needed.

The behavior of this wait algorithm can be configured by Settings.Builder.ajaxWait(long) and Settings.Builder.ajaxResourceTimeout(long).

perform

public void perform(Collection<org.openqa.selenium.interactions.Sequence> actions)

Specified by:

perform in interface org.openqa.selenium.interactions.Interactive

Overrides:

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

quit

public void quit()

Specified by:

quit in interface org.openqa.selenium.WebDriver

Overrides:

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

reset

public void reset()

Reset the state of the browser. More efficient than quitting the browser and creating a new instance.

reset

public void reset(org.openqa.selenium.Capabilities capabilities)

Reset the state of the browser. More efficient than quitting the browser and creating a new instance.

Note: it's not possible to switch between headless and GUI mode. You must quit this browser and create a new instance.

Parameters:

capabilities - Capabilities to take effect, superseding the original ones

reset

public void reset(Settings settings)

Reset the state of the browser. More efficient than quitting the browser and creating a new instance.

Note: it's not possible to switch between headless and GUI mode. You must quit this browser and create a new instance.

Parameters:

settings - New settings to take effect, superseding the original ones

switchTo

public org.openqa.selenium.WebDriver.TargetLocator switchTo()

Specified by:

switchTo in interface org.openqa.selenium.WebDriver

Overrides:

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

test

public static List<String> test()

Run diagnostic tests.

Returns:

Errors or an empty list if no errors found.