com.qeagle.devtools.protocol.commands

Interface Fetch

public interface Fetch

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

Method Summary

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

Method Detail

disable

void disable()

Disables the fetch domain.

enable

void enable()

Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.

enable

void enable(List<RequestPattern> patterns,
            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.

handleAuthRequests - If true, authRequired events will be issued and requests will be paused expecting a call to continueWithAuth.

failRequest

void failRequest(String requestId,
                 ErrorReason 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.

fulfillRequest

void fulfillRequest(String requestId,
                    Integer responseCode,
                    List<HeaderEntry> responseHeaders)

Provides response to the request.

Parameters:

requestId - An id the client received in requestPaused event.

responseCode - An HTTP response code.

responseHeaders - Response headers.

fulfillRequest

void fulfillRequest(String requestId,
                    Integer responseCode,
                    List<HeaderEntry> responseHeaders,
                    String body,
                    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.

body - A response body.

responsePhrase - A textual representation of responseCode. If absent, a standard phrase mathcing responseCode is used.

continueRequest

void continueRequest(String requestId)

Continues the request, optionally modifying some of its parameters.

Parameters:

requestId - An id the client received in requestPaused event.

continueRequest

void continueRequest(String requestId,
                     String url,
                     String method,
                     String postData,
                     List<HeaderEntry> headers)

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.

method - If set, the request method is overridden.

postData - If set, overrides the post data in the request.

headers - If set, overrides the request headrts.

continueWithAuth

void continueWithAuth(String requestId,
                      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.

getResponseBody

ResponseBody getResponseBody(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.

takeResponseBodyAsStream

String takeResponseBodyAsStream(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 -

onRequestPaused

EventListener onRequestPaused(EventHandler<RequestPaused> eventListener)

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.

onAuthRequired

EventListener onAuthRequired(EventHandler<AuthRequired> eventListener)

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