Package org.openqa.selenium.devtools

Class NetworkInterceptor

java.lang.Object

org.openqa.selenium.devtools.NetworkInterceptor

All Implemented Interfaces:

AutoCloseable

public class NetworkInterceptor
extends Object
implements AutoCloseable

Provides a mechanism for stubbing out responses to requests in drivers which implement HasDevTools. Usage is done by specifying a Route, which will be checked for every request to see if that request should be handled or not. Note that the URLs given to the Route will be fully qualified.

Example usage:

   Route route = Route.matching(req -> GET == req.getMethod() && req.getUri().endsWith("/example"))
     .to(() -> req -> new HttpResponse().setContent(Contents.utf8String("Hello, World!")));

   try (NetworkInterceptor interceptor = new NetworkInterceptor(driver, route)) {
     // Your code here.
   }
 

It is also possible to intercept and modify responses that the browser will receive. Do this by calling NetworkInterceptor(WebDriver, Filter).

Field Summary

Fields

Modifier and Type	Field	Description
static final org.openqa.selenium.remote.http.HttpResponse	PROCEED_WITH_REQUEST	Return this from a Routable in order to have the browser continue the request unmodified.

Constructor Summary

Constructors

Constructor	Description
NetworkInterceptor(org.openqa.selenium.WebDriver driver, org.openqa.selenium.remote.http.Filter filter)
NetworkInterceptor(org.openqa.selenium.WebDriver driver, org.openqa.selenium.remote.http.HttpHandler handler)
NetworkInterceptor(org.openqa.selenium.WebDriver driver, org.openqa.selenium.remote.http.Routable routable)

Method Summary

Modifier and Type	Method	Description
void	close()
protected org.openqa.selenium.remote.http.HttpMethod	convertFromCdpHttpMethod(String method)
protected org.openqa.selenium.remote.http.HttpRequest	createHttpRequest(String cdpMethod, String url, Map<String,Object> headers, Optional<String> postData)

Methods inherited from class java.lang.Object

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

Field Details

PROCEED_WITH_REQUEST

public static final org.openqa.selenium.remote.http.HttpResponse PROCEED_WITH_REQUEST

Return this from a Routable in order to have the browser continue the request unmodified.

Constructor Details

NetworkInterceptor

public NetworkInterceptor(org.openqa.selenium.WebDriver driver,
 org.openqa.selenium.remote.http.HttpHandler handler)

NetworkInterceptor

public NetworkInterceptor(org.openqa.selenium.WebDriver driver,
 org.openqa.selenium.remote.http.Routable routable)

NetworkInterceptor

public NetworkInterceptor(org.openqa.selenium.WebDriver driver,
 org.openqa.selenium.remote.http.Filter filter)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

convertFromCdpHttpMethod

protected org.openqa.selenium.remote.http.HttpMethod convertFromCdpHttpMethod(String method)

createHttpRequest

protected org.openqa.selenium.remote.http.HttpRequest createHttpRequest(String cdpMethod,
 String url,
 Map<String,Object> headers,
 Optional<String> postData)