Package org.openqa.selenium.devtools.v112.fetch

Class Fetch

  • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static org.openqa.selenium.devtools.Event<AuthRequired> authRequired()  
      static org.openqa.selenium.devtools.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, java.util.Optional<java.lang.Boolean> interceptResponse)
      Continues the request, optionally modifying some of its parameters.
      static org.openqa.selenium.devtools.Command<java.lang.Void> continueResponse​(RequestId requestId, java.util.Optional<java.lang.Integer> responseCode, java.util.Optional<java.lang.String> responsePhrase, java.util.Optional<java.util.List<HeaderEntry>> responseHeaders, java.util.Optional<java.lang.String> binaryResponseHeaders)
      Continues loading of the paused response, optionally modifying the response headers.
      static org.openqa.selenium.devtools.Command<java.lang.Void> continueWithAuth​(RequestId requestId, AuthChallengeResponse authChallengeResponse)
      Continues a request supplying authChallengeResponse following authRequired event.
      static org.openqa.selenium.devtools.Command<java.lang.Void> disable()
      Disables the fetch domain.
      static org.openqa.selenium.devtools.Command<java.lang.Void> enable​(java.util.Optional<java.util.List<RequestPattern>> patterns, java.util.Optional<java.lang.Boolean> handleAuthRequests)
      Enables issuing of requestPaused events.
      static org.openqa.selenium.devtools.Command<java.lang.Void> failRequest​(RequestId requestId, ErrorReason errorReason)
      Causes the request to fail with specified reason.
      static org.openqa.selenium.devtools.Command<java.lang.Void> fulfillRequest​(RequestId requestId, java.lang.Integer responseCode, java.util.Optional<java.util.List<HeaderEntry>> responseHeaders, java.util.Optional<java.lang.String> binaryResponseHeaders, java.util.Optional<java.lang.String> body, java.util.Optional<java.lang.String> responsePhrase)
      Provides response to the request.
      static org.openqa.selenium.devtools.Command<Fetch.GetResponseBodyResponse> getResponseBody​(RequestId requestId)
      Causes the body of the response to be received from the server and returned as a single string.
      static org.openqa.selenium.devtools.Event<RequestPaused> requestPaused()  
      static org.openqa.selenium.devtools.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 org.openqa.selenium.devtools.Command<java.lang.Void> disable()
        Disables the fetch domain.

      • enable

        public static org.openqa.selenium.devtools.Command<java.lang.Void> enable​(java.util.Optional<java.util.List<RequestPattern>> patterns,
                                                                          java.util.Optional<java.lang.Boolean> handleAuthRequests)
        Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.

      • failRequest

        public static org.openqa.selenium.devtools.Command<java.lang.Void> failRequest​(RequestId requestId,
                                                                               ErrorReason errorReason)
        Causes the request to fail with specified reason.

      • fulfillRequest

        public static org.openqa.selenium.devtools.Command<java.lang.Void> fulfillRequest​(RequestId requestId,
                                                                                  java.lang.Integer responseCode,
                                                                                  java.util.Optional<java.util.List<HeaderEntry>> responseHeaders,
                                                                                  java.util.Optional<java.lang.String> binaryResponseHeaders,
                                                                                  java.util.Optional<java.lang.String> body,
                                                                                  java.util.Optional<java.lang.String> responsePhrase)
        Provides response to the request.

      • continueRequest

        public static org.openqa.selenium.devtools.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,
                                                                                   java.util.Optional<java.lang.Boolean> interceptResponse)
        Continues the request, optionally modifying some of its parameters.

      • continueWithAuth

        public static org.openqa.selenium.devtools.Command<java.lang.Void> continueWithAuth​(RequestId requestId,
                                                                                    AuthChallengeResponse authChallengeResponse)
        Continues a request supplying authChallengeResponse following authRequired event.

      • continueResponse

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> continueResponse​(RequestId requestId,
                                                                                    java.util.Optional<java.lang.Integer> responseCode,
                                                                                    java.util.Optional<java.lang.String> responsePhrase,
                                                                                    java.util.Optional<java.util.List<HeaderEntry>> responseHeaders,
                                                                                    java.util.Optional<java.lang.String> binaryResponseHeaders)
        Continues loading of the paused response, optionally modifying the response headers. If either responseCode or headers are modified, all of them must be present.

      • getResponseBody

        public static org.openqa.selenium.devtools.Command<Fetch.GetResponseBodyResponse> 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 org.openqa.selenium.devtools.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 org.openqa.selenium.devtools.Event<RequestPaused> requestPaused()

      • authRequired

        public static org.openqa.selenium.devtools.Event<AuthRequired> authRequired()