All Implemented Interfaces:

java.lang.AutoCloseable , kotlin.Comparable
```
public abstract class PrivacyContext
 implements Comparable<PrivacyContext>, AutoCloseable
                    
```
A privacy context is a unique context of a privacy agent to the target website, it will be closed once it is leaked.
One of the biggest difficulties in web scraping tasks is the bot stealth.
For web scraping tasks, the website should have no idea whether a visit is from a human being or a bot. Once a page visit is suspected by the website, which we call a privacy leak, the privacy context has to be dropped, and Pulsar will visit the page in another privacy context.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`CONTEXT_DIR_PREFIX`
`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`	`idelTime`
`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 String`	`readableState`
`private final PrivacyAgent`	`privacyAgent`
`private final ImmutableConfig`	`conf`
`public final static PrivacyContext.Companion`	`Companion`

Constructor Summary

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

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final PrivacyAgentId`	`getId()`
`final Integer`	`getSeq()`
`final String`	`getDisplay()`
`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()`
`final Float`	`getFailureRate()`
`final Float`	`getFailureRateThreshold()`
`final Boolean`	`isHighFailureRate()`
`final Instant`	`getStartTime()`	The start time of the privacy context.
`final Instant`	`getLastActiveTime()`	The last active time of the privacy context.
`final Duration`	`getElapsedTime()`
`final Duration`	`getIdelTime()`
`Boolean`	`isIdle()`
`Boolean`	`isGood()`
`Boolean`	`isLeaked()`
`Boolean`	`isRetired()`
`Boolean`	`isActive()`
`Boolean`	`isClosed()`
`Boolean`	`isReady()`
`Boolean`	`isFullCapacity()`	Check whether the privacy context is at full capacity.
`Boolean`	`isUnderLoaded()`
`String`	`getReadableState()`
`final PrivacyAgent`	`getPrivacyAgent()`
`final ImmutableConfig`	`getConf()`
`abstract Integer`	`promisedWebDriverCount()`	The promised worker count.
`final Boolean`	`hasWebDriverPromise()`	Check if the privacy context promises at least one worker to provide.
`abstract WebDriver`	`subscribeWebDriver()`
`final Unit`	`markSuccess()`	Mark a success task.
`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.
`FetchResult`	`run(FetchTask task, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)`	Run a task in the privacy context and record the status.
`abstract FetchResult`	`doRun(FetchTask task, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)`	Run a task in the privacy context.
`final String`	`takeSnapshot()`
`final Unit`	`dismiss()`	Dismiss the privacy context and mark it as be retired, so it should be closed later.
`abstract Unit`	`maintain()`	Do the maintaining jobs.
`Integer`	`compareTo(PrivacyContext other)`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`getReport()`
`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
  - PrivacyContext
```
PrivacyContext(PrivacyAgent privacyAgent, ImmutableConfig conf)
```
- Method Detail
  - getId
```
 final PrivacyAgentId getId()
```
  - getSeq
```
 final Integer getSeq()
```
  - getDisplay
```
 final String getDisplay()
```
  - 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
```
 final Float getFailureRate()
```
  - getFailureRateThreshold
```
 final Float getFailureRateThreshold()
```
  - isHighFailureRate
```
 final Boolean isHighFailureRate()
```
  - getStartTime
```
 final Instant getStartTime()
```
    The start time of the privacy context.
  - getLastActiveTime
```
 final Instant getLastActiveTime()
```
    The last active time of the privacy context.
  - getElapsedTime
```
 final Duration getElapsedTime()
```
  - getIdelTime
```
 final Duration getIdelTime()
```
  - isIdle
```
 Boolean isIdle()
```
  - isGood
```
 Boolean isGood()
```
  - isLeaked
```
 Boolean isLeaked()
```
  - isRetired
```
 Boolean isRetired()
```
  - isActive
```
 Boolean isActive()
```
  - isClosed
```
 Boolean isClosed()
```
  - isReady
```
 Boolean isReady()
```
  - 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()
```
  - getReadableState
```
 String getReadableState()
```
  - getPrivacyAgent
```
 final PrivacyAgent getPrivacyAgent()
```
  - getConf
```
 final ImmutableConfig getConf()
```
  - promisedWebDriverCount
```
 abstract Integer promisedWebDriverCount()
```
    The promised worker count.
    The implementation has to tell the caller how many workers 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
```
 final Boolean hasWebDriverPromise()
```
    Check if the privacy context promises at least one worker to provide.
  - subscribeWebDriver
```
@Beta() abstract WebDriver subscribeWebDriver()
```
  - markSuccess
```
 final Unit markSuccess()
```
    Mark a success task.
  - 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.
  - run
```
 FetchResult run(FetchTask task, SuspendFunction2<FetchTask, WebDriver, FetchResult> fetchFun)
```
    Run a task in the privacy context and record the status.
    
    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
  - takeSnapshot
```
 final String takeSnapshot()
```
  - dismiss
```
 final Unit dismiss()
```
    Dismiss the privacy context and mark it as be retired, so it should be closed later.
  - maintain
```
 abstract Unit maintain()
```
    Do the maintaining jobs.
  - compareTo
```
 Integer compareTo(PrivacyContext other)
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - getReport
```
 String getReport()
```
  - report
```
 Unit report()
```

Class PrivacyContext

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

PrivacyContext

Method Detail

getId

getSeq

getDisplay

getBaseDir

getMinimumThroughput

getMaximumWarnings

getMinorWarningFactor

getPrivacyLeakWarnings

getPrivacyLeakMinorWarnings

getMeterTasks

getMeterSuccesses

getMeterFinishes

getMeterSmallPages

getSmallPageRate

getSuccessRate

getFailureRate

getFailureRateThreshold

isHighFailureRate

getStartTime

getLastActiveTime

getElapsedTime

getIdelTime

isIdle

isGood

isLeaked

isRetired

isActive

isClosed

isReady

isFullCapacity

isUnderLoaded

getReadableState

getPrivacyAgent

getConf

promisedWebDriverCount

hasWebDriverPromise

subscribeWebDriver

markSuccess

markWarning

markWarning

markMinorWarning

markLeaked

run

doRun

takeSnapshot

dismiss

maintain

compareTo

equals

hashCode

getReport

report