com.github.mike10004.seleniumhelp

Class TrafficCollectorImpl

java.lang.Object

com.github.mike10004.seleniumhelp.TrafficCollectorImpl

All Implemented Interfaces:

TrafficCollector

@Beta
public class TrafficCollectorImpl
extends Object
implements TrafficCollector

Implementation of a traffic collector. Warning: this may become package-private or be renamed in a future release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrafficCollectorImpl.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TrafficCollectorImpl(TrafficCollectorImpl.Builder builder) Constructs an instance of the class from the given builder.
protected	TrafficCollectorImpl(WebDriverFactory webDriverFactory, net.lightbody.bmp.mitm.CertificateAndKeySource certificateAndKeySource, Supplier<InetSocketAddress> upstreamProxyProvider, Iterable<? extends org.littleshoot.proxy.HttpFiltersSource> httpFiltersSources, Supplier<? extends net.lightbody.bmp.BrowserMobProxy> interceptingProxyInstantiator, Iterable<? extends HarPostProcessor> harPostProcessors, ExceptionReactor exceptionReactor) Constructs an instance of the class.

Method Summary

Modifier and Type	Method and Description
<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.
protected void	configureProxy(net.lightbody.bmp.BrowserMobProxy bmp, net.lightbody.bmp.mitm.CertificateAndKeySource certificateAndKeySource, TrafficMonitor trafficMonitor)
protected org.littleshoot.proxy.MitmManager	createMitmManager(net.lightbody.bmp.BrowserMobProxy proxy, net.lightbody.bmp.mitm.CertificateAndKeySource certificateAndKeySource)
<R> R	drive(TrafficGenerator<R> generator) Causes traffic to be generated by the given generator and returns the result.
protected Set<net.lightbody.bmp.proxy.CaptureType>	getCaptureTypes()
protected net.lightbody.bmp.BrowserMobProxy	instantiateProxy()
<R> R	monitor(TrafficGenerator<R> generator, TrafficMonitor monitor) Monitors traffic generated by the given generator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.mike10004.seleniumhelp.TrafficCollector

builder

Constructor Detail

TrafficCollectorImpl

protected TrafficCollectorImpl(WebDriverFactory webDriverFactory,
                               @Nullable
                               net.lightbody.bmp.mitm.CertificateAndKeySource certificateAndKeySource,
                               Supplier<InetSocketAddress> upstreamProxyProvider,
                               Iterable<? extends org.littleshoot.proxy.HttpFiltersSource> httpFiltersSources,
                               Supplier<? extends net.lightbody.bmp.BrowserMobProxy> interceptingProxyInstantiator,
                               Iterable<? extends HarPostProcessor> harPostProcessors,
                               ExceptionReactor exceptionReactor)

Constructs an instance of the class. Should only be used by subclasses that know what they're doing. Otherwise, use TrafficCollector.builder(WebDriverFactory) to create an instance.

Parameters:

webDriverFactory - web driver factory to use

certificateAndKeySource - credential source

upstreamProxyProvider - upstream proxy provider; can supply null if no upstream proxy is to be used

httpFiltersSources - list of filters sources; this should probably include AnonymizingFiltersSource

interceptingProxyInstantiator - supplier that constructs the local proxy instance

harPostProcessors - list of HAR post-processors

exceptionReactor - exception reactor

TrafficCollectorImpl

protected TrafficCollectorImpl(TrafficCollectorImpl.Builder builder)

Constructs an instance of the class from the given builder.

Parameters:

builder - the builder

Method Detail

getCaptureTypes

protected Set<net.lightbody.bmp.proxy.CaptureType> getCaptureTypes()

collect

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

Description copied from interface: TrafficCollector

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

Specified by:

collect in interface TrafficCollector

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

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

Description copied from interface: TrafficCollector

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

Specified by:

collect in interface TrafficCollector

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

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

Description copied from interface: TrafficCollector

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

Specified by:

monitor in interface TrafficCollector

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

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

Description copied from interface: TrafficCollector

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

Specified by:

drive in interface TrafficCollector

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

createMitmManager

protected org.littleshoot.proxy.MitmManager createMitmManager(net.lightbody.bmp.BrowserMobProxy proxy,
                                                              net.lightbody.bmp.mitm.CertificateAndKeySource certificateAndKeySource)

instantiateProxy

protected net.lightbody.bmp.BrowserMobProxy instantiateProxy()

configureProxy

protected void configureProxy(net.lightbody.bmp.BrowserMobProxy bmp,
                              net.lightbody.bmp.mitm.CertificateAndKeySource certificateAndKeySource,
                              @Nullable
                              TrafficMonitor trafficMonitor)