java.lang.Object
- Torello.Browser.Fetch

```
public class Fetch
extends java.lang.Object
```
Class created by Automatic Code-Generator.
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

JSON-Viewable Google-API:
These files may be viewed here: browser_protocol.json and js_protocol.json.
These files were converted into this Java-Browser (CDT) Library; they are a Java-Alternative to the Node.js implementation.

HTML-Viewable API:
In addition to this Class-Library, these files were also converted to a simple HTML Page, which may be browsed here: Browser API Web-Page

Node.js RDP-API Implementation:
You may read about the Node.js Chrome Remote Interface on the Node.js Package Manager Web-Site: NPM
A domain for letting clients substitute browser's network layer with client code.
This class is intended to be used with a Headless Browser
These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. The initializations may be accomplished using class BRDPC (Browser Remote Debug Protocol Connection).

Google-Chrome was used during the development process of the classes in this particular package. Note that, lately, it has been asserted Microsoft has switched to using the Chrome-Engine for its Microsoft Edge Browser Internal Code-Base. Therefore, there may limited support / functionality when running the methods in this class with Microsoft-Edge. There is the possibility these will work with Opera & Safari.

Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223.

Foreign Function API:
Every one of the methods that reside in this class are designed to do nothing more than:
1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket RDP Connection
3. Receive BOTH that Method's Results AND any Browser Event-Firings from the Web-Socket
4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
5. Report these Method-Results and Browser-Events to the User via an User-Registered Event-Listener or a Promise Object
Java-HTML Difference:
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".
Hi-Lited Source-Code:
- View Here: Torello/Browser/Fetch.java
- Open New Browser-Tab: Torello/Browser/Fetch.java
File Size: 54,524 Bytes Line Count: 1,300 '\n' Characters Found
Stateless Class:
This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 9 Method(s), 9 declared static
- 6 Field(s), 6 declared static, 5 declared final
- Fields excused from final modifier (with explanation):
  
  Field 'counter' is not final. Reason: CONFIGURATION

Nested Class Summary

Type Classes: Fetch Domain Types

Modifier and Type	Inner-Class
`static class`	`Fetch.AuthChallenge`	Authorization challenge for HTTP status code 401 or 407.
`static class`	`Fetch.AuthChallengeResponse`	Response to an AuthChallenge.
`static class`	`Fetch.HeaderEntry`	Response HTTP header entry
`static class`	`Fetch.RequestPattern`	`[No Description Provided by Google]`

Event Classes: Fetch Domain Events
Modifier and Type	Inner-Class
`static class`	`Fetch.authRequired`	Issued when the domain is enabled with handleAuthRequests set to true.
`static class`	`Fetch.requestPaused`	Issued when the domain is enabled and the request URL matches the specified filter.

Field Summary

Fetch Domain Enumerated String Types

Modifier and Type Field

static String[] RequestStage
Stages of the request to handle.

Method Summary

Fetch Domain Commands

Script Returns	Modifier and Type	Method
NONE (`void`)	`static Script<>`	`continueRequest(String requestId, String url, String method, String postData, Fetch.HeaderEntry[] headers, Boolean interceptResponse)` Continues the request, optionally modifying some of its parameters.
NONE (`void`)	`static Script<>`	`continueResponse(String requestId, Integer responseCode, String responsePhrase, Fetch.HeaderEntry[] responseHeaders, String binaryResponseHeaders)` Continues loading of the paused response, optionally modifying the response headers.
NONE (`void`)	`static Script<>`	`continueWithAuth(String requestId, Fetch.AuthChallengeResponse authChallengeResponse)` Continues a request supplying authChallengeResponse following authRequired event.
NONE (`void`)	`static Script<>`	`disable()` Disables the fetch domain.
NONE (`void`)	`static Script<>`	`enable(Fetch.RequestPattern[] patterns, Boolean handleAuthRequests)` Enables issuing of requestPaused events.
NONE (`void`)	`static Script<>`	`failRequest(String requestId, String errorReason)` Causes the request to fail with specified reason.
NONE (`void`)	`static Script<>`	`fulfillRequest(String requestId, int responseCode, Fetch.HeaderEntry[] responseHeaders, String binaryResponseHeaders, String body, String responsePhrase)` Provides response to the request.
`Ret2<String, Boolean>`	`static Script<>`	`getResponseBody(String requestId)` Causes the body of the response to be received from the server and returned as a single string.
`String`	`static Script<>`	`takeResponseBodyAsStream(String 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

- Field Detail
  - RequestStage
    
    🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static final java.lang.String[] RequestStage
    
    Stages of the request to handle. Request will intercept before the request is sent. Response will intercept after the response is received (but before response body is received).
- Method Detail
  - disable
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> disable()
    
    Disables the fetch domain.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - enable
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> enable (Fetch.RequestPattern[] patterns, java.lang.Boolean handleAuthRequests)
    
    Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
    
    Parameters:
    
    patterns - If specified, only requests matching any of these patterns will produce fetchRequested event and will be paused until clients response. If not set, all requests will be affected.
    OPTIONAL
    
    handleAuthRequests - If true, authRequired events will be issued and requests will be paused expecting a call to continueWithAuth.
    OPTIONAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - failRequest
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> failRequest (java.lang.String requestId, java.lang.String errorReason)
    
    Causes the request to fail with specified reason.
    
    Parameters:
    
    requestId - An id the client received in requestPaused event.
    
    errorReason - Causes the request to fail with the given reason.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - fulfillRequest
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> fulfillRequest (java.lang.String requestId, int responseCode, Fetch.HeaderEntry[] responseHeaders, java.lang.String binaryResponseHeaders, java.lang.String body, java.lang.String responsePhrase)
    
    Provides response to the request.
    
    Parameters:
    
    requestId - An id the client received in requestPaused event.
    
    responseCode - An HTTP response code.
    
    responseHeaders - Response headers.
    OPTIONAL
    
    binaryResponseHeaders - Alternative way of specifying response headers as a \0-separated series of name: value pairs. Prefer the above method unless you need to represent some non-UTF8 values that can't be transmitted over the protocol as text. (Encoded as a base64 string when passed over JSON)
    OPTIONAL
    
    body - A response body. If absent, original response body will be used if the request is intercepted at the response stage and empty body will be used if the request is intercepted at the request stage. (Encoded as a base64 string when passed over JSON)
    OPTIONAL
    
    responsePhrase - A textual representation of responseCode. If absent, a standard phrase matching responseCode is used.
    OPTIONAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - continueRequest
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> continueRequest (java.lang.String requestId, java.lang.String url, java.lang.String method, java.lang.String postData, Fetch.HeaderEntry[] headers, java.lang.Boolean interceptResponse)
    
    Continues the request, optionally modifying some of its parameters.
    
    Parameters:
    
    requestId - An id the client received in requestPaused event.
    
    url - If set, the request url will be modified in a way that's not observable by page.
    OPTIONAL
    
    method - If set, the request method is overridden.
    OPTIONAL
    
    postData - If set, overrides the post data in the request. (Encoded as a base64 string when passed over JSON)
    OPTIONAL
    
    headers - If set, overrides the request headers.
    OPTIONAL
    
    interceptResponse - If set, overrides response interception behavior for this request.
    OPTIONAL
    EXPERIMENTAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - continueWithAuth
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> continueWithAuth (java.lang.String requestId, Fetch.AuthChallengeResponse authChallengeResponse)
    
    Continues a request supplying authChallengeResponse following authRequired event.
    
    Parameters:
    
    requestId - An id the client received in authRequired event.
    
    authChallengeResponse - Response to with an authChallenge.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - continueResponse
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret0> continueResponse (java.lang.String requestId, java.lang.Integer responseCode, java.lang.String responsePhrase, Fetch.HeaderEntry[] responseHeaders, 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.
    EXPERIMENTAL
    
    Parameters:
    
    requestId - An id the client received in requestPaused event.
    
    responseCode - An HTTP response code. If absent, original response code will be used.
    OPTIONAL
    
    responsePhrase - A textual representation of responseCode. If absent, a standard phrase matching responseCode is used.
    OPTIONAL
    
    responseHeaders - Response headers. If absent, original response headers will be used.
    OPTIONAL
    
    binaryResponseHeaders - Alternative way of specifying response headers as a \0-separated series of name: value pairs. Prefer the above method unless you need to represent some non-UTF8 values that can't be transmitted over the protocol as text. (Encoded as a base64 string when passed over JSON)
    OPTIONAL
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret0>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<JsonObject, Ret0 > to ensure the Browser Function has run to completion.
  - getResponseBody
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,Ret2<java.lang.String,java.lang.Boolean>> getResponseBody (java.lang.String 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.
    
    Parameters:
    
    requestId - Identifier for the intercepted request to get body for.
    
    Returns:
    
    An instance of Script<String, JsonObject, Ret2>
    
    This Script may be executed (using Script.exec()), and a Promise returned.
    
    When the Promise is awaited (using Promise.await()), the Ret2 will subsequently be returned from that call.
    
    The returned values are encapsulated in an instance of Ret2
    
    Ret2.a: String (body)
    Response body.
    
    Ret2.b: Boolean (base64Encoded)
    True, if content was sent as base64.
  - takeResponseBodyAsStream
    
    🡅 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.String,JsonObject,java.lang.String> takeResponseBodyAsStream (java.lang.String 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.
    
    Parameters:
    
    requestId - -
    
    Returns:
    
    An instance of Script<String, JsonObject, String>
    
    This script may be executed, using Script.exec(), and afterwards, a Promise<JsonObject, String> will be returned.
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may may be retrieved.
    
    This Browser Function returns
    
    String (stream)
    -

Fetch Domain Enumerated String Types

Modifier and Type	Field
`static String[]`	`RequestStage`	Stages of the request to handle.

Class Fetch

This class is intended to be used with a Headless Browser

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RequestStage

Method Detail

disable

enable

failRequest

fulfillRequest

continueRequest

continueWithAuth

continueResponse

getResponseBody

takeResponseBodyAsStream