org.xwalk.core

Class XWalkResourceClient

java.lang.Object

org.xwalk.core.XWalkResourceClient

public class XWalkResourceClient
extends java.lang.Object

This class notifies the embedder resource events/callbacks.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_AUTHENTICATION User authentication failed on server
static int	ERROR_BAD_URL Malformed URL
static int	ERROR_CONNECT Failed to connect to the server
static int	ERROR_FAILED_SSL_HANDSHAKE Failed to perform SSL handshake
static int	ERROR_FILE Generic file error
static int	ERROR_FILE_NOT_FOUND File not found
static int	ERROR_HOST_LOOKUP Server or proxy hostname lookup failed
static int	ERROR_IO Failed to read or write to the server
static int	ERROR_OK Success
static int	ERROR_PROXY_AUTHENTICATION User authentication failed on proxy
static int	ERROR_REDIRECT_LOOP Too many redirects
static int	ERROR_TIMEOUT Connection timed out
static int	ERROR_TOO_MANY_REQUESTS Too many requests during this load
static int	ERROR_UNKNOWN Generic error
static int	ERROR_UNSUPPORTED_AUTH_SCHEME Unsupported authentication scheme (not basic or digest)
static int	ERROR_UNSUPPORTED_SCHEME Unsupported URI scheme

Constructor Summary

Constructors

Constructor and Description
XWalkResourceClient(XWalkView view) Constructor.

Method Summary

Modifier and Type	Method and Description
XWalkWebResourceResponse	createXWalkWebResourceResponse(java.lang.String mimeType, java.lang.String encoding, java.io.InputStream data) Construct an instance of XWalkWebResourceResponse for application usage.
XWalkWebResourceResponse	createXWalkWebResourceResponse(java.lang.String mimeType, java.lang.String encoding, java.io.InputStream data, int statusCode, java.lang.String reasonPhrase, java.util.Map<java.lang.String,java.lang.String> responseHeaders) Construct an instance of XWalkWebResourceResponse for application usage.
void	doUpdateVisitedHistory(XWalkView view, java.lang.String url, boolean isReload) Notify the host application to update its visited links database.
protected java.lang.Object	getBridge()
void	onDocumentLoadedInFrame(XWalkView view, long frameId) Notify the client that initial HTML document has been completely loaded and parsed, without waiting for stylesheets, images, and subframes to finish loading.
void	onLoadFinished(XWalkView view, java.lang.String url) Notify the client that the XWalkView completes to load the resource specified by the given url.
void	onLoadStarted(XWalkView view, java.lang.String url) Notify the client that the XWalkView will load the resource specified by the given url.
void	onProgressChanged(XWalkView view, int progressInPercent) Notify the client the progress info of loading a specific url.
void	onReceivedClientCertRequest(XWalkView view, ClientCertRequest handler) Notify the host application to handle a SSL client certificate request.
void	onReceivedHttpAuthRequest(XWalkView view, XWalkHttpAuthHandler handler, java.lang.String host, java.lang.String realm) Notify the host application to handle an authentication request.
void	onReceivedLoadError(XWalkView view, int errorCode, java.lang.String description, java.lang.String failingUrl) Report an error to the client.
void	onReceivedResponseHeaders(XWalkView view, XWalkWebResourceRequest request, XWalkWebResourceResponse response) Notify the host application that an HTTP response has been received from the server while loading a resource.
void	onReceivedSslError(XWalkView view, android.webkit.ValueCallback<java.lang.Boolean> callback, android.net.http.SslError error) Notify the host application that an SSL error occurred while loading a resource.
android.webkit.WebResourceResponse	shouldInterceptLoadRequest(XWalkView view, java.lang.String url) Deprecated. Use shouldInterceptLoadRequest(XWalkView, XWalkWebResourceRequest) instead.
XWalkWebResourceResponse	shouldInterceptLoadRequest(XWalkView view, XWalkWebResourceRequest request) Notify the client of a resource request and allow the client to return the data.
boolean	shouldOverrideUrlLoading(XWalkView view, java.lang.String url) Give the host application a chance to take over the control when a new url is about to be loaded in the current XWalkView.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_OK

public static final int ERROR_OK

Success

Since:

1.0

See Also:

Constant Field Values

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

Generic error

Since:

1.0

See Also:

Constant Field Values

ERROR_HOST_LOOKUP

public static final int ERROR_HOST_LOOKUP

Server or proxy hostname lookup failed

Since:

1.0

See Also:

Constant Field Values

ERROR_UNSUPPORTED_AUTH_SCHEME

public static final int ERROR_UNSUPPORTED_AUTH_SCHEME

Unsupported authentication scheme (not basic or digest)

Since:

1.0

See Also:

Constant Field Values

ERROR_AUTHENTICATION

public static final int ERROR_AUTHENTICATION

User authentication failed on server

Since:

1.0

See Also:

Constant Field Values

ERROR_PROXY_AUTHENTICATION

public static final int ERROR_PROXY_AUTHENTICATION

User authentication failed on proxy

Since:

1.0

See Also:

Constant Field Values

ERROR_CONNECT

public static final int ERROR_CONNECT

Failed to connect to the server

Since:

1.0

See Also:

Constant Field Values

ERROR_IO

public static final int ERROR_IO

Failed to read or write to the server

Since:

1.0

See Also:

Constant Field Values

ERROR_TIMEOUT

public static final int ERROR_TIMEOUT

Connection timed out

Since:

1.0

See Also:

Constant Field Values

ERROR_REDIRECT_LOOP

public static final int ERROR_REDIRECT_LOOP

Too many redirects

Since:

1.0

See Also:

Constant Field Values

ERROR_UNSUPPORTED_SCHEME

public static final int ERROR_UNSUPPORTED_SCHEME

Unsupported URI scheme

Since:

1.0

See Also:

Constant Field Values

ERROR_FAILED_SSL_HANDSHAKE

public static final int ERROR_FAILED_SSL_HANDSHAKE

Failed to perform SSL handshake

Since:

1.0

See Also:

Constant Field Values

ERROR_BAD_URL

public static final int ERROR_BAD_URL

Malformed URL

Since:

1.0

See Also:

Constant Field Values

ERROR_FILE

public static final int ERROR_FILE

Generic file error

Since:

1.0

See Also:

Constant Field Values

ERROR_FILE_NOT_FOUND

public static final int ERROR_FILE_NOT_FOUND

File not found

Since:

1.0

See Also:

Constant Field Values

ERROR_TOO_MANY_REQUESTS

public static final int ERROR_TOO_MANY_REQUESTS

Too many requests during this load

Since:

1.0

See Also:

Constant Field Values

Constructor Detail

XWalkResourceClient

public XWalkResourceClient(XWalkView view)

Constructor.

Parameters:

view - the owner XWalkView instance.

Since:

1.0

Method Detail

getBridge

protected java.lang.Object getBridge()

onDocumentLoadedInFrame

public void onDocumentLoadedInFrame(XWalkView view,
                                    long frameId)

Notify the client that initial HTML document has been completely loaded and parsed, without waiting for stylesheets, images, and subframes to finish loading. This is similar to JavaScript DOMContentLoaded.

Parameters:

view - the owner XWalkView instance.

frameId - the loaded and parsed frame.

Since:

5.0

onLoadStarted

public void onLoadStarted(XWalkView view,
                          java.lang.String url)

Notify the client that the XWalkView will load the resource specified by the given url.

Parameters:

view - the owner XWalkView instance.

url - the url for the resource to be loaded.

Since:

1.0

onLoadFinished

public void onLoadFinished(XWalkView view,
                           java.lang.String url)

Notify the client that the XWalkView completes to load the resource specified by the given url.

Parameters:

view - the owner XWalkView instance.

url - the url for the resource done for loading.

Since:

1.0

onProgressChanged

public void onProgressChanged(XWalkView view,
                              int progressInPercent)

Notify the client the progress info of loading a specific url.

Parameters:

view - the owner XWalkView instance.

progressInPercent - the loading process in percent.

Since:

1.0

shouldInterceptLoadRequest

public android.webkit.WebResourceResponse shouldInterceptLoadRequest(XWalkView view,
                                                                     java.lang.String url)

Deprecated. Use shouldInterceptLoadRequest(XWalkView, XWalkWebResourceRequest) instead.

Notify the client of a resource request and allow the client to return the data. If the return value is null, the XWalkView will continue to load the resource as usual. Otherwise, the return response and data will be used. NOTE: This method is called by the network thread so clients should exercise caution when accessing private data.

Parameters:

view - The owner XWalkView instance that is requesting the resource.

url - The raw url of the resource.

Returns:

A WebResourceResponse containing the response information or null if the XWalkView should load the resource itself.

Since:

1.0

shouldInterceptLoadRequest

public XWalkWebResourceResponse shouldInterceptLoadRequest(XWalkView view,
                                                           XWalkWebResourceRequest request)

Notify the client of a resource request and allow the client to return the data. If the return value is null, the XWalkView will continue to load the resource as usual. Otherwise, the return response and data will be used. NOTE: This method is called by the network thread so clients should exercise caution when accessing private data.

Parameters:

view - The owner XWalkView instance that is requesting the resource.

request - Object containing the details of the request..

Returns:

A XWalkWebResourceResponse containing the response information or null if the XWalkView should load the resource itself.

Since:

6.0

onReceivedLoadError

public void onReceivedLoadError(XWalkView view,
                                int errorCode,
                                java.lang.String description,
                                java.lang.String failingUrl)

Report an error to the client.

Parameters:

view - the owner XWalkView instance.

errorCode - the error id.

description - A String describing the error.

failingUrl - The url that failed to load.

Since:

1.0

shouldOverrideUrlLoading

public boolean shouldOverrideUrlLoading(XWalkView view,
                                        java.lang.String url)

Give the host application a chance to take over the control when a new url is about to be loaded in the current XWalkView. If XWalkClient is not provided, by default XWalkView will ask Activity Manager to choose the proper handler for the url. If XWalkClient is provided, return true means the host application handles the url, while return false means the current XWalkView handles the url.

Parameters:

view - The XWalkView that is initiating the callback.

url - The url to be loaded.

Returns:

True if the host application wants to leave the current XWalkView and handle the url itself, otherwise return false.

Since:

2.1

onReceivedSslError

public void onReceivedSslError(XWalkView view,
                               android.webkit.ValueCallback<java.lang.Boolean> callback,
                               android.net.http.SslError error)

Notify the host application that an SSL error occurred while loading a resource. The host application must call either callback.onReceiveValue(true) or callback.onReceiveValue(false) . Note that the decision may be retained for use in response to future SSL errors. The default behavior is to pop up a dialog

Parameters:

view - the xwalkview that is initiating the callback

callback - passing 'true' means accepting the ssl error and continue to load. passing 'false' means forbidding to load the web page.

error - the SSL error object

Since:

4.0

onReceivedClientCertRequest

public void onReceivedClientCertRequest(XWalkView view,
                                        ClientCertRequest handler)

Notify the host application to handle a SSL client certificate request. The host application is responsible for showing the UI if desired and providing the keys. There are three ways to respond: proceed(), cancel() or ignore(). XWalkView remembers the response if proceed() or cancel() is called and does not call onReceivedClientCertRequest() again for the same host and port pair. XWalkView does not remember the response if ignore() is called. This method is called on the UI thread. During the callback, the connection is suspended. The default behavior is to cancel, returning no client certificate.

Parameters:

view - The XWalkView that is initiating the callback

handler - An instance of a ClientCertRequestHandlerInternal

Since:

6.0

onReceivedResponseHeaders

public void onReceivedResponseHeaders(XWalkView view,
                                      XWalkWebResourceRequest request,
                                      XWalkWebResourceResponse response)

Notify the host application that an HTTP response has been received from the server while loading a resource. This callback will be called for any resource (iframe, image, etc), not just for the main page. Thus, it is recommended to perform minimum required work in this callback. This method behaves similarly to the Android WebView's onReceivedHttpError if the HTTP response has a status code >= 400. If there are no errors, response contains the cookies set by the HTTP response.

Parameters:

view - The XWalkView that is initiating the callback

request - The originating request

response - The response information

Since:

6.0

doUpdateVisitedHistory

public void doUpdateVisitedHistory(XWalkView view,
                                   java.lang.String url,
                                   boolean isReload)

Notify the host application to update its visited links database.

Parameters:

view - The XWalkView that is initiating the callback.

url - The url being visited.

isReload - True if this url is being reloaded.

Since:

6.0

onReceivedHttpAuthRequest

public void onReceivedHttpAuthRequest(XWalkView view,
                                      XWalkHttpAuthHandler handler,
                                      java.lang.String host,
                                      java.lang.String realm)

Notify the host application to handle an authentication request. The default behavior is to cancel the request.

Parameters:

view - The XWalkView that is initiating the callback.

handler - The XWalkHttpAuthHandler that will handle the user's response.

host - The host requiring authentication.

realm - A description to help store user credentials for future visits.

createXWalkWebResourceResponse

public XWalkWebResourceResponse createXWalkWebResourceResponse(java.lang.String mimeType,
                                                               java.lang.String encoding,
                                                               java.io.InputStream data)

Construct an instance of XWalkWebResourceResponse for application usage.

Returns:

XWalkWebResourceResponse.

Since:

6.0

createXWalkWebResourceResponse

public XWalkWebResourceResponse createXWalkWebResourceResponse(java.lang.String mimeType,
                                                               java.lang.String encoding,
                                                               java.io.InputStream data,
                                                               int statusCode,
                                                               java.lang.String reasonPhrase,
                                                               java.util.Map<java.lang.String,java.lang.String> responseHeaders)

Construct an instance of XWalkWebResourceResponse for application usage.

Returns:

XWalkWebResourceResponse.

Since:

6.0