com.github.kklisura.cdt.protocol.commands.Network Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
package com.github.kklisura.cdt.protocol.commands;
/*-
* #%L
* cdt-java-client
* %%
* Copyright (C) 2018 Kenan Klisura
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import com.github.kklisura.cdt.protocol.events.network.DataReceived;
import com.github.kklisura.cdt.protocol.events.network.EventSourceMessageReceived;
import com.github.kklisura.cdt.protocol.events.network.LoadingFailed;
import com.github.kklisura.cdt.protocol.events.network.LoadingFinished;
import com.github.kklisura.cdt.protocol.events.network.RequestIntercepted;
import com.github.kklisura.cdt.protocol.events.network.RequestServedFromCache;
import com.github.kklisura.cdt.protocol.events.network.RequestWillBeSent;
import com.github.kklisura.cdt.protocol.events.network.ResourceChangedPriority;
import com.github.kklisura.cdt.protocol.events.network.ResponseReceived;
import com.github.kklisura.cdt.protocol.events.network.SignedExchangeReceived;
import com.github.kklisura.cdt.protocol.events.network.WebSocketClosed;
import com.github.kklisura.cdt.protocol.events.network.WebSocketCreated;
import com.github.kklisura.cdt.protocol.events.network.WebSocketFrameError;
import com.github.kklisura.cdt.protocol.events.network.WebSocketFrameReceived;
import com.github.kklisura.cdt.protocol.events.network.WebSocketFrameSent;
import com.github.kklisura.cdt.protocol.events.network.WebSocketHandshakeResponseReceived;
import com.github.kklisura.cdt.protocol.events.network.WebSocketWillSendHandshakeRequest;
import com.github.kklisura.cdt.protocol.support.annotations.EventName;
import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
import com.github.kklisura.cdt.protocol.support.annotations.Optional;
import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
import com.github.kklisura.cdt.protocol.support.annotations.Returns;
import com.github.kklisura.cdt.protocol.support.types.EventHandler;
import com.github.kklisura.cdt.protocol.support.types.EventListener;
import com.github.kklisura.cdt.protocol.types.debugger.SearchMatch;
import com.github.kklisura.cdt.protocol.types.network.AuthChallengeResponse;
import com.github.kklisura.cdt.protocol.types.network.ConnectionType;
import com.github.kklisura.cdt.protocol.types.network.Cookie;
import com.github.kklisura.cdt.protocol.types.network.CookieParam;
import com.github.kklisura.cdt.protocol.types.network.CookieSameSite;
import com.github.kklisura.cdt.protocol.types.network.ErrorReason;
import com.github.kklisura.cdt.protocol.types.network.RequestPattern;
import com.github.kklisura.cdt.protocol.types.network.ResponseBody;
import com.github.kklisura.cdt.protocol.types.network.ResponseBodyForInterception;
import java.util.List;
import java.util.Map;
/**
* 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 interface Network {
/** Tells whether clearing browser cache is supported. */
@Deprecated
@Returns("result")
Boolean canClearBrowserCache();
/** Tells whether clearing browser cookies is supported. */
@Deprecated
@Returns("result")
Boolean canClearBrowserCookies();
/** Tells whether emulation of network conditions is supported. */
@Deprecated
@Returns("result")
Boolean canEmulateNetworkConditions();
/** Clears browser cache. */
void clearBrowserCache();
/** Clears browser cookies. */
void clearBrowserCookies();
/**
* 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.
*
* @param interceptionId
*/
@Experimental
void continueInterceptedRequest(@ParamName("interceptionId") 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.
*
* @param interceptionId
* @param 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.
* @param 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.
* @param 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.
* @param method If set this allows the request method to be overridden. Must not be set in
* response to an authChallenge.
* @param postData If set this allows postData to be set. Must not be set in response to an
* authChallenge.
* @param headers If set this allows the request headers to be changed. Must not be set in
* response to an authChallenge.
* @param authChallengeResponse Response to a requestIntercepted with an authChallenge. Must not
* be set otherwise.
*/
@Experimental
void continueInterceptedRequest(
@ParamName("interceptionId") String interceptionId,
@Optional @ParamName("errorReason") ErrorReason errorReason,
@Optional @ParamName("rawResponse") String rawResponse,
@Optional @ParamName("url") String url,
@Optional @ParamName("method") String method,
@Optional @ParamName("postData") String postData,
@Optional @ParamName("headers") Map headers,
@Optional @ParamName("authChallengeResponse") AuthChallengeResponse authChallengeResponse);
/**
* Deletes browser cookies with matching name and url or domain/path pair.
*
* @param name Name of the cookies to remove.
*/
void deleteCookies(@ParamName("name") String name);
/**
* Deletes browser cookies with matching name and url or domain/path pair.
*
* @param name Name of the cookies to remove.
* @param url If specified, deletes all the cookies with the given name where domain and path
* match provided URL.
* @param domain If specified, deletes only cookies with the exact domain.
* @param path If specified, deletes only cookies with the exact path.
*/
void deleteCookies(
@ParamName("name") String name,
@Optional @ParamName("url") String url,
@Optional @ParamName("domain") String domain,
@Optional @ParamName("path") String path);
/** Disables network tracking, prevents network events from being sent to the client. */
void disable();
/**
* Activates emulation of network conditions.
*
* @param offline True to emulate internet disconnection.
* @param latency Minimum latency from request sent to response headers received (ms).
* @param downloadThroughput Maximal aggregated download throughput (bytes/sec). -1 disables
* download throttling.
* @param uploadThroughput Maximal aggregated upload throughput (bytes/sec). -1 disables upload
* throttling.
*/
void emulateNetworkConditions(
@ParamName("offline") Boolean offline,
@ParamName("latency") Double latency,
@ParamName("downloadThroughput") Double downloadThroughput,
@ParamName("uploadThroughput") Double uploadThroughput);
/**
* Activates emulation of network conditions.
*
* @param offline True to emulate internet disconnection.
* @param latency Minimum latency from request sent to response headers received (ms).
* @param downloadThroughput Maximal aggregated download throughput (bytes/sec). -1 disables
* download throttling.
* @param uploadThroughput Maximal aggregated upload throughput (bytes/sec). -1 disables upload
* throttling.
* @param connectionType Connection type if known.
*/
void emulateNetworkConditions(
@ParamName("offline") Boolean offline,
@ParamName("latency") Double latency,
@ParamName("downloadThroughput") Double downloadThroughput,
@ParamName("uploadThroughput") Double uploadThroughput,
@Optional @ParamName("connectionType") ConnectionType connectionType);
/** Enables network tracking, network events will now be delivered to the client. */
void enable();
/**
* Enables network tracking, network events will now be delivered to the client.
*
* @param maxTotalBufferSize Buffer size in bytes to use when preserving network payloads (XHRs,
* etc).
* @param maxResourceBufferSize Per-resource buffer size in bytes to use when preserving network
* payloads (XHRs, etc).
* @param maxPostDataSize Longest post body size (in bytes) that would be included in
* requestWillBeSent notification
*/
void enable(
@Experimental @Optional @ParamName("maxTotalBufferSize") Integer maxTotalBufferSize,
@Experimental @Optional @ParamName("maxResourceBufferSize") Integer maxResourceBufferSize,
@Optional @ParamName("maxPostDataSize") Integer maxPostDataSize);
/**
* Returns all browser cookies. Depending on the backend support, will return detailed cookie
* information in the `cookies` field.
*/
@Returns("cookies")
List getAllCookies();
/**
* Returns the DER-encoded certificate.
*
* @param origin Origin to get certificate for.
*/
@Experimental
@Returns("tableNames")
List getCertificate(@ParamName("origin") String origin);
/**
* Returns all browser cookies for the current URL. Depending on the backend support, will return
* detailed cookie information in the `cookies` field.
*/
@Returns("cookies")
List getCookies();
/**
* Returns all browser cookies for the current URL. Depending on the backend support, will return
* detailed cookie information in the `cookies` field.
*
* @param urls The list of URLs for which applicable cookies will be fetched
*/
@Returns("cookies")
List getCookies(@Optional @ParamName("urls") List urls);
/**
* Returns content served for the given request.
*
* @param requestId Identifier of the network request to get content for.
*/
ResponseBody getResponseBody(@ParamName("requestId") String requestId);
/**
* Returns post data sent with the request. Returns an error when no data was sent with the
* request.
*
* @param requestId Identifier of the network request to get content for.
*/
@Returns("postData")
String getRequestPostData(@ParamName("requestId") String requestId);
/**
* Returns content served for the given currently intercepted request.
*
* @param interceptionId Identifier for the intercepted request to get body for.
*/
@Experimental
ResponseBodyForInterception getResponseBodyForInterception(
@ParamName("interceptionId") String interceptionId);
/**
* 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.
*
* @param interceptionId
*/
@Experimental
@Returns("stream")
String takeResponseBodyForInterceptionAsStream(
@ParamName("interceptionId") String interceptionId);
/**
* 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.
*
* @param requestId Identifier of XHR to replay.
*/
@Experimental
void replayXHR(@ParamName("requestId") String requestId);
/**
* Searches for given string in response content.
*
* @param requestId Identifier of the network response to search.
* @param query String to search for.
*/
@Experimental
@Returns("result")
List searchInResponseBody(
@ParamName("requestId") String requestId, @ParamName("query") String query);
/**
* Searches for given string in response content.
*
* @param requestId Identifier of the network response to search.
* @param query String to search for.
* @param caseSensitive If true, search is case sensitive.
* @param isRegex If true, treats string parameter as regex.
*/
@Experimental
@Returns("result")
List searchInResponseBody(
@ParamName("requestId") String requestId,
@ParamName("query") String query,
@Optional @ParamName("caseSensitive") Boolean caseSensitive,
@Optional @ParamName("isRegex") Boolean isRegex);
/**
* Blocks URLs from loading.
*
* @param urls URL patterns to block. Wildcards ('*') are allowed.
*/
@Experimental
void setBlockedURLs(@ParamName("urls") List urls);
/**
* Toggles ignoring of service worker for each request.
*
* @param bypass Bypass service worker and load from network.
*/
@Experimental
void setBypassServiceWorker(@ParamName("bypass") Boolean bypass);
/**
* Toggles ignoring cache for each request. If `true`, cache will not be used.
*
* @param cacheDisabled Cache disabled state.
*/
void setCacheDisabled(@ParamName("cacheDisabled") Boolean cacheDisabled);
/**
* Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
*
* @param name Cookie name.
* @param value Cookie value.
*/
@Returns("success")
Boolean setCookie(@ParamName("name") String name, @ParamName("value") String value);
/**
* Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
*
* @param name Cookie name.
* @param value Cookie value.
* @param 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.
* @param domain Cookie domain.
* @param path Cookie path.
* @param secure True if cookie is secure.
* @param httpOnly True if cookie is http-only.
* @param sameSite Cookie SameSite type.
* @param expires Cookie expiration date, session cookie if not set
*/
@Returns("success")
Boolean setCookie(
@ParamName("name") String name,
@ParamName("value") String value,
@Optional @ParamName("url") String url,
@Optional @ParamName("domain") String domain,
@Optional @ParamName("path") String path,
@Optional @ParamName("secure") Boolean secure,
@Optional @ParamName("httpOnly") Boolean httpOnly,
@Optional @ParamName("sameSite") CookieSameSite sameSite,
@Optional @ParamName("expires") Double expires);
/**
* Sets given cookies.
*
* @param cookies Cookies to be set.
*/
void setCookies(@ParamName("cookies") List cookies);
/**
* For testing.
*
* @param maxTotalSize Maximum total buffer size.
* @param maxResourceSize Maximum per-resource size.
*/
@Experimental
void setDataSizeLimitsForTest(
@ParamName("maxTotalSize") Integer maxTotalSize,
@ParamName("maxResourceSize") Integer maxResourceSize);
/**
* Specifies whether to always send extra HTTP headers with the requests from this page.
*
* @param headers Map with extra HTTP headers.
*/
void setExtraHTTPHeaders(@ParamName("headers") Map headers);
/**
* Sets the requests to intercept that match a the provided patterns and optionally resource
* types.
*
* @param patterns Requests matching any of these patterns will be forwarded and wait for the
* corresponding continueInterceptedRequest call.
*/
@Experimental
void setRequestInterception(@ParamName("patterns") List patterns);
/** Fired when data chunk was received over the network. */
@EventName("dataReceived")
EventListener onDataReceived(EventHandler eventListener);
/** Fired when EventSource message is received. */
@EventName("eventSourceMessageReceived")
EventListener onEventSourceMessageReceived(
EventHandler eventListener);
/** Fired when HTTP request has failed to load. */
@EventName("loadingFailed")
EventListener onLoadingFailed(EventHandler eventListener);
/** Fired when HTTP request has finished loading. */
@EventName("loadingFinished")
EventListener onLoadingFinished(EventHandler eventListener);
/**
* Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
* mocked.
*/
@EventName("requestIntercepted")
@Experimental
EventListener onRequestIntercepted(EventHandler eventListener);
/** Fired if request ended up loading from cache. */
@EventName("requestServedFromCache")
EventListener onRequestServedFromCache(EventHandler eventListener);
/** Fired when page is about to send HTTP request. */
@EventName("requestWillBeSent")
EventListener onRequestWillBeSent(EventHandler eventListener);
/** Fired when resource loading priority is changed */
@EventName("resourceChangedPriority")
@Experimental
EventListener onResourceChangedPriority(EventHandler eventListener);
/** Fired when a signed exchange was received over the network */
@EventName("signedExchangeReceived")
@Experimental
EventListener onSignedExchangeReceived(EventHandler eventListener);
/** Fired when HTTP response is available. */
@EventName("responseReceived")
EventListener onResponseReceived(EventHandler eventListener);
/** Fired when WebSocket is closed. */
@EventName("webSocketClosed")
EventListener onWebSocketClosed(EventHandler eventListener);
/** Fired upon WebSocket creation. */
@EventName("webSocketCreated")
EventListener onWebSocketCreated(EventHandler eventListener);
/** Fired when WebSocket frame error occurs. */
@EventName("webSocketFrameError")
EventListener onWebSocketFrameError(EventHandler eventListener);
/** Fired when WebSocket frame is received. */
@EventName("webSocketFrameReceived")
EventListener onWebSocketFrameReceived(EventHandler eventListener);
/** Fired when WebSocket frame is sent. */
@EventName("webSocketFrameSent")
EventListener onWebSocketFrameSent(EventHandler eventListener);
/** Fired when WebSocket handshake response becomes available. */
@EventName("webSocketHandshakeResponseReceived")
EventListener onWebSocketHandshakeResponseReceived(
EventHandler eventListener);
/** Fired when WebSocket is about to initiate handshake. */
@EventName("webSocketWillSendHandshakeRequest")
EventListener onWebSocketWillSendHandshakeRequest(
EventHandler eventListener);
}