Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.openqa.selenium.devtools.v88.network.Network Maven / Gradle / Ivy
package org.openqa.selenium.devtools.v88.network;
import org.openqa.selenium.Beta;
import org.openqa.selenium.devtools.Command;
import org.openqa.selenium.devtools.Event;
import org.openqa.selenium.devtools.ConverterFunctions;
import com.google.common.collect.ImmutableMap;
import org.openqa.selenium.json.JsonInput;
/**
* 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.
*/
public class Network {
/**
* Tells whether clearing browser cache is supported.
*/
@Deprecated()
public static Command canClearBrowserCache() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Network.canClearBrowserCache", params.build(), ConverterFunctions.map("result", java.lang.Boolean.class));
}
/**
* Tells whether clearing browser cookies is supported.
*/
@Deprecated()
public static Command canClearBrowserCookies() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Network.canClearBrowserCookies", params.build(), ConverterFunctions.map("result", java.lang.Boolean.class));
}
/**
* Tells whether emulation of network conditions is supported.
*/
@Deprecated()
public static Command canEmulateNetworkConditions() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Network.canEmulateNetworkConditions", params.build(), ConverterFunctions.map("result", java.lang.Boolean.class));
}
/**
* Clears browser cache.
*/
public static Command clearBrowserCache() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Network.clearBrowserCache", params.build());
}
/**
* Clears browser cookies.
*/
public static Command clearBrowserCookies() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Network.clearBrowserCookies", params.build());
}
/**
* 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.
* Deprecated, use Fetch.continueRequest, Fetch.fulfillRequest and Fetch.failRequest instead.
*/
@Beta()
@Deprecated()
public static Command continueInterceptedRequest(org.openqa.selenium.devtools.v88.network.model.InterceptionId interceptionId, java.util.Optional errorReason, java.util.Optional rawResponse, java.util.Optional url, java.util.Optional method, java.util.Optional postData, java.util.Optional headers, java.util.Optional authChallengeResponse) {
java.util.Objects.requireNonNull(interceptionId, "interceptionId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("interceptionId", interceptionId);
errorReason.ifPresent(p -> params.put("errorReason", p));
rawResponse.ifPresent(p -> params.put("rawResponse", p));
url.ifPresent(p -> params.put("url", p));
method.ifPresent(p -> params.put("method", p));
postData.ifPresent(p -> params.put("postData", p));
headers.ifPresent(p -> params.put("headers", p));
authChallengeResponse.ifPresent(p -> params.put("authChallengeResponse", p));
return new Command<>("Network.continueInterceptedRequest", params.build());
}
/**
* Deletes browser cookies with matching name and url or domain/path pair.
*/
public static Command deleteCookies(java.lang.String name, java.util.Optional url, java.util.Optional domain, java.util.Optional path) {
java.util.Objects.requireNonNull(name, "name is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("name", name);
url.ifPresent(p -> params.put("url", p));
domain.ifPresent(p -> params.put("domain", p));
path.ifPresent(p -> params.put("path", p));
return new Command<>("Network.deleteCookies", params.build());
}
/**
* Disables network tracking, prevents network events from being sent to the client.
*/
public static Command disable() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Network.disable", params.build());
}
/**
* Activates emulation of network conditions.
*/
public static Command emulateNetworkConditions(java.lang.Boolean offline, java.lang.Number latency, java.lang.Number downloadThroughput, java.lang.Number uploadThroughput, java.util.Optional connectionType) {
java.util.Objects.requireNonNull(offline, "offline is required");
java.util.Objects.requireNonNull(latency, "latency is required");
java.util.Objects.requireNonNull(downloadThroughput, "downloadThroughput is required");
java.util.Objects.requireNonNull(uploadThroughput, "uploadThroughput is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("offline", offline);
params.put("latency", latency);
params.put("downloadThroughput", downloadThroughput);
params.put("uploadThroughput", uploadThroughput);
connectionType.ifPresent(p -> params.put("connectionType", p));
return new Command<>("Network.emulateNetworkConditions", params.build());
}
/**
* Enables network tracking, network events will now be delivered to the client.
*/
public static Command enable(java.util.Optional maxTotalBufferSize, java.util.Optional maxResourceBufferSize, java.util.Optional maxPostDataSize) {
ImmutableMap.Builder params = ImmutableMap.builder();
maxTotalBufferSize.ifPresent(p -> params.put("maxTotalBufferSize", p));
maxResourceBufferSize.ifPresent(p -> params.put("maxResourceBufferSize", p));
maxPostDataSize.ifPresent(p -> params.put("maxPostDataSize", p));
return new Command<>("Network.enable", params.build());
}
/**
* Returns all browser cookies. Depending on the backend support, will return detailed cookie
* information in the `cookies` field.
*/
public static Command> getAllCookies() {
ImmutableMap.Builder params = ImmutableMap.builder();
return new Command<>("Network.getAllCookies", params.build(), ConverterFunctions.map("cookies", new com.google.common.reflect.TypeToken>() {
}.getType()));
}
/**
* Returns the DER-encoded certificate.
*/
@Beta()
public static Command> getCertificate(java.lang.String origin) {
java.util.Objects.requireNonNull(origin, "origin is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("origin", origin);
return new Command<>("Network.getCertificate", params.build(), ConverterFunctions.map("tableNames", new com.google.common.reflect.TypeToken>() {
}.getType()));
}
/**
* Returns all browser cookies for the current URL. Depending on the backend support, will return
* detailed cookie information in the `cookies` field.
*/
public static Command> getCookies(java.util.Optional> urls) {
ImmutableMap.Builder params = ImmutableMap.builder();
urls.ifPresent(p -> params.put("urls", p));
return new Command<>("Network.getCookies", params.build(), ConverterFunctions.map("cookies", new com.google.common.reflect.TypeToken>() {
}.getType()));
}
public static class GetResponseBodyResponse {
private final java.lang.String body;
private final java.lang.Boolean base64Encoded;
public GetResponseBodyResponse(java.lang.String body, java.lang.Boolean base64Encoded) {
this.body = java.util.Objects.requireNonNull(body, "body is required");
this.base64Encoded = java.util.Objects.requireNonNull(base64Encoded, "base64Encoded is required");
}
/**
* Response body.
*/
public java.lang.String getBody() {
return body;
}
/**
* True, if content was sent as base64.
*/
public java.lang.Boolean getBase64Encoded() {
return base64Encoded;
}
private static GetResponseBodyResponse fromJson(JsonInput input) {
java.lang.String body = null;
java.lang.Boolean base64Encoded = false;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "body":
body = input.nextString();
break;
case "base64Encoded":
base64Encoded = input.nextBoolean();
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetResponseBodyResponse(body, base64Encoded);
}
}
/**
* Returns content served for the given request.
*/
public static Command getResponseBody(org.openqa.selenium.devtools.v88.network.model.RequestId requestId) {
java.util.Objects.requireNonNull(requestId, "requestId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("requestId", requestId);
return new Command<>("Network.getResponseBody", params.build(), input -> input.read(org.openqa.selenium.devtools.v88.network.Network.GetResponseBodyResponse.class));
}
/**
* Returns post data sent with the request. Returns an error when no data was sent with the request.
*/
public static Command getRequestPostData(org.openqa.selenium.devtools.v88.network.model.RequestId requestId) {
java.util.Objects.requireNonNull(requestId, "requestId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("requestId", requestId);
return new Command<>("Network.getRequestPostData", params.build(), ConverterFunctions.map("postData", java.lang.String.class));
}
public static class GetResponseBodyForInterceptionResponse {
private final java.lang.String body;
private final java.lang.Boolean base64Encoded;
public GetResponseBodyForInterceptionResponse(java.lang.String body, java.lang.Boolean base64Encoded) {
this.body = java.util.Objects.requireNonNull(body, "body is required");
this.base64Encoded = java.util.Objects.requireNonNull(base64Encoded, "base64Encoded is required");
}
/**
* Response body.
*/
public java.lang.String getBody() {
return body;
}
/**
* True, if content was sent as base64.
*/
public java.lang.Boolean getBase64Encoded() {
return base64Encoded;
}
private static GetResponseBodyForInterceptionResponse fromJson(JsonInput input) {
java.lang.String body = null;
java.lang.Boolean base64Encoded = false;
input.beginObject();
while (input.hasNext()) {
switch(input.nextName()) {
case "body":
body = input.nextString();
break;
case "base64Encoded":
base64Encoded = input.nextBoolean();
break;
default:
input.skipValue();
break;
}
}
input.endObject();
return new GetResponseBodyForInterceptionResponse(body, base64Encoded);
}
}
/**
* Returns content served for the given currently intercepted request.
*/
@Beta()
public static Command getResponseBodyForInterception(org.openqa.selenium.devtools.v88.network.model.InterceptionId interceptionId) {
java.util.Objects.requireNonNull(interceptionId, "interceptionId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("interceptionId", interceptionId);
return new Command<>("Network.getResponseBodyForInterception", params.build(), input -> input.read(org.openqa.selenium.devtools.v88.network.Network.GetResponseBodyForInterceptionResponse.class));
}
/**
* Returns a handle to the stream representing the response body. Note that after this command,
* the intercepted request can't be continued as is -- you either need to cancel it or to provide
* the response body. The stream only supports sequential read, IO.read will fail if the position
* is specified.
*/
@Beta()
public static Command takeResponseBodyForInterceptionAsStream(org.openqa.selenium.devtools.v88.network.model.InterceptionId interceptionId) {
java.util.Objects.requireNonNull(interceptionId, "interceptionId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("interceptionId", interceptionId);
return new Command<>("Network.takeResponseBodyForInterceptionAsStream", params.build(), ConverterFunctions.map("stream", org.openqa.selenium.devtools.v88.io.model.StreamHandle.class));
}
/**
* 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.
*/
@Beta()
public static Command replayXHR(org.openqa.selenium.devtools.v88.network.model.RequestId requestId) {
java.util.Objects.requireNonNull(requestId, "requestId is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("requestId", requestId);
return new Command<>("Network.replayXHR", params.build());
}
/**
* Searches for given string in response content.
*/
@Beta()
public static Command> searchInResponseBody(org.openqa.selenium.devtools.v88.network.model.RequestId requestId, java.lang.String query, java.util.Optional caseSensitive, java.util.Optional isRegex) {
java.util.Objects.requireNonNull(requestId, "requestId is required");
java.util.Objects.requireNonNull(query, "query is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("requestId", requestId);
params.put("query", query);
caseSensitive.ifPresent(p -> params.put("caseSensitive", p));
isRegex.ifPresent(p -> params.put("isRegex", p));
return new Command<>("Network.searchInResponseBody", params.build(), ConverterFunctions.map("result", new com.google.common.reflect.TypeToken>() {
}.getType()));
}
/**
* Blocks URLs from loading.
*/
@Beta()
public static Command setBlockedURLs(java.util.List urls) {
java.util.Objects.requireNonNull(urls, "urls is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("urls", urls);
return new Command<>("Network.setBlockedURLs", params.build());
}
/**
* Toggles ignoring of service worker for each request.
*/
@Beta()
public static Command setBypassServiceWorker(java.lang.Boolean bypass) {
java.util.Objects.requireNonNull(bypass, "bypass is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("bypass", bypass);
return new Command<>("Network.setBypassServiceWorker", params.build());
}
/**
* Toggles ignoring cache for each request. If `true`, cache will not be used.
*/
public static Command setCacheDisabled(java.lang.Boolean cacheDisabled) {
java.util.Objects.requireNonNull(cacheDisabled, "cacheDisabled is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("cacheDisabled", cacheDisabled);
return new Command<>("Network.setCacheDisabled", params.build());
}
/**
* Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
*/
public static Command setCookie(java.lang.String name, java.lang.String value, java.util.Optional url, java.util.Optional domain, java.util.Optional path, java.util.Optional secure, java.util.Optional httpOnly, java.util.Optional sameSite, java.util.Optional expires, java.util.Optional priority) {
java.util.Objects.requireNonNull(name, "name is required");
java.util.Objects.requireNonNull(value, "value is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("name", name);
params.put("value", value);
url.ifPresent(p -> params.put("url", p));
domain.ifPresent(p -> params.put("domain", p));
path.ifPresent(p -> params.put("path", p));
secure.ifPresent(p -> params.put("secure", p));
httpOnly.ifPresent(p -> params.put("httpOnly", p));
sameSite.ifPresent(p -> params.put("sameSite", p));
expires.ifPresent(p -> params.put("expires", p));
priority.ifPresent(p -> params.put("priority", p));
return new Command<>("Network.setCookie", params.build(), ConverterFunctions.map("success", java.lang.Boolean.class));
}
/**
* Sets given cookies.
*/
public static Command setCookies(java.util.List cookies) {
java.util.Objects.requireNonNull(cookies, "cookies is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("cookies", cookies);
return new Command<>("Network.setCookies", params.build());
}
/**
* For testing.
*/
@Beta()
public static Command setDataSizeLimitsForTest(java.lang.Integer maxTotalSize, java.lang.Integer maxResourceSize) {
java.util.Objects.requireNonNull(maxTotalSize, "maxTotalSize is required");
java.util.Objects.requireNonNull(maxResourceSize, "maxResourceSize is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("maxTotalSize", maxTotalSize);
params.put("maxResourceSize", maxResourceSize);
return new Command<>("Network.setDataSizeLimitsForTest", params.build());
}
/**
* Specifies whether to always send extra HTTP headers with the requests from this page.
*/
public static Command setExtraHTTPHeaders(org.openqa.selenium.devtools.v88.network.model.Headers headers) {
java.util.Objects.requireNonNull(headers, "headers is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("headers", headers);
return new Command<>("Network.setExtraHTTPHeaders", params.build());
}
/**
* Specifies whether to attach a page script stack id in requests
*/
@Beta()
public static Command setAttachDebugStack(java.lang.Boolean enabled) {
java.util.Objects.requireNonNull(enabled, "enabled is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("enabled", enabled);
return new Command<>("Network.setAttachDebugStack", params.build());
}
/**
* Sets the requests to intercept that match the provided patterns and optionally resource types.
* Deprecated, please use Fetch.enable instead.
*/
@Beta()
@Deprecated()
public static Command setRequestInterception(java.util.List patterns) {
java.util.Objects.requireNonNull(patterns, "patterns is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("patterns", patterns);
return new Command<>("Network.setRequestInterception", params.build());
}
/**
* Allows overriding user agent with the given string.
*/
public static Command setUserAgentOverride(java.lang.String userAgent, java.util.Optional acceptLanguage, java.util.Optional platform, java.util.Optional userAgentMetadata) {
java.util.Objects.requireNonNull(userAgent, "userAgent is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("userAgent", userAgent);
acceptLanguage.ifPresent(p -> params.put("acceptLanguage", p));
platform.ifPresent(p -> params.put("platform", p));
userAgentMetadata.ifPresent(p -> params.put("userAgentMetadata", p));
return new Command<>("Network.setUserAgentOverride", params.build());
}
/**
* Returns information about the COEP/COOP isolation status.
*/
@Beta()
public static Command getSecurityIsolationStatus(java.util.Optional frameId) {
ImmutableMap.Builder params = ImmutableMap.builder();
frameId.ifPresent(p -> params.put("frameId", p));
return new Command<>("Network.getSecurityIsolationStatus", params.build(), ConverterFunctions.map("status", org.openqa.selenium.devtools.v88.network.model.SecurityIsolationStatus.class));
}
/**
* Fetches the resource and returns the content.
*/
@Beta()
public static Command loadNetworkResource(org.openqa.selenium.devtools.v88.page.model.FrameId frameId, java.lang.String url, org.openqa.selenium.devtools.v88.network.model.LoadNetworkResourceOptions options) {
java.util.Objects.requireNonNull(frameId, "frameId is required");
java.util.Objects.requireNonNull(url, "url is required");
java.util.Objects.requireNonNull(options, "options is required");
ImmutableMap.Builder params = ImmutableMap.builder();
params.put("frameId", frameId);
params.put("url", url);
params.put("options", options);
return new Command<>("Network.loadNetworkResource", params.build(), ConverterFunctions.map("resource", org.openqa.selenium.devtools.v88.network.model.LoadNetworkResourcePageResult.class));
}
public static Event dataReceived() {
return new Event<>("Network.dataReceived", input -> input.read(org.openqa.selenium.devtools.v88.network.model.DataReceived.class));
}
public static Event eventSourceMessageReceived() {
return new Event<>("Network.eventSourceMessageReceived", input -> input.read(org.openqa.selenium.devtools.v88.network.model.EventSourceMessageReceived.class));
}
public static Event loadingFailed() {
return new Event<>("Network.loadingFailed", input -> input.read(org.openqa.selenium.devtools.v88.network.model.LoadingFailed.class));
}
public static Event loadingFinished() {
return new Event<>("Network.loadingFinished", input -> input.read(org.openqa.selenium.devtools.v88.network.model.LoadingFinished.class));
}
public static Event requestIntercepted() {
return new Event<>("Network.requestIntercepted", input -> input.read(org.openqa.selenium.devtools.v88.network.model.RequestIntercepted.class));
}
public static Event requestServedFromCache() {
return new Event<>("Network.requestServedFromCache", ConverterFunctions.map("requestId", org.openqa.selenium.devtools.v88.network.model.RequestId.class));
}
public static Event requestWillBeSent() {
return new Event<>("Network.requestWillBeSent", input -> input.read(org.openqa.selenium.devtools.v88.network.model.RequestWillBeSent.class));
}
public static Event resourceChangedPriority() {
return new Event<>("Network.resourceChangedPriority", input -> input.read(org.openqa.selenium.devtools.v88.network.model.ResourceChangedPriority.class));
}
public static Event signedExchangeReceived() {
return new Event<>("Network.signedExchangeReceived", input -> input.read(org.openqa.selenium.devtools.v88.network.model.SignedExchangeReceived.class));
}
public static Event responseReceived() {
return new Event<>("Network.responseReceived", input -> input.read(org.openqa.selenium.devtools.v88.network.model.ResponseReceived.class));
}
public static Event webSocketClosed() {
return new Event<>("Network.webSocketClosed", input -> input.read(org.openqa.selenium.devtools.v88.network.model.WebSocketClosed.class));
}
public static Event webSocketCreated() {
return new Event<>("Network.webSocketCreated", input -> input.read(org.openqa.selenium.devtools.v88.network.model.WebSocketCreated.class));
}
public static Event webSocketFrameError() {
return new Event<>("Network.webSocketFrameError", input -> input.read(org.openqa.selenium.devtools.v88.network.model.WebSocketFrameError.class));
}
public static Event webSocketFrameReceived() {
return new Event<>("Network.webSocketFrameReceived", input -> input.read(org.openqa.selenium.devtools.v88.network.model.WebSocketFrameReceived.class));
}
public static Event webSocketFrameSent() {
return new Event<>("Network.webSocketFrameSent", input -> input.read(org.openqa.selenium.devtools.v88.network.model.WebSocketFrameSent.class));
}
public static Event webSocketHandshakeResponseReceived() {
return new Event<>("Network.webSocketHandshakeResponseReceived", input -> input.read(org.openqa.selenium.devtools.v88.network.model.WebSocketHandshakeResponseReceived.class));
}
public static Event webSocketWillSendHandshakeRequest() {
return new Event<>("Network.webSocketWillSendHandshakeRequest", input -> input.read(org.openqa.selenium.devtools.v88.network.model.WebSocketWillSendHandshakeRequest.class));
}
public static Event requestWillBeSentExtraInfo() {
return new Event<>("Network.requestWillBeSentExtraInfo", input -> input.read(org.openqa.selenium.devtools.v88.network.model.RequestWillBeSentExtraInfo.class));
}
public static Event responseReceivedExtraInfo() {
return new Event<>("Network.responseReceivedExtraInfo", input -> input.read(org.openqa.selenium.devtools.v88.network.model.ResponseReceivedExtraInfo.class));
}
}
