com.crawljax.browser

Class WebDriverBackedEmbeddedBrowser

java.lang.Object

com.crawljax.browser.WebDriverBackedEmbeddedBrowser

All Implemented Interfaces:

EmbeddedBrowser

public final class WebDriverBackedEmbeddedBrowser
extends Object
implements EmbeddedBrowser

Nested Class Summary

Nested classes/interfaces inherited from interface com.crawljax.browser.EmbeddedBrowser

EmbeddedBrowser.BrowserType

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the browser.
void	closeOtherWindows() Closes all other windows.
boolean	elementExists(Identification identification)
Object	executeJavaScript(String code) Execute JavaScript in the browser.
boolean	fireEventAndWait(Eventable eventable) Fires an event on an element using its identification.
org.openqa.selenium.WebDriver	getBrowser()
protected long	getCrawlWaitEvent()
protected long	getCrawlWaitReload()
String	getCurrentUrl()
String	getDom() Deprecated.
protected com.google.common.collect.ImmutableSortedSet<String>	getFilterAttributes()
String	getFrameDom(String iframeIdentification)
FormInput	getInputWithRandomValue(FormInput input)
byte[]	getScreenShot()
String	getStrippedDom() Removes the stripped items from PreCrawlConfiguration#getFilterAttributeNames().
String	getStrippedDomWithoutIframeContent()
String	getUnStrippedDom() Removes the stripped items from PreCrawlConfiguration#getFilterAttributeNames().
org.openqa.selenium.WebElement	getWebElement(Identification identification)
void	goBack() Go back to the previous state.
void	goToUrl(URL url) Opens the url in the browser.
boolean	input(Identification identification, String text)
boolean	isVisible(Identification identification) Determines whether the corresponding element is visible.
void	saveScreenShot(File file)
static WebDriverBackedEmbeddedBrowser	withDriver(org.openqa.selenium.WebDriver driver) Create a WebDriver backed EmbeddedBrowser.
static WebDriverBackedEmbeddedBrowser	withDriver(org.openqa.selenium.WebDriver driver, com.google.common.collect.ImmutableSortedSet<String> filterAttributes, long crawlWaitEvent, long crawlWaitReload) Create a WebDriver backed EmbeddedBrowser.
static WebDriverBackedEmbeddedBrowser	withDriver(org.openqa.selenium.WebDriver driver, com.google.common.collect.ImmutableSortedSet<String> filterAttributes, long crawlWaitEvent, long crawlWaitReload, IgnoreFrameChecker ignoreFrameChecker) Create a WebDriver backed EmbeddedBrowser.
static WebDriverBackedEmbeddedBrowser	withRemoteDriver(String hubUrl) Create a RemoteWebDriver backed EmbeddedBrowser.
static WebDriverBackedEmbeddedBrowser	withRemoteDriver(String hubUrl, com.google.common.collect.ImmutableSortedSet<String> filterAttributes, long crawlWaitEvent, long crawlWaitReload) Create a RemoteWebDriver backed EmbeddedBrowser.
static WebDriverBackedEmbeddedBrowser	withRemoteDriver(String hubUrl, com.google.common.collect.ImmutableSortedSet<String> filterAttributes, long crawlWaitEvent, long crawlWaitReload, IgnoreFrameChecker ignoreFrameChecker) Create a RemoteWebDriver backed EmbeddedBrowser.

Methods inherited from class java.lang.Object

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

Method Detail

withRemoteDriver

public static WebDriverBackedEmbeddedBrowser withRemoteDriver(String hubUrl,
                                              com.google.common.collect.ImmutableSortedSet<String> filterAttributes,
                                              long crawlWaitEvent,
                                              long crawlWaitReload)

Create a RemoteWebDriver backed EmbeddedBrowser.

Parameters:

hubUrl - Url of the server.

filterAttributes - the attributes to be filtered from DOM.

crawlWaitReload - the period to wait after a reload.

crawlWaitEvent - the period to wait after an event is fired.

Returns:

The EmbeddedBrowser.

withRemoteDriver

public static WebDriverBackedEmbeddedBrowser withRemoteDriver(String hubUrl,
                                              com.google.common.collect.ImmutableSortedSet<String> filterAttributes,
                                              long crawlWaitEvent,
                                              long crawlWaitReload,
                                              IgnoreFrameChecker ignoreFrameChecker)

Create a RemoteWebDriver backed EmbeddedBrowser.

Parameters:

hubUrl - Url of the server.

filterAttributes - the attributes to be filtered from DOM.

crawlWaitReload - the period to wait after a reload.

crawlWaitEvent - the period to wait after an event is fired.

ignoreFrameChecker - the checker used to determine if a certain frame must be ignored.

Returns:

The EmbeddedBrowser.

withDriver

public static WebDriverBackedEmbeddedBrowser withDriver(org.openqa.selenium.WebDriver driver,
                                        com.google.common.collect.ImmutableSortedSet<String> filterAttributes,
                                        long crawlWaitEvent,
                                        long crawlWaitReload)

Create a WebDriver backed EmbeddedBrowser.

Parameters:

driver - The WebDriver to use.

filterAttributes - the attributes to be filtered from DOM.

crawlWaitReload - the period to wait after a reload.

crawlWaitEvent - the period to wait after an event is fired.

Returns:

The EmbeddedBrowser.

withDriver

public static WebDriverBackedEmbeddedBrowser withDriver(org.openqa.selenium.WebDriver driver,
                                        com.google.common.collect.ImmutableSortedSet<String> filterAttributes,
                                        long crawlWaitEvent,
                                        long crawlWaitReload,
                                        IgnoreFrameChecker ignoreFrameChecker)

Create a WebDriver backed EmbeddedBrowser.

Parameters:

driver - The WebDriver to use.

filterAttributes - the attributes to be filtered from DOM.

crawlWaitReload - the period to wait after a reload.

crawlWaitEvent - the period to wait after an event is fired.

ignoreFrameChecker - the checker used to determine if a certain frame must be ignored.

Returns:

The EmbeddedBrowser.

withRemoteDriver

public static WebDriverBackedEmbeddedBrowser withRemoteDriver(String hubUrl)

Create a RemoteWebDriver backed EmbeddedBrowser.

Parameters:

hubUrl - Url of the server.

Returns:

The EmbeddedBrowser.

withDriver

public static WebDriverBackedEmbeddedBrowser withDriver(org.openqa.selenium.WebDriver driver)

Create a WebDriver backed EmbeddedBrowser.

Parameters:

driver - The WebDriver to use.

Returns:

The EmbeddedBrowser.

goToUrl

public void goToUrl(URL url)

Description copied from interface: EmbeddedBrowser

Opens the url in the browser.

Specified by:

goToUrl in interface EmbeddedBrowser

Parameters:

url - The URL.

close

public void close()

Description copied from interface: EmbeddedBrowser

Closes the browser.

Specified by:

close in interface EmbeddedBrowser

getDom

@Deprecated
public String getDom()

Deprecated.

Specified by:

getDom in interface EmbeddedBrowser

Returns:

implemented by EmbeddedBrowser.getStrippedDom().

getStrippedDom

public String getStrippedDom()

Description copied from interface: EmbeddedBrowser

Removes the stripped items from PreCrawlConfiguration#getFilterAttributeNames().

Specified by:

getStrippedDom in interface EmbeddedBrowser

Returns:

the DOM string with all the iframe content.

getUnStrippedDom

public String getUnStrippedDom()

Description copied from interface: EmbeddedBrowser

Removes the stripped items from PreCrawlConfiguration#getFilterAttributeNames().

Specified by:

getUnStrippedDom in interface EmbeddedBrowser

Returns:

The dom without any elements stripped.

See Also:

WebDriver#getPageSource()

goBack

public void goBack()

Description copied from interface: EmbeddedBrowser

Go back to the previous state.

Specified by:

goBack in interface EmbeddedBrowser

input

public boolean input(Identification identification,
            String text)

Specified by:

input in interface EmbeddedBrowser

Parameters:

identification - The identification object.

text - The input.

Returns:

true if succeeds.

fireEventAndWait

public boolean fireEventAndWait(Eventable eventable)
                         throws org.openqa.selenium.ElementNotVisibleException,
                                org.openqa.selenium.NoSuchElementException,
                                InterruptedException

Fires an event on an element using its identification.

Specified by:

fireEventAndWait in interface EmbeddedBrowser

Parameters:

eventable - The eventable.

Returns:

true if it is able to fire the event successfully on the element.

Throws:

InterruptedException - when interrupted during the wait.

org.openqa.selenium.ElementNotVisibleException

org.openqa.selenium.NoSuchElementException

executeJavaScript

public Object executeJavaScript(String code)
                         throws CrawljaxException

Execute JavaScript in the browser.

Specified by:

executeJavaScript in interface EmbeddedBrowser

Parameters:

code - The code to execute.

Returns:

The return value of the JavaScript.

Throws:

CrawljaxException - when javascript execution failed.

isVisible

public boolean isVisible(Identification identification)

Determines whether the corresponding element is visible.

Specified by:

isVisible in interface EmbeddedBrowser

Parameters:

identification - The element to search for.

Returns:

true if the element is visible

getCurrentUrl

public String getCurrentUrl()

Specified by:

getCurrentUrl in interface EmbeddedBrowser

Returns:

The current browser url.

closeOtherWindows

public void closeOtherWindows()

Description copied from interface: EmbeddedBrowser

Closes all other windows.

Specified by:

closeOtherWindows in interface EmbeddedBrowser

getStrippedDomWithoutIframeContent

public String getStrippedDomWithoutIframeContent()

Specified by:

getStrippedDomWithoutIframeContent in interface EmbeddedBrowser

Returns:

the dom without the iframe contents.

See Also:

EmbeddedBrowser.getStrippedDomWithoutIframeContent()

getInputWithRandomValue

public FormInput getInputWithRandomValue(FormInput input)

Specified by:

getInputWithRandomValue in interface EmbeddedBrowser

Parameters:

input - the input to be filled.

Returns:

FormInput with random value assigned if possible. If no values were set it returns null

getFrameDom

public String getFrameDom(String iframeIdentification)

Specified by:

getFrameDom in interface EmbeddedBrowser

Parameters:

iframeIdentification - the iframe's name or id.

Returns:

the DOM string of the corresponding iframe.

elementExists

public boolean elementExists(Identification identification)

Specified by:

elementExists in interface EmbeddedBrowser

Parameters:

identification - the identification of the element.

Returns:

true if the element can be found in the DOM tree.

getWebElement

public org.openqa.selenium.WebElement getWebElement(Identification identification)

Specified by:

getWebElement in interface EmbeddedBrowser

Parameters:

identification - the identification of the element.

Returns:

the found element.

getCrawlWaitEvent

protected long getCrawlWaitEvent()

Returns:

the period to wait after an event.

getFilterAttributes

protected com.google.common.collect.ImmutableSortedSet<String> getFilterAttributes()

Returns:

the list of attributes to be filtered from DOM.

getCrawlWaitReload

protected long getCrawlWaitReload()

Returns:

the period to waint after a reload.

saveScreenShot

public void saveScreenShot(File file)
                    throws CrawljaxException

Specified by:

saveScreenShot in interface EmbeddedBrowser

Parameters:

file - the file to write the screenshot to (png).

Throws:

CrawljaxException - if saving screenshots is not supported by the implementing class.

getScreenShot

public byte[] getScreenShot()
                     throws CrawljaxException

Specified by:

getScreenShot in interface EmbeddedBrowser

Returns:

The screenshot in PNG format.

Throws:

CrawljaxException - if saving screenshots is not supported by the implementing class.

getBrowser

public org.openqa.selenium.WebDriver getBrowser()

Returns:

the WebDriver used as an EmbeddedBrowser.