Package com.norconex.crawler.web.fetch.impl.webdriver

Class WebDriverScreenshotHandler

java.lang.Object

com.norconex.crawler.web.fetch.util.AbstractScreenshotHandler<org.openqa.selenium.WebDriver>

com.norconex.crawler.web.fetch.impl.webdriver.WebDriverScreenshotHandler

All Implemented Interfaces:

Configurable<ScreenshotHandlerConfig>

public class WebDriverScreenshotHandler
extends AbstractScreenshotHandler<org.openqa.selenium.WebDriver>

Takes screenshot of pages using a Selenium WebDriver. Either the entire page, or a specific DOM element. Screenshot images can be stored in a document metadata/field or in a local directory.

Since:

3.0.0

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Constructor Summary

Constructors

Constructor	Description
WebDriverScreenshotHandler()
WebDriverScreenshotHandler(CachedStreamFactory streamFactory)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected byte[]	captureScreenshotBytes(org.openqa.selenium.WebDriver driver)	Captures screenshot bytes for the given browser source.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class com.norconex.crawler.web.fetch.util.AbstractScreenshotHandler

getConfiguration, takeScreenshot

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WebDriverScreenshotHandler

public WebDriverScreenshotHandler()

WebDriverScreenshotHandler

public WebDriverScreenshotHandler(CachedStreamFactory streamFactory)

Method Details

captureScreenshotBytes

protected byte[] captureScreenshotBytes(org.openqa.selenium.WebDriver driver)
                                 throws Exception

Description copied from class: AbstractScreenshotHandler

Captures screenshot bytes for the given browser source. Implementations are responsible for applying CSS selector-based element targeting (when ScreenshotHandlerConfig.getCssSelector() is set) before returning the final image bytes.

Specified by:

captureScreenshotBytes in class AbstractScreenshotHandler<org.openqa.selenium.WebDriver>

Parameters:

driver - the browser driver or page object

Returns:

screenshot bytes (PNG or JPEG)

Throws:

Exception - if the screenshot cannot be captured

toString

public String toString()

Overrides:

toString in class AbstractScreenshotHandler<org.openqa.selenium.WebDriver>

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractScreenshotHandler<org.openqa.selenium.WebDriver>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractScreenshotHandler<org.openqa.selenium.WebDriver>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractScreenshotHandler<org.openqa.selenium.WebDriver>