Package org.mozilla.geckoview

Class GeckoWebExecutor

Object

org.mozilla.geckoview.GeckoWebExecutor

@AnyThread
public class GeckoWebExecutor
extends Object

GeckoWebExecutor is responsible for fetching a WebRequest and delivering a WebResponse to the caller via fetch(WebRequest). Example:

     final GeckoWebExecutor executor = new GeckoWebExecutor();

     final GeckoResult<WebResponse> result = executor.fetch(
             new WebRequest.Builder("https://example.org/json")
             .header("Accept", "application/json")
             .build());

     result.then(response -> {
         // Do something with response
     });
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	GeckoWebExecutor.FetchFlags	Fetch flag definitions for network request options.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FETCH_FLAGS_ANONYMOUS	Don't send cookies or other user data along with the request.
static final int	FETCH_FLAGS_NO_REDIRECTS	Don't automatically follow redirects.
static final int	FETCH_FLAGS_NONE	No special treatment.
static final int	FETCH_FLAGS_OHTTP	Use the OHTTP relay for this request.
static final int	FETCH_FLAGS_PRIVATE	Associates this download with the current private browsing session
static final int	FETCH_FLAGS_STREAM_FAILURE_TEST	This flag causes a read error in the WebResponse body.

Constructor Summary

Constructors

Constructor	Description
GeckoWebExecutor(GeckoRuntime runtime)	Create a new GeckoWebExecutor instance.

Method Summary

Modifier and Type	Method	Description
GeckoResult<WebResponse>	fetch(WebRequest request)	Send the given WebRequest.
GeckoResult<WebResponse>	fetch(WebRequest request, int flags)	Send the given WebRequest with specified flags.
GeckoResult<InetAddress[]>	resolve(String host)	Resolves the specified host name.
void	speculativeConnect(String uri)	This causes a speculative connection to be made to the host in the specified URI.

Methods inherited from class java.lang.Object

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

Field Details

FETCH_FLAGS_NONE

public static final int FETCH_FLAGS_NONE

No special treatment.

See Also:

• Constant Field Values

FETCH_FLAGS_ANONYMOUS

public static final int FETCH_FLAGS_ANONYMOUS

Don't send cookies or other user data along with the request.

See Also:

• Constant Field Values

FETCH_FLAGS_NO_REDIRECTS

public static final int FETCH_FLAGS_NO_REDIRECTS

Don't automatically follow redirects.

See Also:

• Constant Field Values

FETCH_FLAGS_PRIVATE

public static final int FETCH_FLAGS_PRIVATE

Associates this download with the current private browsing session

See Also:

• Constant Field Values

FETCH_FLAGS_STREAM_FAILURE_TEST

public static final int FETCH_FLAGS_STREAM_FAILURE_TEST

This flag causes a read error in the WebResponse body. Useful for testing.

See Also:

• Constant Field Values

FETCH_FLAGS_OHTTP

public static final int FETCH_FLAGS_OHTTP

Use the OHTTP relay for this request.

See Also:

• Constant Field Values

Constructor Details

GeckoWebExecutor

public GeckoWebExecutor(@NonNull
 GeckoRuntime runtime)

Create a new GeckoWebExecutor instance.

Parameters:

runtime - A GeckoRuntime instance

Method Details

fetch

@NonNull
public GeckoResult<WebResponse> fetch(@NonNull
 WebRequest request)

Send the given WebRequest.

Parameters:

request - A WebRequest instance

Returns:

A GeckoResult which will be completed with a WebResponse. If the request fails to complete, the GeckoResult will be completed exceptionally with a WebRequestError.

Throws:

IllegalArgumentException - if request is null or otherwise unusable.

fetch

@NonNull
public GeckoResult<WebResponse> fetch(@NonNull
 WebRequest request,
 int flags)

Send the given WebRequest with specified flags.

Parameters:

request - A WebRequest instance

flags - The specified flags. One or more of the FETCH_* flags.

Returns:

A GeckoResult which will be completed with a WebResponse. If the request fails to complete, the GeckoResult will be completed exceptionally with a WebRequestError.

Throws:

IllegalArgumentException - if request is null or otherwise unusable.

resolve

@NonNull
public GeckoResult<InetAddress[]> resolve(@NonNull
 String host)

Resolves the specified host name.

Parameters:

host - An Internet host name, e.g. mozilla.org.

Returns:

A GeckoResult which will be fulfilled with a List of InetAddress. In case of failure, the GeckoResult will be completed exceptionally with a UnknownHostException.

speculativeConnect

public void speculativeConnect(@NonNull
 String uri)

This causes a speculative connection to be made to the host in the specified URI. This is useful if an app thinks it may be making a request to that host in the near future. If no request is made, the connection will be cleaned up after an unspecified amount of time.

Parameters:

uri - A URI String.