io.webfolder.cdp.command

Interface Network

public interface Network

Network domain allows tracking network activities of the page It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc

Method Summary

Modifier and Type	Method and Description
Boolean	canClearBrowserCache() Tells whether clearing browser cache is supported.
Boolean	canClearBrowserCookies() Tells whether clearing browser cookies is supported.
Boolean	canEmulateNetworkConditions() Tells whether emulation of network conditions is supported.
void	clearBrowserCache() Clears browser cache.
void	clearBrowserCookies() Clears browser cookies.
void	continueInterceptedRequest(String interceptionId) Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes.
void	continueInterceptedRequest(String interceptionId, ErrorReason errorReason, String rawResponse, String url, String method, String postData, Map<String,Object> headers, AuthChallengeResponse authChallengeResponse) Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes.
void	deleteCookies(String name) Deletes browser cookies with matching name and url or domain/path pair.
void	deleteCookies(String name, String url, String domain, String path) Deletes browser cookies with matching name and url or domain/path pair.
void	disable() Disables network tracking, prevents network events from being sent to the client.
void	emulateNetworkConditions(Boolean offline, Double latency, Double downloadThroughput, Double uploadThroughput) Activates emulation of network conditions.
void	emulateNetworkConditions(Boolean offline, Double latency, Double downloadThroughput, Double uploadThroughput, ConnectionType connectionType) Activates emulation of network conditions.
void	enable() Enables network tracking, network events will now be delivered to the client.
void	enable(Integer maxTotalBufferSize, Integer maxResourceBufferSize) Enables network tracking, network events will now be delivered to the client.
List<Cookie>	getAllCookies() Returns all browser cookies.
List<String>	getCertificate(String origin) Returns the DER-encoded certificate.
List<Cookie>	getCookies() Returns all browser cookies for the current URL.
List<Cookie>	getCookies(List<String> urls) Returns all browser cookies for the current URL.
GetResponseBodyResult	getResponseBody(String requestId) Returns content served for the given request.
void	replayXHR(String requestId) This method sends a new XMLHttpRequest which is identical to the original one.
void	setBlockedURLs(List<String> urls) Blocks URLs from loading.
void	setBypassServiceWorker(Boolean bypass) Toggles ignoring of service worker for each request.
void	setCacheDisabled(Boolean cacheDisabled) Toggles ignoring cache for each request.
Boolean	setCookie(String name, String value) Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
Boolean	setCookie(String name, String value, String url, String domain, String path, Boolean secure, Boolean httpOnly, CookieSameSite sameSite, Double expires) Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
void	setCookies(List<CookieParam> cookies) Sets given cookies.
void	setDataSizeLimitsForTest(Integer maxTotalSize, Integer maxResourceSize) For testing.
void	setExtraHTTPHeaders(Map<String,Object> headers) Specifies whether to always send extra HTTP headers with the requests from this page.
void	setRequestInterception(List<RequestPattern> patterns) Sets the requests to intercept that match a the provided patterns and optionally resource types.
void	setUserAgentOverride(String userAgent) Allows overriding user agent with the given string.

Method Detail

enable

void enable(Integer maxTotalBufferSize,
            Integer maxResourceBufferSize)

Enables network tracking, network events will now be delivered to the client.

Parameters:

maxTotalBufferSize - Buffer size in bytes to use when preserving network payloads (XHRs, etc).

maxResourceBufferSize - Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).

disable

void disable()

Disables network tracking, prevents network events from being sent to the client.

setUserAgentOverride

void setUserAgentOverride(String userAgent)

Allows overriding user agent with the given string.

Parameters:

userAgent - User agent to use.

setExtraHTTPHeaders

void setExtraHTTPHeaders(Map<String,Object> headers)

Specifies whether to always send extra HTTP headers with the requests from this page.

Parameters:

headers - Map with extra HTTP headers.

getResponseBody

GetResponseBodyResult getResponseBody(String requestId)

Returns content served for the given request.

Parameters:

requestId - Identifier of the network request to get content for.

Returns:

GetResponseBodyResult

setBlockedURLs

void setBlockedURLs(List<String> urls)

Blocks URLs from loading.

Parameters:

urls - URL patterns to block. Wildcards ('*') are allowed.

replayXHR

void replayXHR(String requestId)

This method sends a new XMLHttpRequest which is identical to the original one. The following parameters should be identical: method, url, async, request body, extra headers, withCredentials attribute, user, password.

Parameters:

requestId - Identifier of XHR to replay.

canClearBrowserCache

Boolean canClearBrowserCache()

Tells whether clearing browser cache is supported.

Returns:

True if browser cache can be cleared.

clearBrowserCache

void clearBrowserCache()

Clears browser cache.

canClearBrowserCookies

Boolean canClearBrowserCookies()

Tells whether clearing browser cookies is supported.

Returns:

True if browser cookies can be cleared.

clearBrowserCookies

void clearBrowserCookies()

Clears browser cookies.

getCookies

List<Cookie> getCookies(List<String> urls)

Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the cookies field.

Parameters:

urls - The list of URLs for which applicable cookies will be fetched

Returns:

Array of cookie objects.

getAllCookies

List<Cookie> getAllCookies()

Returns all browser cookies. Depending on the backend support, will return detailed cookie information in the cookies field.

Returns:

Array of cookie objects.

deleteCookies

void deleteCookies(String name,
                   String url,
                   String domain,
                   String path)

Deletes browser cookies with matching name and url or domain/path pair.

Parameters:

name - Name of the cookies to remove.

url - If specified, deletes all the cookies with the given name where domain and path match provided URL.

domain - If specified, deletes only cookies with the exact domain.

path - If specified, deletes only cookies with the exact path.

setCookie

Boolean setCookie(String name,
                  String value,
                  String url,
                  String domain,
                  String path,
                  Boolean secure,
                  Boolean httpOnly,
                  CookieSameSite sameSite,
                  Double expires)

Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

Parameters:

name - Cookie name.

value - Cookie value.

url - The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie.

domain - Cookie domain.

path - Cookie path.

secure - True if cookie is secure.

httpOnly - True if cookie is http-only.

sameSite - Cookie SameSite type.

expires - Cookie expiration date, session cookie if not set

Returns:

True if successfully set cookie.

setCookies

void setCookies(List<CookieParam> cookies)

Sets given cookies.

Parameters:

cookies - Cookies to be set.

canEmulateNetworkConditions

Boolean canEmulateNetworkConditions()

Tells whether emulation of network conditions is supported.

Returns:

True if emulation of network conditions is supported.

emulateNetworkConditions

void emulateNetworkConditions(Boolean offline,
                              Double latency,
                              Double downloadThroughput,
                              Double uploadThroughput,
                              ConnectionType connectionType)

Activates emulation of network conditions.

Parameters:

offline - True to emulate internet disconnection.

latency - Minimum latency from request sent to response headers received (ms).

downloadThroughput - Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.

uploadThroughput - Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.

connectionType - Connection type if known.

setCacheDisabled

void setCacheDisabled(Boolean cacheDisabled)

Toggles ignoring cache for each request. If true, cache will not be used.

Parameters:

cacheDisabled - Cache disabled state.

setBypassServiceWorker

void setBypassServiceWorker(Boolean bypass)

Toggles ignoring of service worker for each request.

Parameters:

bypass - Bypass service worker and load from network.

setDataSizeLimitsForTest

void setDataSizeLimitsForTest(Integer maxTotalSize,
                              Integer maxResourceSize)

For testing.

Parameters:

maxTotalSize - Maximum total buffer size.

maxResourceSize - Maximum per-resource size.

getCertificate

List<String> getCertificate(String origin)

Returns the DER-encoded certificate.

Parameters:

origin - Origin to get certificate for.

setRequestInterception

void setRequestInterception(List<RequestPattern> patterns)

Sets the requests to intercept that match a the provided patterns and optionally resource types.

Parameters:

patterns - Requests matching any of these patterns will be forwarded and wait for the corresponding continueInterceptedRequest call.

continueInterceptedRequest

void continueInterceptedRequest(String interceptionId,
                                ErrorReason errorReason,
                                String rawResponse,
                                String url,
                                String method,
                                String postData,
                                Map<String,Object> headers,
                                AuthChallengeResponse authChallengeResponse)

Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes. If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId.

Parameters:

errorReason - If set this causes the request to fail with the given reason. Passing Aborted for requests marked with isNavigationRequest also cancels the navigation. Must not be set in response to an authChallenge.

rawResponse - If set the requests completes using with the provided base64 encoded raw response, including HTTP status line and headers etc... Must not be set in response to an authChallenge.

url - If set the request url will be modified in a way that's not observable by page. Must not be set in response to an authChallenge.

method - If set this allows the request method to be overridden. Must not be set in response to an authChallenge.

postData - If set this allows postData to be set. Must not be set in response to an authChallenge.

headers - If set this allows the request headers to be changed. Must not be set in response to an authChallenge.

authChallengeResponse - Response to a requestIntercepted with an authChallenge. Must not be set otherwise.

enable

void enable()

Enables network tracking, network events will now be delivered to the client.

getCookies

List<Cookie> getCookies()

Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the cookies field.

Returns:

Array of cookie objects.

deleteCookies

void deleteCookies(String name)

Deletes browser cookies with matching name and url or domain/path pair.

Parameters:

name - Name of the cookies to remove.

setCookie

Boolean setCookie(String name,
                  String value)

Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

Parameters:

name - Cookie name.

value - Cookie value.

Returns:

True if successfully set cookie.

emulateNetworkConditions

void emulateNetworkConditions(Boolean offline,
                              Double latency,
                              Double downloadThroughput,
                              Double uploadThroughput)

Activates emulation of network conditions.

Parameters:

offline - True to emulate internet disconnection.

latency - Minimum latency from request sent to response headers received (ms).

downloadThroughput - Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.

uploadThroughput - Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.

continueInterceptedRequest

void continueInterceptedRequest(String interceptionId)

Response to Network.requestIntercepted which either modifies the request to continue with any modifications, or blocks it, or completes it with the provided response bytes. If a network fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted event will be sent with the same InterceptionId.