All Implemented Interfaces:: ai.platon.pulsar.crawl.fetch.driver.JvmWebDriver , ai.platon.pulsar.crawl.fetch.driver.WebDriver , java.io.Closeable , java.lang.AutoCloseable , kotlin.Comparable


public abstract class AbstractWebDriver
extends AbstractJvmWebDriver implements Comparable<AbstractWebDriver>, WebDriver, JvmWebDriver

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`AbstractWebDriver.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private Duration`	`idleTimeout`
`private Duration`	`waitForElementTimeout`
`private final String`	`name`
`private final Function1<String, Long>`	`delayPolicy`
`private NavigateEntry`	`navigateEntry`
`private final NavigateHistory`	`navigateHistory`
`private final Boolean`	`supportJavascript`
`private final Boolean`	`isMockedPageSource`
`private Boolean`	`isRecovered`
`private Boolean`	`isReused`
`private final AtomicReference<WebDriver.State>`	`state`
`private final Map<String, Object>`	`data`
`private Instant`	`lastActiveTime`
`private final Boolean`	`isInit`
`private final Boolean`	`isReady`
`private final Boolean`	`isFree`
`private final Boolean`	`isWorking`
`private final Boolean`	`isRetired`
`private final Boolean`	`isQuit`
`private final Boolean`	`isCanceled`
`private final Boolean`	`isCrashed`
`private final String`	`sessionId`
`private final Map<String, Object>`	`mainRequestHeaders`
`private final List<Map<String, String>>`	`mainRequestCookies`
`private final Integer`	`mainResponseStatus`
`private final String`	`mainResponseStatusText`
`private final Map<String, Object>`	`mainResponseHeaders`
`private final Browser`	`browser`
`private final Integer`	`id`
`private final BrowserType`	`browserType`
`private final Boolean`	`isIdle`
`public final static AbstractWebDriver.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`AbstractWebDriver(Browser browser, Integer id)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Duration`	`getIdleTimeout()`	The idle timeout.
`Unit`	`setIdleTimeout(Duration idleTimeout)`	The idle timeout.
`Duration`	`getWaitForElementTimeout()`	The timeout to wait for some object.
`Unit`	`setWaitForElementTimeout(Duration waitForElementTimeout)`	The timeout to wait for some object.
`String`	`getName()`	The driver name.
`Function1<String, Long>`	`getDelayPolicy()`
`NavigateEntry`	`getNavigateEntry()`	The current navigation entry.
`Unit`	`setNavigateEntry(NavigateEntry navigateEntry)`	The current navigation entry.
`NavigateHistory`	`getNavigateHistory()`	The navigation history.
`Boolean`	`getSupportJavascript()`	Indicates whether the driver supports javascript.
`Boolean`	`isMockedPageSource()`	Indicate whether the page source is mocked.
`Boolean`	`isRecovered()`	Whether the driver is recovered from the browser's tab list.
`Unit`	`setRecovered(Boolean isRecovered)`	Whether the driver is recovered from the browser's tab list.
`Boolean`	`isReused()`	Whether the driver is recovered and is reused to serve new tasks.
`Unit`	`setReused(Boolean isReused)`	Whether the driver is recovered and is reused to serve new tasks.
`AtomicReference<WebDriver.State>`	`getState()`	The driver status.
`Map<String, Object>`	`getData()`	The associated data.
`Instant`	`getLastActiveTime()`	The time of the last action.
`Unit`	`setLastActiveTime(Instant lastActiveTime)`	The time of the last action.
`Boolean`	`isInit()`
`Boolean`	`isReady()`
`Boolean`	`isFree()`
`Boolean`	`isWorking()`
`Boolean`	`isRetired()`
`Boolean`	`isQuit()`
`Boolean`	`isCanceled()`
`Boolean`	`isCrashed()`
`String`	`getSessionId()`
`Map<String, Object>`	`getMainRequestHeaders()`
`List<Map<String, String>>`	`getMainRequestCookies()`
`Integer`	`getMainResponseStatus()`
`String`	`getMainResponseStatusText()`
`Map<String, Object>`	`getMainResponseHeaders()`
`Browser`	`getBrowser()`	The browser of the driver.
`Integer`	`getId()`	The unique driver id.
`Unit`	`free()`	Mark the driver as free, so it can be used to fetch a new page.
`Unit`	`startWork()`	Mark the driver as working, so it can not be used to fetch another page.
`Unit`	`retire()`	Mark the driver as retired, so it can not be used to fetch any page, and should be quit as soon as possible.
`Unit`	`cancel()`	Mark the driver as canceled, so the fetch process should return as soon as possible, and the fetch result should be dropped.
`JvmWebDriver`	`jvm()`	Returns a JvmWebDriver to support other JVM languages, such as java, clojure, scala, and so on, the other JVM languages might have difficulty to handle kotlin suspend methods.
`Unit`	`navigateTo(String url)`	Returns the main resource response.
`String`	`location()`	In javascript, the `window.location`, or `document.location`, is a read-only property returns a Location object, which contains information about the URL of the document and provides methods for changing that URL and loading another URL.
`String`	`baseURI()`	In javascript, the baseURI is a property of Node, it's the absolute base URL of the document containing the node.
`Long`	`waitForSelector(String selector, Long timeoutMillis)`	Returns when element specified by selector satisfies {@code state} option.
`Long`	`waitForSelector(String selector)`	Returns when element specified by selector satisfies {@code state} option.
`Long`	`waitForNavigation()`
`Long`	`waitForNavigation(Long timeoutMillis)`
`Object`	`evaluateSilently(String expression)`	Executes JavaScript in the context of the currently selected frame or window.
`Boolean`	`isVisible(String selector)`
`Boolean`	`isChecked(String selector)`
`Unit`	`scrollDown(Integer count)`
`Unit`	`scrollUp(Integer count)`
`Unit`	`scrollToTop()`
`Unit`	`scrollToBottom()`
`Unit`	`scrollToMiddle(Float ratio)`
`String`	`clickNthAnchor(Integer n, String rootSelector)`
`String`	`outerHTML()`	Returns the document's HTML markup.
`String`	`outerHTML(String selector)`	Returns the node's HTML markup.
`String`	`firstText(String selector)`	Returns the node's text content.
`List<String>`	`allTexts(String selector)`	Returns the nodes' text contents.
`String`	`firstAttr(String selector, String attrName)`	Returns the node's attribute name.
`List<String>`	`allAttrs(String selector, String attrName)`	Returns the nodes' attribute names.
`Unit`	`clickTextMatches(String selector, String pattern, Integer count)`
`Unit`	`clickMatches(String selector, String attrName, String pattern, Integer count)`
`Unit`	`check(String selector)`
`Unit`	`uncheck(String selector)`
`Connection`	`newSession()`	Create a new Jsoup session with the last page's context, which means, the same headers and cookies.
`Connection`	`newJsoupSession()`	Create a new Jsoup session with the last page's context, which means, the same headers and cookies.
`Connection.Response`	`loadJsoupResource(String url)`	Load the url as a resource with Jsoup rather than browser rendering, with the last page's context, which means, the same headers and cookies.
`NetworkResourceResponse`	`loadResource(String url)`	Load url as a resource without browser rendering, with the last page's context, which means, the same headers and cookies.
`Unit`	`quit()`	Quit the browser instance
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`Integer`	`compareTo(AbstractWebDriver other)`
`String`	`toString()`

Methods inherited from class ai.platon.pulsar.crawl.fetch.driver.WebDriver
addBlockedURLs, addInitScript, addProbabilityBlockedURLs, awaitTermination, boundingBox, bringToFront, captureScreenshot, captureScreenshot, clearBrowserCookies, click, clickMatches, clickablePoint, currentUrl, deleteCookies, deleteCookies, dragAndDrop, evaluate, evaluateDetail, exists, focus, getBrowserType, getCookies, isHidden, isIdle, mainRequestCookies, mainRequestHeaders, mouseWheelDown, mouseWheelUp, moveMouseTo, moveMouseTo, navigateTo, pageSource, pause, scrollTo, setTimeouts, stop, stopLoading, terminate, type, visible, waitForNavigation, waitForPage, waitForSelector
Methods inherited from class ai.platon.pulsar.crawl.fetch.driver.AbstractJvmWebDriver
addBlockedURLsAsync, addInitScriptAsync, allAttrsAsync, allTextsAsync, boundingBoxAsync, bringToFrontAsync, captureScreenshotAsync, captureScreenshotAsync, checkAsync, clickAsync, clickMatchesAsync, clickMatchesAsync, clickNthAnchorAsync, clickablePointAsync, currentUrlAsync, dragAndDropAsync, evaluateAsync, evaluateSilentlyAsync, existsAsync, firstAttrAsync, firstTextAsync, getCookiesAsync, isCheckedAsync, isHiddenAsync, isVisibleAsync, loadResourceAsync, mainRequestCookiesAsync, mainRequestHeadersAsync, mouseWheelDownAsync, mouseWheelUpAsync, moveMouseToAsync, navigateToAsync, navigateToAsync, newSessionAsync, outerHTMLAsync, pageSourceAsync, pauseAsync, scrollDownAsync, scrollToAsync, scrollToBottomAsync, scrollToMiddleAsync, scrollToTopAsync, scrollUpAsync, setTimeoutsAsync, stopAsync, terminateAsync, typeAsync, uncheckAsync, visibleAsync, waitForNavigationAsync, waitForNavigationAsync, waitForNavigationAsync, waitForSelectorAsync, waitForSelectorAsync, waitForSelectorAsync
Methods inherited from class ai.platon.pulsar.crawl.fetch.driver.JvmWebDriver
clickAsync, clickMatchesAsync
Methods inherited from class java.io.Closeable
close
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractWebDriver
```
AbstractWebDriver(Browser browser, Integer id)
```
- Method Detail
  - getIdleTimeout
```
 Duration getIdleTimeout()
```
    The idle timeout.
  - setIdleTimeout
```
 Unit setIdleTimeout(Duration idleTimeout)
```
    The idle timeout.
  - getWaitForElementTimeout
```
 Duration getWaitForElementTimeout()
```
    The timeout to wait for some object.
  - setWaitForElementTimeout
```
 Unit setWaitForElementTimeout(Duration waitForElementTimeout)
```
    The timeout to wait for some object.
  - getName
```
 String getName()
```
    The driver name.
  - getDelayPolicy
```
 Function1<String, Long> getDelayPolicy()
```
  - getNavigateEntry
```
 NavigateEntry getNavigateEntry()
```
    The current navigation entry.
  - setNavigateEntry
```
 Unit setNavigateEntry(NavigateEntry navigateEntry)
```
    The current navigation entry.
  - getNavigateHistory
```
 NavigateHistory getNavigateHistory()
```
    The navigation history.
  - getSupportJavascript
```
 Boolean getSupportJavascript()
```
    Indicates whether the driver supports javascript. Web drivers such as MockDriver do not support javascript.
  - isMockedPageSource
```
 Boolean isMockedPageSource()
```
    Indicate whether the page source is mocked.
  - isRecovered
```
 Boolean isRecovered()
```
    Whether the driver is recovered from the browser's tab list.
  - setRecovered
```
 Unit setRecovered(Boolean isRecovered)
```
    Whether the driver is recovered from the browser's tab list.
  - isReused
```
 Boolean isReused()
```
    Whether the driver is recovered and is reused to serve new tasks.
  - setReused
```
 Unit setReused(Boolean isReused)
```
    Whether the driver is recovered and is reused to serve new tasks.
  - getState
```
 AtomicReference<WebDriver.State> getState()
```
    The driver status.
  - getData
```
 Map<String, Object> getData()
```
    The associated data.
  - getLastActiveTime
```
 Instant getLastActiveTime()
```
    The time of the last action.
  - setLastActiveTime
```
 Unit setLastActiveTime(Instant lastActiveTime)
```
    The time of the last action.
  - isInit
```
 Boolean isInit()
```
  - isReady
```
 Boolean isReady()
```
  - isFree
```
 Boolean isFree()
```
  - isWorking
```
 Boolean isWorking()
```
  - isRetired
```
 Boolean isRetired()
```
  - isQuit
```
 Boolean isQuit()
```
  - isCanceled
```
 Boolean isCanceled()
```
  - isCrashed
```
 Boolean isCrashed()
```
  - getSessionId
```
 String getSessionId()
```
  - getMainRequestHeaders
```
 Map<String, Object> getMainRequestHeaders()
```
  - getMainRequestCookies
```
 List<Map<String, String>> getMainRequestCookies()
```
  - getMainResponseStatus
```
 Integer getMainResponseStatus()
```
  - getMainResponseStatusText
```
 String getMainResponseStatusText()
```
  - getMainResponseHeaders
```
 Map<String, Object> getMainResponseHeaders()
```
  - getBrowser
```
 Browser getBrowser()
```
    The browser of the driver. The browser defines methods and events to manipulate a real browser.
  - getId
```
 Integer getId()
```
    The unique driver id.
  - free
```
 Unit free()
```
    Mark the driver as free, so it can be used to fetch a new page.
  - startWork
```
 Unit startWork()
```
    Mark the driver as working, so it can not be used to fetch another page.
  - retire
```
 Unit retire()
```
    Mark the driver as retired, so it can not be used to fetch any page, and should be quit as soon as possible.
  - cancel
```
 Unit cancel()
```
    Mark the driver as canceled, so the fetch process should return as soon as possible, and the fetch result should be dropped.
  - jvm
```
 JvmWebDriver jvm()
```
    Returns a JvmWebDriver to support other JVM languages, such as java, clojure, scala, and so on, the other JVM languages might have difficulty to handle kotlin suspend methods.
  - navigateTo
```
 Unit navigateTo(String url)
```
    Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first non-redirect response.
    
    Parameters:
    
    url - URL to navigate page to.
  - location
```
 String location()
```
    In javascript, the window.location, or document.location, is a read-only property returns a Location object, which contains information about the URL of the document and provides methods for changing that URL and loading another URL.
    To retrieve just the URL as a string, the read-only document.URL property can also be used.
  - baseURI
```
 String baseURI()
```
    In javascript, the baseURI is a property of Node, it's the absolute base URL of the document containing the node. A baseURI is used to resolve relative URLs.
    The base URL is determined as follows:
    By default, the base URL is the location of the document (as determined by window.location).
    If the document has an <base> element, its href attribute is used.
  - waitForSelector
```
 Long waitForSelector(String selector, Long timeoutMillis)
```
    Returns when element specified by selector satisfies {@code state} option. Returns the time remaining until timeout.
  - waitForSelector
```
 Long waitForSelector(String selector)
```
    Returns when element specified by selector satisfies {@code state} option.
  - waitForNavigation
```
 Long waitForNavigation()
```
  - waitForNavigation
```
 Long waitForNavigation(Long timeoutMillis)
```
  - evaluateSilently
```
 Object evaluateSilently(String expression)
```
    Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.
    All possible exceptions are suppressed and do not throw.
    
    Parameters:
    
    expression - Javascript expression to evaluate
  - isVisible
```
 Boolean isVisible(String selector)
```
  - isChecked
```
 Boolean isChecked(String selector)
```
  - scrollDown
```
 Unit scrollDown(Integer count)
```
  - scrollUp
```
 Unit scrollUp(Integer count)
```
  - scrollToTop
```
 Unit scrollToTop()
```
  - scrollToBottom
```
 Unit scrollToBottom()
```
  - scrollToMiddle
```
 Unit scrollToMiddle(Float ratio)
```
  - clickNthAnchor
```
 String clickNthAnchor(Integer n, String rootSelector)
```
  - outerHTML
```
 String outerHTML()
```
    Returns the document's HTML markup.
  - outerHTML
```
 String outerHTML(String selector)
```
    Returns the node's HTML markup.
  - firstText
```
 String firstText(String selector)
```
    Returns the node's text content.
  - allTexts
```
 List<String> allTexts(String selector)
```
    Returns the nodes' text contents.
  - firstAttr
```
 String firstAttr(String selector, String attrName)
```
    Returns the node's attribute name.
  - allAttrs
```
 List<String> allAttrs(String selector, String attrName)
```
    Returns the nodes' attribute names.
  - clickTextMatches
```
 Unit clickTextMatches(String selector, String pattern, Integer count)
```
  - clickMatches
```
 Unit clickMatches(String selector, String attrName, String pattern, Integer count)
```
  - check
```
 Unit check(String selector)
```
  - uncheck
```
 Unit uncheck(String selector)
```
  - newSession
```
@Deprecated(message = "Inappropriate name", replaceWith = @ReplaceWith(imports = {}, expression = "newJsoupSession()")) Connection newSession()
```
    Create a new Jsoup session with the last page's context, which means, the same headers and cookies.
  - newJsoupSession
```
 Connection newJsoupSession()
```
    Create a new Jsoup session with the last page's context, which means, the same headers and cookies.
  - loadJsoupResource
```
 Connection.Response loadJsoupResource(String url)
```
    Load the url as a resource with Jsoup rather than browser rendering, with the last page's context, which means, the same headers and cookies.
  - loadResource
```
 NetworkResourceResponse loadResource(String url)
```
    Load url as a resource without browser rendering, with the last page's context, which means, the same headers and cookies.
  - quit
```
@Deprecated(message = "Inappropriate name", replaceWith = @ReplaceWith(imports = {}, expression = "close()")) Unit quit()
```
    Quit the browser instance
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - compareTo
```
 Integer compareTo(AbstractWebDriver other)
```
  - toString
```
 String toString()
```

Class AbstractWebDriver

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class ai.platon.pulsar.crawl.fetch.driver.WebDriver

Methods inherited from class ai.platon.pulsar.crawl.fetch.driver.AbstractJvmWebDriver

Methods inherited from class ai.platon.pulsar.crawl.fetch.driver.JvmWebDriver

Methods inherited from class java.io.Closeable

Methods inherited from class java.lang.Object

Constructor Detail

AbstractWebDriver

Method Detail

getIdleTimeout

setIdleTimeout

getWaitForElementTimeout

setWaitForElementTimeout

getName

getDelayPolicy

getNavigateEntry

setNavigateEntry

getNavigateHistory

getSupportJavascript

isMockedPageSource

isRecovered

setRecovered

isReused

setReused

getState

getData

getLastActiveTime

setLastActiveTime

isInit

isReady

isFree

isWorking

isRetired

isQuit

isCanceled

isCrashed

getSessionId

getMainRequestHeaders

getMainRequestCookies

getMainResponseStatus

getMainResponseStatusText

getMainResponseHeaders

getBrowser

getId

free

startWork

retire

cancel

jvm

navigateTo

location

baseURI

waitForSelector

waitForSelector

waitForNavigation

waitForNavigation

evaluateSilently

isVisible

isChecked

scrollDown

scrollUp

scrollToTop

scrollToBottom

scrollToMiddle

clickNthAnchor

outerHTML

outerHTML

firstText

allTexts

firstAttr

allAttrs

clickTextMatches

clickMatches

check

uncheck