All Implemented Interfaces:: ai.platon.pulsar.skeleton.crawl.fetch.privacy.PrivacyContext , java.lang.AutoCloseable , kotlin.Comparable


public abstract class AbstractPrivacyContext
 implements PrivacyContext, Comparable<PrivacyContext>

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`private WebDriverFetcher`	`webdriverFetcher`
`private final PrivacyAgentId`	`id`
`private final Integer`	`seq`
`private final String`	`display`
`private final Path`	`baseDir`
`private final Float`	`minimumThroughput`
`private final Integer`	`maximumWarnings`
`private final Integer`	`minorWarningFactor`
`private final AtomicInteger`	`privacyLeakWarnings`
`private final AtomicInteger`	`privacyLeakMinorWarnings`
`private final Meter`	`meterTasks`
`private final Meter`	`meterSuccesses`
`private final Meter`	`meterFinishes`
`private final Meter`	`meterSmallPages`
`private final Double`	`smallPageRate`
`private final Float`	`successRate`
`private final Float`	`failureRate`
`private final Float`	`failureRateThreshold`
`private final Boolean`	`isHighFailureRate`
`private final Instant`	`startTime`
`private final Instant`	`lastActiveTime`
`private final Duration`	`elapsedTime`
`private final Duration`	`idleTime`
`private final Boolean`	`isIdle`
`private final Boolean`	`isGood`
`private final Boolean`	`isLeaked`
`private final Boolean`	`isRetired`
`private final Boolean`	`isActive`
`private final Boolean`	`isClosed`
`private final Boolean`	`isReady`
`private final Boolean`	`isFullCapacity`
`private final Boolean`	`isUnderLoaded`
`private final Map<String, Object>`	`state`
`private final String`	`readableState`
`private final PrivacyAgent`	`privacyAgent`
`private final ImmutableConfig`	`conf`
`public final static AbstractPrivacyContext.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`AbstractPrivacyContext(PrivacyAgent privacyAgent, ImmutableConfig conf)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final WebDriverFetcher`	`getWebdriverFetcher()`
`final Unit`	`setWebdriverFetcher(WebDriverFetcher webdriverFetcher)`
`PrivacyAgentId`	`getId()`	The privacy context id.
`final Integer`	`getSeq()`
`String`	`getDisplay()`	A readable privacy context display.
`final Path`	`getBaseDir()`
`final Float`	`getMinimumThroughput()`
`final Integer`	`getMaximumWarnings()`
`final Integer`	`getMinorWarningFactor()`
`final AtomicInteger`	`getPrivacyLeakWarnings()`
`final AtomicInteger`	`getPrivacyLeakMinorWarnings()`
`final Meter`	`getMeterTasks()`
`final Meter`	`getMeterSuccesses()`
`final Meter`	`getMeterFinishes()`
`final Meter`	`getMeterSmallPages()`
`final Double`	`getSmallPageRate()`
`final Float`	`getSuccessRate()`
`Float`	`getFailureRate()`	The failure rate of the privacy context.
`final Float`	`getFailureRateThreshold()`
`Boolean`	`isHighFailureRate()`	Check whether the failure rate is high.
`final Instant`	`getStartTime()`	The start time of the privacy context.
`final Instant`	`getLastActiveTime()`	The last active time of the privacy context.
`Duration`	`getElapsedTime()`	The elapsed time of the privacy context.
`Duration`	`getIdleTime()`	The idle time of the privacy context.
`Boolean`	`isIdle()`	Check whether the privacy context is idle.
`Boolean`	`isGood()`	Check whether the privacy context is good.
`Boolean`	`isLeaked()`	Check whether the privacy context is leaked.
`Boolean`	`isRetired()`	Check whether the privacy context is retired.
`Boolean`	`isActive()`	Check whether the privacy context is active.
`Boolean`	`isClosed()`	Check whether the privacy context is closed.
`Boolean`	`isReady()`	A ready privacy context is ready to serve tasks.
`Boolean`	`isFullCapacity()`	Check whether the privacy context is at full capacity.
`Boolean`	`isUnderLoaded()`	Check whether the privacy context is running under loaded.
`Map<String, Object>`	`getState()`	Get the readable privacy context state.
`String`	`getReadableState()`	Get the readable privacy context state.
`PrivacyAgent`	`getPrivacyAgent()`	The associated privacy agent.
`final ImmutableConfig`	`getConf()`
`final String`	`formatState()`
`abstract Integer`	`promisedWebDriverCount()`	The promised workers (free web drivers) count.
`Boolean`	`hasWebDriverPromise()`	Check if the privacy context promises at least one worker to provide.
`abstract WebDriver`	`subscribeWebDriver()`
`final Unit`	`markSuccess()`	Marks a task as successful and updates relevant metrics.
`final Unit`	`markWarning()`	Mark a warning.
`final Unit`	`markWarning(Integer n)`	Mark n warnings.
`final Unit`	`markMinorWarning()`	Mark a minor warnings.
`final Unit`	`markLeaked()`	Mark the privacy context as leaked.
`abstract FetchResult`	`open(String url)`	Open an url in the privacy context.
`abstract FetchResult`	`open(String url, LoadOptions options)`	Open an url in the privacy context, with the specified options.
`FetchResult`	`open(String url, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)`	Open an url in the privacy context, with the specified fetch function.
`FetchResult`	`run(FetchTask task, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)`	Run a task in the privacy context, with the specified fetch function.
`abstract FetchResult`	`doRun(FetchTask task, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)`	Run a task in the privacy context.
`String`	`buildStatusString()`	Build the privacy context status string.
`Unit`	`dismiss()`	Dismisses the privacy context and marks it as retired, indicating that it should be closed later.
`abstract Unit`	`maintain()`	Do the maintaining jobs.
`Integer`	`compareTo(PrivacyContext other)`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`buildReport()`	Build the privacy context report.
`Unit`	`report()`

Methods inherited from class java.lang.AutoCloseable
close
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractPrivacyContext
```
AbstractPrivacyContext(PrivacyAgent privacyAgent, ImmutableConfig conf)
```
- Method Detail
  - getWebdriverFetcher
```
 final WebDriverFetcher getWebdriverFetcher()
```
  - setWebdriverFetcher
```
 final Unit setWebdriverFetcher(WebDriverFetcher webdriverFetcher)
```
  - getId
```
 PrivacyAgentId getId()
```
    The privacy context id.
  - getSeq
```
 final Integer getSeq()
```
  - getDisplay
```
 String getDisplay()
```
    A readable privacy context display.
  - getBaseDir
```
 final Path getBaseDir()
```
  - getMinimumThroughput
```
 final Float getMinimumThroughput()
```
  - getMaximumWarnings
```
 final Integer getMaximumWarnings()
```
  - getMinorWarningFactor
```
 final Integer getMinorWarningFactor()
```
  - getPrivacyLeakWarnings
```
 final AtomicInteger getPrivacyLeakWarnings()
```
  - getPrivacyLeakMinorWarnings
```
 final AtomicInteger getPrivacyLeakMinorWarnings()
```
  - getMeterTasks
```
 final Meter getMeterTasks()
```
  - getMeterSuccesses
```
 final Meter getMeterSuccesses()
```
  - getMeterFinishes
```
 final Meter getMeterFinishes()
```
  - getMeterSmallPages
```
 final Meter getMeterSmallPages()
```
  - getSmallPageRate
```
 final Double getSmallPageRate()
```
  - getSuccessRate
```
 final Float getSuccessRate()
```
  - getFailureRate
```
 Float getFailureRate()
```
    The failure rate of the privacy context.
  - getFailureRateThreshold
```
 final Float getFailureRateThreshold()
```
  - isHighFailureRate
```
 Boolean isHighFailureRate()
```
    Check whether the failure rate is high.
  - getStartTime
```
 final Instant getStartTime()
```
    The start time of the privacy context.
  - getLastActiveTime
```
 final Instant getLastActiveTime()
```
    The last active time of the privacy context.
  - getElapsedTime
```
 Duration getElapsedTime()
```
    The elapsed time of the privacy context.
  - getIdleTime
```
 Duration getIdleTime()
```
    The idle time of the privacy context.
  - isIdle
```
 Boolean isIdle()
```
    Check whether the privacy context is idle.
  - isGood
```
 Boolean isGood()
```
    Check whether the privacy context is good.
    A good privacy context has to meet the following requirements:
    the fetch speed is good
  - isLeaked
```
 Boolean isLeaked()
```
    Check whether the privacy context is leaked.
    This property indicates whether the privacy context has been marked as leaked. It returns the value of the leaked field, which is a boolean indicating the leakage status.
    
    Returns:
    
    true if the privacy context is leaked, false otherwise.
  - isRetired
```
 Boolean isRetired()
```
    Check whether the privacy context is retired.
    This property indicates whether the privacy context has been marked as retired. It returns the value of the retired field, which is a boolean indicating the retirement status.
    
    Returns:
    
    true if the privacy context is retired, false otherwise.
  - isActive
```
 Boolean isActive()
```
    Check whether the privacy context is active.
    TODO: check and distinct from isReady in use cases.
    An active privacy context has to meet the following requirements:
    not closed
    not leaked
    not retired
    Note: this flag does not guarantee consistency, and can change immediately after it's read
  - isClosed
```
 Boolean isClosed()
```
    Check whether the privacy context is closed.
  - isReady
```
 Boolean isReady()
```
    A ready privacy context is ready to serve tasks.
    A ready privacy context has to meet the following requirements:
    not closed
    not leaked
    requirement removed not idle
    not retired
    if there is a proxy, the proxy has to be ready
    the associated driver pool promises to provide an available driver, ether one of the following:
    Note: this flag does not guarantee consistency, and can change immediately after it's read
  - isFullCapacity
```
 Boolean isFullCapacity()
```
    Check whether the privacy context is at full capacity. If the privacy context is indeed at full capacity, it should not be used for processing new tasks, and the underlying services may potentially refuse to provide service.
    A privacy context is running at full capacity when the underlying webdriver pool is full capacity, so the webdriver pool can not provide a webdriver for new tasks.
    Note that if a driver pool is retired or closed, it's not full capacity.
    
    Returns:
    
    True if the privacy context is running at full capacity, false otherwise.
  - isUnderLoaded
```
 Boolean isUnderLoaded()
```
    Check whether the privacy context is running under loaded.
  - getState
```
 Map<String, Object> getState()
```
    Get the readable privacy context state.
  - getReadableState
```
 String getReadableState()
```
    Get the readable privacy context state.
  - getPrivacyAgent
```
 PrivacyAgent getPrivacyAgent()
```
    The associated privacy agent.
  - getConf
```
 final ImmutableConfig getConf()
```
  - formatState
```
 final String formatState()
```
  - promisedWebDriverCount
```
 abstract Integer promisedWebDriverCount()
```
    The promised workers (free web drivers) count.
    The implementation has to tell the caller how many workers (free web drivers) it can provide.
    The number of workers can change immediately after reading, so the caller only has promises but no guarantees.
    
    Returns:
    
    the number of workers promised.
  - hasWebDriverPromise
```
 Boolean hasWebDriverPromise()
```
    Check if the privacy context promises at least one worker to provide.
  - subscribeWebDriver
```
@Beta() abstract WebDriver subscribeWebDriver()
```
  - markSuccess
```
 final Unit markSuccess()
```
    Marks a task as successful and updates relevant metrics.
  - markWarning
```
 final Unit markWarning()
```
    Mark a warning.
  - markWarning
```
 final Unit markWarning(Integer n)
```
    Mark n warnings.
  - markMinorWarning
```
 final Unit markMinorWarning()
```
    Mark a minor warnings.
  - markLeaked
```
 final Unit markLeaked()
```
    Mark the privacy context as leaked. A leaked privacy context should not serve anymore, and will be closed soon.
  - open
```
 abstract FetchResult open(String url)
```
    Open an url in the privacy context.
    
    Parameters:
    
    url - The URL to open.
  - open
```
 abstract FetchResult open(String url, LoadOptions options)
```
    Open an url in the privacy context, with the specified options.
    
    Parameters:
    
    url - The URL to open.
    
    options - The load options to use.
  - open
```
 FetchResult open(String url, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)
```
    Open an url in the privacy context, with the specified fetch function.
    
    Parameters:
    
    url - The URL to open.
    
    fetchFun - The fetch function to use.
  - run
```
 FetchResult run(FetchTask task, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)
```
    Run a task in the privacy context, with the specified fetch function.
    
    Parameters:
    
    task - the fetch task
    
    fetchFun - the fetch function
    
    Returns:
    
    the fetch result
  - doRun
```
 abstract FetchResult doRun(FetchTask task, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)
```
    Run a task in the privacy context.
    
    Parameters:
    
    task - the fetch task
    
    fetchFun - the fetch function
    
    Returns:
    
    the fetch result
  - buildStatusString
```
 String buildStatusString()
```
    Build the privacy context status string.
  - dismiss
```
 Unit dismiss()
```
    Dismisses the privacy context and marks it as retired, indicating that it should be closed later. This function sets the retired flag to true, signaling that the privacy context is no longer active and should be handled accordingly (e.g., closed or cleaned up).
    This function does not take any parameters and does not return any value.
  - maintain
```
 abstract Unit maintain()
```
    Do the maintaining jobs.
  - compareTo
```
 Integer compareTo(PrivacyContext other)
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - buildReport
```
 String buildReport()
```
    Build the privacy context report.
    This method is used to build the privacy context report. It should be called periodically to keep the privacy context alive.
  - report
```
 Unit report()
```

Class AbstractPrivacyContext

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.AutoCloseable

Methods inherited from class java.lang.Object

Constructor Detail

AbstractPrivacyContext

Method Detail

getWebdriverFetcher

setWebdriverFetcher

getId

getSeq

getDisplay

getBaseDir

getMinimumThroughput

getMaximumWarnings

getMinorWarningFactor

getPrivacyLeakWarnings

getPrivacyLeakMinorWarnings

getMeterTasks

getMeterSuccesses

getMeterFinishes

getMeterSmallPages

getSmallPageRate

getSuccessRate

getFailureRate

getFailureRateThreshold

isHighFailureRate

getStartTime

getLastActiveTime

getElapsedTime

getIdleTime

isIdle

isGood

isLeaked

isRetired

isActive

isClosed

isReady

isFullCapacity

isUnderLoaded

getState

getReadableState

getPrivacyAgent

getConf

formatState

promisedWebDriverCount

hasWebDriverPromise

subscribeWebDriver

markSuccess

markWarning

markWarning

markMinorWarning

markLeaked

open

open

open

run

doRun

buildStatusString

dismiss

maintain

compareTo

equals

hashCode

buildReport

report