org.openqa.selenium.htmlunit.server

Class HtmlUnitLocalDriver

java.lang.Object

org.openqa.selenium.htmlunit.server.HtmlUnitLocalDriver

All Implemented Interfaces:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices, 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.WebDriver

public class HtmlUnitLocalDriver
extends Object
implements org.openqa.selenium.WebDriver, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HtmlUnitLocalDriver.HtmlUnitWindow
protected static interface	HtmlUnitLocalDriver.JavaScriptResultsCollection

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 String	BROWSER_LANGUAGE_CAPABILITY
static String	DOWNLOAD_IMAGES_CAPABILITY
static String	INVALIDSELECTIONERROR
static String	INVALIDXPATHERROR
static String	JAVASCRIPT_ENABLED

Constructor Summary

Constructors

Constructor and Description
HtmlUnitLocalDriver() Constructs a new instance with JavaScript disabled, and the default BrowserVersion.
HtmlUnitLocalDriver(boolean enableJavascript) Constructs a new instance, specify JavaScript support and using the default BrowserVersion.
HtmlUnitLocalDriver(com.gargoylesoftware.htmlunit.BrowserVersion version) Constructs a new instance with the specified BrowserVersion.
HtmlUnitLocalDriver(com.gargoylesoftware.htmlunit.BrowserVersion version, boolean enableJavascript) Constructs a new instance with the specified BrowserVersion and the JavaScript support.
HtmlUnitLocalDriver(org.openqa.selenium.Capabilities capabilities) Note: There are two configuration modes for the HtmlUnitDriver using this constructor.
HtmlUnitLocalDriver(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)
protected void	buttondown()
protected void	buttonup()
protected void	click(HtmlUnitWebElement element)
protected void	click(int button)
void	close()
protected void	doubleclick()
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	findElementByClassName(String className)
org.openqa.selenium.WebElement	findElementByCssSelector(String using)
org.openqa.selenium.WebElement	findElementById(String id)
org.openqa.selenium.WebElement	findElementByLinkText(String selector)
org.openqa.selenium.WebElement	findElementByName(String name)
org.openqa.selenium.WebElement	findElementByPartialLinkText(String using)
org.openqa.selenium.WebElement	findElementByTagName(String name)
org.openqa.selenium.WebElement	findElementByXPath(String selector)
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElementsByClassName(String className)
List<org.openqa.selenium.WebElement>	findElementsByCssSelector(String using)
List<org.openqa.selenium.WebElement>	findElementsById(String id)
List<org.openqa.selenium.WebElement>	findElementsByLinkText(String selector)
List<org.openqa.selenium.WebElement>	findElementsByName(String name)
List<org.openqa.selenium.WebElement>	findElementsByPartialLinkText(String using)
List<org.openqa.selenium.WebElement>	findElementsByTagName(String name)
List<org.openqa.selenium.WebElement>	findElementsByXPath(String selector)
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?
com.gargoylesoftware.htmlunit.BrowserVersion	getBrowserVersion() Get the simulated BrowserVersion.
org.openqa.selenium.Capabilities	getCapabilities()
String	getCurrentUrl()
protected com.gargoylesoftware.htmlunit.WebWindow	getCurrentWindow()
protected HtmlUnitWebElement	getElementById(int id)
org.openqa.selenium.interactions.Keyboard	getKeyboard()
org.openqa.selenium.interactions.Mouse	getMouse()
String	getPageSource()
String	getTitle()
protected com.gargoylesoftware.htmlunit.WebClient	getWebClient()
String	getWindowHandle()
Set<String>	getWindowHandles()
protected <X> X	implicitlyWaitFor(Callable<X> condition)
boolean	isDownloadImages()
boolean	isJavascriptEnabled()
protected void	keys(String string)
protected com.gargoylesoftware.htmlunit.Page	lastPage()
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.
protected void	moveTo(int elementId)
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.
protected void	pickWindow()
void	quit()
void	setAutoProxy(String autoProxyUrl) Sets Proxy Autoconfiguration URL for WebClient
void	setDownloadImages(boolean downloadImages)
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
org.openqa.selenium.WebDriver.TargetLocator	switchTo()
protected org.openqa.selenium.WebElement	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

Field Detail

INVALIDXPATHERROR

public static final String INVALIDXPATHERROR

See Also:

Constant Field Values

INVALIDSELECTIONERROR

public static final String INVALIDSELECTIONERROR

See Also:

Constant Field Values

BROWSER_LANGUAGE_CAPABILITY

public static final String BROWSER_LANGUAGE_CAPABILITY

See Also:

Constant Field Values

DOWNLOAD_IMAGES_CAPABILITY

public static final String DOWNLOAD_IMAGES_CAPABILITY

See Also:

Constant Field Values

JAVASCRIPT_ENABLED

public static final String JAVASCRIPT_ENABLED

See Also:

Constant Field Values

Constructor Detail

HtmlUnitLocalDriver

public HtmlUnitLocalDriver()

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

HtmlUnitLocalDriver

public HtmlUnitLocalDriver(boolean enableJavascript)

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

Parameters:

enableJavascript - whether to enable JavaScript support or not

HtmlUnitLocalDriver

public HtmlUnitLocalDriver(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

HtmlUnitLocalDriver

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

Constructs a new instance with the specified BrowserVersion.

Parameters:

version - the browser version to use

HtmlUnitLocalDriver

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

Note: There are two configuration modes for the HtmlUnitDriver using this constructor.

1. The first is where the browserName is "chrome", "firefox" or "internet explorer" and browserVersion denotes the desired version.
2. The second one is where the browserName is "htmlunit" and the browserVersion denotes the required browser AND its version. In this mode the browserVersion could be "chrome" for Chrome, "firefox-45" for Firefox 45 or "internet explorer" for IE.

The Remote WebDriver uses the second mode - the first mode is deprecated and should not be used.

Parameters:

capabilities - desired capabilities requested for the htmlunit driver session

HtmlUnitLocalDriver

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

Method Detail

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

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

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

pickWindow

protected void pickWindow()

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

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 org.openqa.selenium.interactions.Keyboard getKeyboard()

Specified by:

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

getMouse

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

Specified by:

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

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

lastPage

protected com.gargoylesoftware.htmlunit.Page lastPage()

findElementByLinkText

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

Specified by:

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

toWebElement

protected org.openqa.selenium.WebElement toWebElement(com.gargoylesoftware.htmlunit.html.DomElement element)

getElementById

protected HtmlUnitWebElement getElementById(int id)

moveTo

protected void moveTo(int elementId)

click

protected void click(int button)

doubleclick

protected void doubleclick()

click

protected void click(HtmlUnitWebElement element)

buttondown

protected void buttondown()

buttonup

protected void buttonup()

keys

protected void keys(String string)

findElementsByLinkText

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

Specified by:

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

findElementById

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

Specified by:

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

findElementsById

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

Specified by:

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

findElementByClassName

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

Specified by:

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

findElementsByClassName

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

Specified by:

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

findElementByCssSelector

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

Specified by:

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

findElementsByCssSelector

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

Specified by:

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

findElementByName

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

Specified by:

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

findElementsByName

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

Specified by:

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

findElementByTagName

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

Specified by:

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

findElementsByTagName

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

Specified by:

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

findElementByXPath

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

Specified by:

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

findElementsByXPath

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

Specified by:

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

isJavascriptEnabled

public boolean isJavascriptEnabled()

setJavascriptEnabled

public void setJavascriptEnabled(boolean enableJavascript)

isDownloadImages

public boolean isDownloadImages()

setDownloadImages

public void setDownloadImages(boolean downloadImages)

implicitlyWaitFor

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

getWebClient

protected com.gargoylesoftware.htmlunit.WebClient getWebClient()

getCurrentWindow

protected com.gargoylesoftware.htmlunit.WebWindow getCurrentWindow()

manage

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

Specified by:

manage in interface org.openqa.selenium.WebDriver

findElementByPartialLinkText

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

Specified by:

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

findElementsByPartialLinkText

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

Specified by:

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