com.github.mike10004.seleniumhelp

Interface TrafficCollector

All Known Implementing Classes:

TrafficCollectorImpl

public interface TrafficCollector

Method Summary

Modifier and Type	Method and Description
static TrafficCollectorImpl.Builder	builder(WebDriverFactory webDriverFactory) Returns a new builder instance.
<R> HarPlus<R>	collect(TrafficGenerator<R> generator) Collects traffic generated by the given generator into a HAR.
<R> HarPlus<R>	collect(TrafficGenerator<R> generator, TrafficMonitor monitor) Collects traffic generated by the given generator into a HAR.
<R> R	drive(TrafficGenerator<R> generator) Causes traffic to be generated by the given generator and returns the result.
<R> R	monitor(TrafficGenerator<R> generator, TrafficMonitor monitor) Monitors traffic generated by the given generator.

Method Detail

collect

<R> HarPlus<R> collect(TrafficGenerator<R> generator)
                throws IOException,
                       org.openqa.selenium.WebDriverException

Collects traffic generated by the given generator into a HAR. This invokes collect(TrafficGenerator, TrafficMonitor) with a null monitor reference.

Type Parameters:

R - type of result the generator returns

Parameters:

generator - the generator

Returns:

the HAR containing all traffic generated

Throws:

IOException - if something I/O related goes awry

org.openqa.selenium.WebDriverException - if the web driver could not be created or the generator throws one

collect

<R> HarPlus<R> collect(TrafficGenerator<R> generator,
                       @Nullable
                       TrafficMonitor monitor)
                throws IOException,
                       org.openqa.selenium.WebDriverException

Collects traffic generated by the given generator into a HAR. Notifications of request/response interactions can be sent to the given monitor, optionally.

Type Parameters:

R - type of result the generator returns

Parameters:

generator - the generator

monitor - a monitor, or null

Returns:

the HAR containing all traffic generated

Throws:

IOException - on I/O error

org.openqa.selenium.WebDriverException - if the web driver could not be created or the generator throws one

monitor

<R> R monitor(TrafficGenerator<R> generator,
              TrafficMonitor monitor)
       throws IOException,
              org.openqa.selenium.WebDriverException

Monitors traffic generated by the given generator. This like collect(TrafficGenerator, TrafficMonitor) but without capturing a HAR.

Type Parameters:

R - generator result type

Parameters:

generator - the traffic generator

monitor - the monitor

Returns:

the generator result

Throws:

IOException - on I/O error

org.openqa.selenium.WebDriverException - on webdriver error

drive

<R> R drive(TrafficGenerator<R> generator)
     throws IOException,
            org.openqa.selenium.WebDriverException

Causes traffic to be generated by the given generator and returns the result. This is essentially monitor(TrafficGenerator, TrafficMonitor) without notifying a monitor of request/response interactions.

Type Parameters:

R - generator result type

Parameters:

generator - the traffic generator

Returns:

the generator result

Throws:

IOException - on I/O error

org.openqa.selenium.WebDriverException - on webdriver error

builder

static TrafficCollectorImpl.Builder builder(WebDriverFactory webDriverFactory)

Returns a new builder instance.

Parameters:

webDriverFactory - the webdriver factory

Returns:

a builder