org.apache.cordova.engine

Class SystemWebViewClient

java.lang.Object

android.webkit.WebViewClient

org.apache.cordova.engine.SystemWebViewClient

public class SystemWebViewClient
extends android.webkit.WebViewClient

This classes is the WebViewClient that implements callbacks for our web view. The kind of callbacks that happen here are regarding the rendering of the document instead of the chrome surrounding it, such as onPageStarted(), shouldOverrideUrlLoading(), etc. Related to but different than CordovaChromeClient.

Field Summary

Fields

Modifier and Type	Field and Description
protected SystemWebViewEngine	parentEngine

Fields inherited from class android.webkit.WebViewClient

ERROR_AUTHENTICATION, ERROR_BAD_URL, ERROR_CONNECT, ERROR_FAILED_SSL_HANDSHAKE, ERROR_FILE, ERROR_FILE_NOT_FOUND, ERROR_HOST_LOOKUP, ERROR_IO, ERROR_PROXY_AUTHENTICATION, ERROR_REDIRECT_LOOP, ERROR_TIMEOUT, ERROR_TOO_MANY_REQUESTS, ERROR_UNKNOWN, ERROR_UNSUPPORTED_AUTH_SCHEME, ERROR_UNSUPPORTED_SCHEME

Constructor Summary

Constructors

Constructor and Description
SystemWebViewClient(SystemWebViewEngine parentEngine)

Method Summary

Modifier and Type	Method and Description
void	clearAuthenticationTokens() Clear all authentication tokens.
AuthenticationToken	getAuthenticationToken(java.lang.String host, java.lang.String realm) Gets the authentication token.
void	onPageFinished(android.webkit.WebView view, java.lang.String url) Notify the host application that a page has finished loading.
void	onPageStarted(android.webkit.WebView view, java.lang.String url, android.graphics.Bitmap favicon) Notify the host application that a page has started loading.
void	onReceivedClientCertRequest(android.webkit.WebView view, android.webkit.ClientCertRequest request) On received client cert request.
void	onReceivedError(android.webkit.WebView view, int errorCode, java.lang.String description, java.lang.String failingUrl) Report an error to the host application.
void	onReceivedHttpAuthRequest(android.webkit.WebView view, android.webkit.HttpAuthHandler handler, java.lang.String host, java.lang.String realm) On received http auth request.
void	onReceivedSslError(android.webkit.WebView view, android.webkit.SslErrorHandler handler, android.net.http.SslError error) Notify the host application that an SSL error occurred while loading a resource.
AuthenticationToken	removeAuthenticationToken(java.lang.String host, java.lang.String realm) Removes the authentication token.
void	setAuthenticationToken(AuthenticationToken authenticationToken, java.lang.String host, java.lang.String realm) Sets the authentication token.
android.webkit.WebResourceResponse	shouldInterceptRequest(android.webkit.WebView view, java.lang.String url)
boolean	shouldOverrideUrlLoading(android.webkit.WebView 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 WebView.

Methods inherited from class android.webkit.WebViewClient

doUpdateVisitedHistory, onFormResubmission, onLoadResource, onPageCommitVisible, onReceivedError, onReceivedHttpError, onReceivedLoginRequest, onScaleChanged, onTooManyRedirects, onUnhandledKeyEvent, shouldInterceptRequest, shouldOverrideKeyEvent, shouldOverrideUrlLoading

Methods inherited from class java.lang.Object

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

Field Detail

parentEngine

protected final SystemWebViewEngine parentEngine

Constructor Detail

SystemWebViewClient

public SystemWebViewClient(SystemWebViewEngine parentEngine)

Method Detail

shouldOverrideUrlLoading

public boolean shouldOverrideUrlLoading(android.webkit.WebView 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 WebView.

Overrides:

shouldOverrideUrlLoading in class android.webkit.WebViewClient

Parameters:

view - The WebView that is initiating the callback.

url - The url to be loaded.

Returns:

true to override, false for default behavior

onReceivedHttpAuthRequest

public void onReceivedHttpAuthRequest(android.webkit.WebView view,
                                      android.webkit.HttpAuthHandler handler,
                                      java.lang.String host,
                                      java.lang.String realm)

On received http auth request. The method reacts on all registered authentication tokens. There is one and only one authentication token for any host + realm combination

Overrides:

onReceivedHttpAuthRequest in class android.webkit.WebViewClient

onReceivedClientCertRequest

public void onReceivedClientCertRequest(android.webkit.WebView view,
                                        android.webkit.ClientCertRequest request)

On received client cert request. The method forwards the request to any running plugins before using the default implementation.

Overrides:

onReceivedClientCertRequest in class android.webkit.WebViewClient

Parameters:

view -

request -

onPageStarted

public void onPageStarted(android.webkit.WebView view,
                          java.lang.String url,
                          android.graphics.Bitmap favicon)

Notify the host application that a page has started loading. This method is called once for each main frame load so a page with iframes or framesets will call onPageStarted one time for the main frame. This also means that onPageStarted will not be called when the contents of an embedded frame changes, i.e. clicking a link whose target is an iframe.

Overrides:

onPageStarted in class android.webkit.WebViewClient

Parameters:

view - The webview initiating the callback.

url - The url of the page.

onPageFinished

public void onPageFinished(android.webkit.WebView view,
                           java.lang.String url)

Notify the host application that a page has finished loading. This method is called only for main frame. When onPageFinished() is called, the rendering picture may not be updated yet.

Overrides:

onPageFinished in class android.webkit.WebViewClient

Parameters:

view - The webview initiating the callback.

url - The url of the page.

onReceivedError

public void onReceivedError(android.webkit.WebView view,
                            int errorCode,
                            java.lang.String description,
                            java.lang.String failingUrl)

Report an error to the host application. These errors are unrecoverable (i.e. the main resource is unavailable). The errorCode parameter corresponds to one of the ERROR_* constants.

Overrides:

onReceivedError in class android.webkit.WebViewClient

Parameters:

view - The WebView that is initiating the callback.

errorCode - The error code corresponding to an ERROR_* value.

description - A String describing the error.

failingUrl - The url that failed to load.

onReceivedSslError

public void onReceivedSslError(android.webkit.WebView view,
                               android.webkit.SslErrorHandler handler,
                               android.net.http.SslError error)

Notify the host application that an SSL error occurred while loading a resource. The host application must call either handler.cancel() or handler.proceed(). Note that the decision may be retained for use in response to future SSL errors. The default behavior is to cancel the load.

Overrides:

onReceivedSslError in class android.webkit.WebViewClient

Parameters:

view - The WebView that is initiating the callback.

handler - An SslErrorHandler object that will handle the user's response.

error - The SSL error object.

setAuthenticationToken

public void setAuthenticationToken(AuthenticationToken authenticationToken,
                                   java.lang.String host,
                                   java.lang.String realm)

Sets the authentication token.

Parameters:

authenticationToken -

host -

realm -

removeAuthenticationToken

public AuthenticationToken removeAuthenticationToken(java.lang.String host,
                                                     java.lang.String realm)

Removes the authentication token.

Parameters:

host -

realm -

Returns:

the authentication token or null if did not exist

getAuthenticationToken

public AuthenticationToken getAuthenticationToken(java.lang.String host,
                                                  java.lang.String realm)

Gets the authentication token. In order it tries: 1- host + realm 2- host 3- realm 4- no host, no realm

Parameters:

host -

realm -

Returns:

the authentication token

clearAuthenticationTokens

public void clearAuthenticationTokens()

Clear all authentication tokens.

shouldInterceptRequest

public android.webkit.WebResourceResponse shouldInterceptRequest(android.webkit.WebView view,
                                                                 java.lang.String url)

Overrides:

shouldInterceptRequest in class android.webkit.WebViewClient