Package org.openqa.selenium.devtools.fetch

Class Fetch

java.lang.Object

org.openqa.selenium.devtools.fetch.Fetch

@Beta
public class Fetch
extends java.lang.Object

A domain for letting clients substitute browser's network layer with client code.

Constructor Summary

Constructors

Constructor	Description
Fetch()

Method Summary

Modifier and Type	Method	Description
static Event<AuthRequired>	authRequired()	Issued when the domain is enabled with handleAuthRequests set to true.
static Command<java.lang.Void>	continueRequest(RequestId requestId, java.util.Optional<java.lang.String> url, java.util.Optional<java.lang.String> method, java.util.Optional<java.lang.String> postData, java.util.Optional<java.util.List<HeaderEntry>> headers)	Continues the request, optionally modifying some of its parameters.
static Command<java.lang.Void>	continueWithAuth(RequestId requestId, AuthChallengeResponse authChallengeResponse)	Continues a request supplying authChallengeResponse following authRequired event.
static Command<java.lang.Void>	disable()	Disables the fetch domain.
static Command<java.lang.Void>	enable(java.util.Optional<java.util.List<RequestPattern>> patterns, java.util.Optional<java.lang.Boolean> handleAuthRequests)	Disables the fetch domain.
static Command<java.lang.Void>	failRequest(RequestId requestId, ErrorReason errorReason)	Causes the request to fail with specified reason.
static Command<java.lang.Void>	fulfillRequest(RequestId requestId, int responseCode, java.util.List<HeaderEntry> responseHeaders, java.util.Optional<java.lang.String> body, java.util.Optional<java.lang.String> responsePhrase)	Provides response to the request.
static Command<ResponseBody>	getResponseBody(RequestId requestId)	Causes the body of the response to be received from the server and returned as a single string.
static Event<RequestPaused>	requestPaused()	Issued when the domain is enabled and the request URL matches the specified filter.
static Command<StreamHandle>	takeResponseBodyAsStream(RequestId requestId)	Returns a handle to the stream representing the response body.

Methods inherited from class java.lang.Object

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

Constructor Detail

Fetch

public Fetch()

Method Detail

disable

public static Command<java.lang.Void> disable()

Disables the fetch domain.

enable

public static Command<java.lang.Void> enable(java.util.Optional<java.util.List<RequestPattern>> patterns,
                                             java.util.Optional<java.lang.Boolean> handleAuthRequests)

Disables the fetch domain.

failRequest

public static Command<java.lang.Void> failRequest(RequestId requestId,
                                                  ErrorReason errorReason)

Causes the request to fail with specified reason.

fulfillRequest

public static Command<java.lang.Void> fulfillRequest(RequestId requestId,
                                                     int responseCode,
                                                     java.util.List<HeaderEntry> responseHeaders,
                                                     java.util.Optional<java.lang.String> body,
                                                     java.util.Optional<java.lang.String> responsePhrase)

Provides response to the request.

continueRequest

public static Command<java.lang.Void> continueRequest(RequestId requestId,
                                                      java.util.Optional<java.lang.String> url,
                                                      java.util.Optional<java.lang.String> method,
                                                      java.util.Optional<java.lang.String> postData,
                                                      java.util.Optional<java.util.List<HeaderEntry>> headers)

Continues the request, optionally modifying some of its parameters.

continueWithAuth

public static Command<java.lang.Void> continueWithAuth(RequestId requestId,
                                                       AuthChallengeResponse authChallengeResponse)

Continues a request supplying authChallengeResponse following authRequired event.

getResponseBody

public static Command<ResponseBody> getResponseBody(RequestId requestId)

Causes the body of the response to be received from the server and returned as a single string. May only be issued for a request that is paused in the Response stage and is mutually exclusive with takeResponseBodyForInterceptionAsStream. Calling other methods that affect the request or disabling fetch domain before body is received results in an undefined behavior.

takeResponseBodyAsStream

public static Command<StreamHandle> takeResponseBodyAsStream(RequestId requestId)

Returns a handle to the stream representing the response body. The request must be paused in the HeadersReceived stage. Note that after this command the request can't be continued as is -- client either needs to cancel it or to provide the response body. The stream only supports sequential read, IO.read will fail if the position is specified. This method is mutually exclusive with getResponseBody. Calling other methods that affect the request or disabling fetch domain before body is received results in an undefined behavior.

requestPaused

public static Event<RequestPaused> requestPaused()

Issued when the domain is enabled and the request URL matches the specified filter. The request is paused until the client responds with one of continueRequest, failRequest or fulfillRequest. The stage of the request can be determined by presence of responseErrorReason and responseStatusCode -- the request is at the response stage if either of these fields is present and in the request stage otherwise.

authRequired

public static Event<AuthRequired> authRequired()

Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth.