org.openqa.selenium.htmlunit

Class HtmlUnitDriver

java.lang.Object

org.openqa.selenium.htmlunit.HtmlUnitDriver

All Implemented Interfaces:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.Interactive, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.WebDriver

public class HtmlUnitDriver
extends Object
implements org.openqa.selenium.WebDriver, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.Interactive

An implementation of WebDriver that drives HtmlUnit, which is a headless (GUI-less) browser simulator.

The main supported browsers are Chrome, Edge, Firefox and Internet Explorer.

Author:

Alexei Barantsev, Ahmed Ashour, Rafael Jimenez, Luke Inman-Semerau, Kay McCormick, Simon Stewart, Javier Neira, Ronald Brill, Rob Winch, Andrei Solntsev, Martin Bartoš

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HtmlUnitDriver.ElementsMap
protected static interface	HtmlUnitDriver.JavaScriptResultsCollection

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

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 String	BROWSER_LANGUAGE_CAPABILITY BROWSER_LANGUAGE_CAPABILITY = "browserLanguage".
static String	DOWNLOAD_IMAGES_CAPABILITY DOWNLOAD_IMAGES_CAPABILITY = "downloadImages".
static String	JAVASCRIPT_ENABLED JAVASCRIPT_ENABLED = "javascriptEnabled".

Constructor Summary

Constructors

Constructor and Description
HtmlUnitDriver() Constructs a new instance with JavaScript disabled, and the default BrowserVersion.
HtmlUnitDriver(boolean enableJavascript) Constructs a new instance, specify JavaScript support and using the default BrowserVersion.
HtmlUnitDriver(com.gargoylesoftware.htmlunit.BrowserVersion version) Constructs a new instance with the specified BrowserVersion.
HtmlUnitDriver(com.gargoylesoftware.htmlunit.BrowserVersion version, boolean enableJavascript) Constructs a new instance with the specified BrowserVersion and the JavaScript support.
HtmlUnitDriver(org.openqa.selenium.Capabilities capabilities) The browserName is Browser.HTMLUNIT "htmlunit" and the browserVersion denotes the required browser AND its version.
HtmlUnitDriver(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)

Method Summary

Modifier and Type	Method and Description
protected void	assertElementNotStale(com.gargoylesoftware.htmlunit.html.DomElement element)
void	click(com.gargoylesoftware.htmlunit.html.DomElement element, boolean directClick)
void	close()
void	doubleClick(com.gargoylesoftware.htmlunit.html.DomElement element)
Object	executeAsyncScript(String script, Object... args)
Object	executeScript(String script, Object... args)
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
org.openqa.selenium.WebElement	findElement(HtmlUnitWebElement element, org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElements(HtmlUnitWebElement element, org.openqa.selenium.By by)
void	get(String url)
protected void	get(URL fullUrl) Allows HtmlUnit's about:blank to be loaded in the constructor, and may be useful for other tests?
HtmlUnitAlert	getAlert()
com.gargoylesoftware.htmlunit.BrowserVersion	getBrowserVersion() Get the simulated BrowserVersion.
org.openqa.selenium.Capabilities	getCapabilities()
String	getCurrentUrl()
HtmlUnitWindow	getCurrentWindow()
HtmlUnitDriver.ElementsMap	getElementsMap()
HtmlUnitKeyboard	getKeyboard()
HtmlUnitMouse	getMouse()
String	getPageSource()
String	getTitle()
com.gargoylesoftware.htmlunit.WebClient	getWebClient()
String	getWindowHandle()
Set<String>	getWindowHandles()
protected <X> X	implicitlyWaitFor(Callable<X> condition)
boolean	isAcceptInsecureCerts()
boolean	isDownloadImages()
boolean	isJavascriptEnabled()
org.openqa.selenium.WebDriver.Options	manage()
protected com.gargoylesoftware.htmlunit.WebClient	modifyWebClient(com.gargoylesoftware.htmlunit.WebClient client) Child classes can override this method to customize the WebClient that the HtmlUnit driver uses.
void	mouseDown(com.gargoylesoftware.htmlunit.html.DomElement element)
void	mouseMove(com.gargoylesoftware.htmlunit.html.DomElement element)
void	mouseUp(com.gargoylesoftware.htmlunit.html.DomElement element)
org.openqa.selenium.WebDriver.Navigation	navigate()
protected com.gargoylesoftware.htmlunit.WebClient	newWebClient(com.gargoylesoftware.htmlunit.BrowserVersion version) Create the underlying WebClient, but don't set any fields on it.
void	openNewWindow()
void	perform(Collection<org.openqa.selenium.interactions.Sequence> sequences)
void	quit()
void	resetInputState()
protected void	runAsync(Runnable r)
void	sendKeys(HtmlUnitWebElement element, CharSequence... value)
void	setAcceptInsecureCerts(boolean accept)
void	setAutoProxy(String autoProxyUrl) Sets Proxy Autoconfiguration URL for WebClient.
void	setCurrentWindow(com.gargoylesoftware.htmlunit.WebWindow window)
void	setDownloadImages(boolean downloadImages)
void	setExecutor(Executor executor) Sets the Executor to be used for submitting async tasks to.
void	setHTTPProxy(String host, int port, List<String> noProxyHosts) Sets HTTP proxy for WebClient with bypass proxy hosts.
void	setJavascriptEnabled(boolean enableJavascript)
void	setProxy(String host, int port) Sets HTTP proxy for WebClient.
void	setProxySettings(org.openqa.selenium.Proxy proxy) Set proxy for WebClient using Proxy.
void	setSocksProxy(String host, int port) Sets SOCKS proxy for WebClient.
void	setSocksProxy(String host, int port, List<String> noProxyHosts) Sets SOCKS proxy for WebClient with bypass proxy hosts.
void	submit(HtmlUnitWebElement element)
org.openqa.selenium.WebDriver.TargetLocator	switchTo()
protected void	switchToDefaultContentOfWindow(com.gargoylesoftware.htmlunit.WebWindow window)
protected HtmlUnitWebElement	toWebElement(com.gargoylesoftware.htmlunit.html.DomElement element)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.selenium.JavascriptExecutor

executeScript, getPinnedScripts, pin, unpin

Field Detail

BROWSER_LANGUAGE_CAPABILITY

public static final String BROWSER_LANGUAGE_CAPABILITY

BROWSER_LANGUAGE_CAPABILITY = "browserLanguage".

See Also:

Constant Field Values

DOWNLOAD_IMAGES_CAPABILITY

public static final String DOWNLOAD_IMAGES_CAPABILITY

DOWNLOAD_IMAGES_CAPABILITY = "downloadImages".

See Also:

Constant Field Values

JAVASCRIPT_ENABLED

public static final String JAVASCRIPT_ENABLED

JAVASCRIPT_ENABLED = "javascriptEnabled".

See Also:

Constant Field Values

Constructor Detail

HtmlUnitDriver

public HtmlUnitDriver()

Constructs a new instance with JavaScript disabled, and the default BrowserVersion.

HtmlUnitDriver

public HtmlUnitDriver(com.gargoylesoftware.htmlunit.BrowserVersion version)

Constructs a new instance with the specified BrowserVersion.

Parameters:

version - the browser version to use

HtmlUnitDriver

public HtmlUnitDriver(boolean enableJavascript)

Constructs a new instance, specify JavaScript support and using the default BrowserVersion.

Parameters:

enableJavascript - whether to enable JavaScript support or not

HtmlUnitDriver

public HtmlUnitDriver(com.gargoylesoftware.htmlunit.BrowserVersion version,
                      boolean enableJavascript)

Constructs a new instance with the specified BrowserVersion and the JavaScript support.

Parameters:

version - the browser version to use

enableJavascript - whether to enable JavaScript support or not

HtmlUnitDriver

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

The browserName is Browser.HTMLUNIT "htmlunit" and the browserVersion denotes the required browser AND its version. For example "chrome" for Chrome, "firefox-100" for Firefox 100 or "internet explorer" for IE.

Parameters:

capabilities - desired capabilities requested for the htmlunit driver session

HtmlUnitDriver

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

Method Detail

runAsync

protected void runAsync(Runnable r)

click

public void click(com.gargoylesoftware.htmlunit.html.DomElement element,
                  boolean directClick)

doubleClick

public void doubleClick(com.gargoylesoftware.htmlunit.html.DomElement element)

mouseUp

public void mouseUp(com.gargoylesoftware.htmlunit.html.DomElement element)

mouseMove

public void mouseMove(com.gargoylesoftware.htmlunit.html.DomElement element)

mouseDown

public void mouseDown(com.gargoylesoftware.htmlunit.html.DomElement element)

submit

public void submit(HtmlUnitWebElement element)

sendKeys

public void sendKeys(HtmlUnitWebElement element,
                     CharSequence... value)

getBrowserVersion

public com.gargoylesoftware.htmlunit.BrowserVersion getBrowserVersion()

Get the simulated BrowserVersion.

Returns:

the used BrowserVersion

newWebClient

protected com.gargoylesoftware.htmlunit.WebClient newWebClient(com.gargoylesoftware.htmlunit.BrowserVersion version)

Create the underlying WebClient, but don't set any fields on it.

Parameters:

version - Which browser to emulate

Returns:

a new instance of WebClient.

modifyWebClient

protected com.gargoylesoftware.htmlunit.WebClient modifyWebClient(com.gargoylesoftware.htmlunit.WebClient client)

Child classes can override this method to customize the WebClient that the HtmlUnit driver uses.

Parameters:

client - The client to modify

Returns:

The modified client

getAlert

public HtmlUnitAlert getAlert()

getElementsMap

public HtmlUnitDriver.ElementsMap getElementsMap()

setCurrentWindow

public void setCurrentWindow(com.gargoylesoftware.htmlunit.WebWindow window)

setProxySettings

public void setProxySettings(org.openqa.selenium.Proxy proxy)

Set proxy for WebClient using Proxy.

Parameters:

proxy - The proxy preferences.

setProxy

public void setProxy(String host,
                     int port)

Sets HTTP proxy for WebClient.

Parameters:

host - The hostname of HTTP proxy

port - The port of HTTP proxy, 0 means HTTP proxy w/o port

setHTTPProxy

public void setHTTPProxy(String host,
                         int port,
                         List<String> noProxyHosts)

Sets HTTP proxy for WebClient with bypass proxy hosts.

Parameters:

host - The hostname of HTTP proxy

port - The port of HTTP proxy, 0 means HTTP proxy w/o port

noProxyHosts - The list of hosts which need to bypass HTTP proxy

setSocksProxy

public void setSocksProxy(String host,
                          int port)

Sets SOCKS proxy for WebClient.

Parameters:

host - The hostname of SOCKS proxy

port - The port of SOCKS proxy, 0 means HTTP proxy w/o port

setSocksProxy

public void setSocksProxy(String host,
                          int port,
                          List<String> noProxyHosts)

Sets SOCKS proxy for WebClient with bypass proxy hosts.

Parameters:

host - The hostname of SOCKS proxy

port - The port of SOCKS proxy, 0 means HTTP proxy w/o port

noProxyHosts - The list of hosts which need to bypass SOCKS proxy

setExecutor

public void setExecutor(Executor executor)

Sets the Executor to be used for submitting async tasks to. You have to close this manually on quit()

Parameters:

executor - the Executor to use

setAutoProxy

public void setAutoProxy(String autoProxyUrl)

Sets Proxy Autoconfiguration URL for WebClient.

Parameters:

autoProxyUrl - The Proxy Autoconfiguration URL

getCapabilities

public org.openqa.selenium.Capabilities getCapabilities()

Specified by:

getCapabilities in interface org.openqa.selenium.HasCapabilities

get

public void get(String url)

Specified by:

get in interface org.openqa.selenium.WebDriver

get

protected void get(URL fullUrl)

Allows HtmlUnit's about:blank to be loaded in the constructor, and may be useful for other tests?

Parameters:

fullUrl - The URL to visit

getCurrentUrl

public String getCurrentUrl()

Specified by:

getCurrentUrl in interface org.openqa.selenium.WebDriver

getTitle

public String getTitle()

Specified by:

getTitle in interface org.openqa.selenium.WebDriver

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

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

findElement

public org.openqa.selenium.WebElement findElement(HtmlUnitWebElement element,
                                                  org.openqa.selenium.By by)

findElements

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

getPageSource

public String getPageSource()

Specified by:

getPageSource in interface org.openqa.selenium.WebDriver

close

public void close()

Specified by:

close in interface org.openqa.selenium.WebDriver

quit

public void quit()

Specified by:

quit in interface org.openqa.selenium.WebDriver

getWindowHandles

public Set<String> getWindowHandles()

Specified by:

getWindowHandles in interface org.openqa.selenium.WebDriver

getWindowHandle

public String getWindowHandle()

Specified by:

getWindowHandle in interface org.openqa.selenium.WebDriver

executeScript

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

Specified by:

executeScript in interface org.openqa.selenium.JavascriptExecutor

executeAsyncScript

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

Specified by:

executeAsyncScript in interface org.openqa.selenium.JavascriptExecutor

assertElementNotStale

protected void assertElementNotStale(com.gargoylesoftware.htmlunit.html.DomElement element)

getKeyboard

public HtmlUnitKeyboard getKeyboard()

getMouse

public HtmlUnitMouse getMouse()

switchTo

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

Specified by:

switchTo in interface org.openqa.selenium.WebDriver

navigate

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

Specified by:

navigate in interface org.openqa.selenium.WebDriver

toWebElement

protected HtmlUnitWebElement toWebElement(com.gargoylesoftware.htmlunit.html.DomElement element)

isJavascriptEnabled

public boolean isJavascriptEnabled()

setJavascriptEnabled

public void setJavascriptEnabled(boolean enableJavascript)

isDownloadImages

public boolean isDownloadImages()

setDownloadImages

public void setDownloadImages(boolean downloadImages)

setAcceptInsecureCerts

public void setAcceptInsecureCerts(boolean accept)

isAcceptInsecureCerts

public boolean isAcceptInsecureCerts()

implicitlyWaitFor

protected <X> X implicitlyWaitFor(Callable<X> condition)

getWebClient

public com.gargoylesoftware.htmlunit.WebClient getWebClient()

getCurrentWindow

public HtmlUnitWindow getCurrentWindow()

manage

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

Specified by:

manage in interface org.openqa.selenium.WebDriver

perform

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

Specified by:

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

resetInputState

public void resetInputState()

Specified by:

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

switchToDefaultContentOfWindow

protected void switchToDefaultContentOfWindow(com.gargoylesoftware.htmlunit.WebWindow window)

openNewWindow

public void openNewWindow()