All Implemented Interfaces:: ai.platon.pulsar.common.event.EventEmitter , ai.platon.pulsar.skeleton.crawl.fetch.driver.Browser , java.lang.AutoCloseable


public abstract class AbstractBrowser
extends AbstractEventEmitter<BrowserEvents> implements Browser, AutoCloseable

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`isActive`
`private final String`	`userAgent`
`private String`	`userAgentOverride`
`private final NavigateHistory`	`navigateHistory`
`private final Map<String, WebDriver>`	`drivers`
`private final Map<String, Object>`	`data`
`private final Boolean`	`isIdle`
`private final Boolean`	`isPermanent`
`private final Boolean`	`isGUI`
`private final Duration`	`idleTimeout`
`private final BrowserId`	`id`
`private final BrowserSettings`	`browserSettings`
`private Function1<Throwable, Unit>`	`eventExceptionHandler`
`private final Map<BrowserEvents, List<Function<Object>>>`	`listeners`
`public final static AbstractBrowser.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`AbstractBrowser(BrowserId id, BrowserSettings browserSettings)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`isActive()`
`String`	`getUserAgent()`	The user agent.
`final String`	`getUserAgentOverride()`
`final Unit`	`setUserAgentOverride(String userAgentOverride)`
`NavigateHistory`	`getNavigateHistory()`	The navigation history.
`Map<String, WebDriver>`	`getDrivers()`	The created drivers by this browser.
`Map<String, Object>`	`getData()`	The associated data.
`Boolean`	`isIdle()`	Check if this browser is idle.
`Boolean`	`isPermanent()`	Check if this browser is permanent.
`final Boolean`	`isGUI()`
`final Duration`	`getIdleTimeout()`
`BrowserId`	`getId()`	The unique browser id
`final BrowserSettings`	`getBrowserSettings()`
`List<WebDriver>`	`listDrivers()`	List all drivers, each driver is associated with a Chrome tab.
`WebDriver`	`findDriver(String url)`	Find a driver by url.
`WebDriver`	`findDrivers(Regex urlRegex)`	Find drivers by url regex.
`Unit`	`destroyDriver(WebDriver driver)`	Destroy the web driver, close the associated browser tabs.
`Unit`	`destroyForcibly()`	Destroy the browser forcibly, kill the associated browser processes, release all allocated resources, regardless of whether the browser is closed or not.
`Unit`	`clearCookies()`	Clear all cookies.
`final Unit`	`onInitialize()`
`final Unit`	`onWillNavigate(NavigateEntry entry)`
`Unit`	`close()`
`Unit`	`maintain()`

Methods inherited from class ai.platon.pulsar.common.event.AbstractEventEmitter
count, emit, emit, emit, emit, emit1, emit1, emit1, emit1, getEventExceptionHandler, getListeners, hasListeners, listeners, listeners, off, off, off, off, off, off1, off1, off1, off1, off1, on, on, on, on, on1, on1, on1, on1, once, once, once, once1, once1, once1, setEventExceptionHandler
Methods inherited from class ai.platon.pulsar.skeleton.crawl.fetch.driver.Browser
newDriver, newDriver
Methods inherited from class ai.platon.pulsar.common.event.EventEmitter
hasNormalListeners, hasSuspendListeners, normalListeners, normalListeners, suspendListeners, suspendListeners
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractBrowser
```
AbstractBrowser(BrowserId id, BrowserSettings browserSettings)
```
- Method Detail
  - isActive
```
 Boolean isActive()
```
  - getUserAgent
```
 String getUserAgent()
```
    The user agent. A user agent is a string that a browser sends to each website you visit. It's created when the browser first connected to the remote browser.
  - getUserAgentOverride
```
 final String getUserAgentOverride()
```
  - setUserAgentOverride
```
 final Unit setUserAgentOverride(String userAgentOverride)
```
  - getNavigateHistory
```
 NavigateHistory getNavigateHistory()
```
    The navigation history.
  - getDrivers
```
 Map<String, WebDriver> getDrivers()
```
    The created drivers by this browser.
  - getData
```
 Map<String, Object> getData()
```
    The associated data.
  - isIdle
```
 Boolean isIdle()
```
    Check if this browser is idle.
  - isPermanent
```
 Boolean isPermanent()
```
    Check if this browser is permanent.
    If a browser is permanent:
    it will not be closed when the browser is idle
    the user data will be kept after the browser is closed
  - isGUI
```
 final Boolean isGUI()
```
  - getIdleTimeout
```
 final Duration getIdleTimeout()
```
  - getId
```
 BrowserId getId()
```
    The unique browser id
  - getBrowserSettings
```
 final BrowserSettings getBrowserSettings()
```
  - listDrivers
```
 List<WebDriver> listDrivers()
```
    List all drivers, each driver is associated with a Chrome tab.
  - findDriver
```
 WebDriver findDriver(String url)
```
    Find a driver by url.
  - findDrivers
```
 WebDriver findDrivers(Regex urlRegex)
```
    Find drivers by url regex.
  - destroyDriver
```
 Unit destroyDriver(WebDriver driver)
```
    Destroy the web driver, close the associated browser tabs.
  - destroyForcibly
```
 Unit destroyForcibly()
```
    Destroy the browser forcibly, kill the associated browser processes, release all allocated resources, regardless of whether the browser is closed or not.
  - clearCookies
```
 Unit clearCookies()
```
    Clear all cookies. Notice: even if we clear all cookies, the website still has some technology to track a session.
  - onInitialize
```
 final Unit onInitialize()
```
  - onWillNavigate
```
 final Unit onWillNavigate(NavigateEntry entry)
```
  - close
```
 Unit close()
```
  - maintain
```
 Unit maintain()
```

Class AbstractBrowser

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class ai.platon.pulsar.common.event.AbstractEventEmitter

Methods inherited from class ai.platon.pulsar.skeleton.crawl.fetch.driver.Browser

Methods inherited from class ai.platon.pulsar.common.event.EventEmitter

Methods inherited from class java.lang.Object

Constructor Detail

AbstractBrowser

Method Detail

isActive

getUserAgent

getUserAgentOverride

setUserAgentOverride

getNavigateHistory

getDrivers

getData

isIdle

isPermanent

isGUI

getIdleTimeout

getId

getBrowserSettings

listDrivers

findDriver

findDrivers

destroyDriver

destroyForcibly

clearCookies

onInitialize

onWillNavigate

close

maintain