Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix WebViewDatabase javadoc.

Browse Source 
BUG=30481165
Change-Id: Ibd14880aa25907234dd93c38b5d0f2c9e808340e
(cherry picked from commit 433fb93515)
This commit is contained in:
Hui Shu
2016-08-29 11:49:46 -07:00
committed by Nate Fischer
parent 9b006e28f9
commit 68d2cc180f
2 changed files with 33 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
core/java/android/webkit/WebView.java
View File

@@ -740,9 +740,26 @@ public class WebView extends AbsoluteLayout
}
/**
* Stores HTTP authentication credentials for a given host and realm. This
* method is intended to be used with
* {@link WebViewClient#onReceivedHttpAuthRequest}.
* Stores HTTP authentication credentials for a given host and realm to the {@link WebViewDatabase}
* instance.
* <p>
* To use HTTP authentication, the embedder application has to implement
* {@link WebViewClient#onReceivedHttpAuthRequest}, and call {@link HttpAuthHandler#proceed}
* with the correct username and password.
* <p>
* The embedder app can get the username and password any way it chooses, and does not have to
* use {@link WebViewDatabase}.
* <p>
* Notes:
* <li>
* {@link WebViewDatabase} is provided only as a convenience to store and retrieve http
* authentication credentials. WebView does not read from it during HTTP authentication.
* </li>
* <li>
* WebView does not provide a special mechanism to clear HTTP authentication credentials for
* implementing client logout. The client logout mechanism should be implemented by the Web site
* designer (such as server sending a HTTP 401 for invalidating credentials).
* </li>
*
* @param host the host to which the credentials apply
* @param realm the realm to which the credentials apply
@@ -759,9 +776,8 @@ public class WebView extends AbsoluteLayout
}
/**
* Retrieves HTTP authentication credentials for a given host and realm.
* This method is intended to be used with
* {@link WebViewClient#onReceivedHttpAuthRequest}.
* Retrieves HTTP authentication credentials for a given host and realm from the {@link
* WebViewDatabase} instance.
*
* @param host the host to which the credentials apply
* @param realm the realm to which the credentials apply

13
core/java/android/webkit/WebViewDatabase.java
View File

@@ -44,7 +44,7 @@ public abstract class WebViewDatabase {
*
* @return true if there are any saved username/password pairs
* @see WebView#savePassword
* @see #clearUsernamePassworda
* @see #clearUsernamePassword
* @deprecated Saving passwords in WebView will not be supported in future versions.
*/
@Deprecated
@@ -72,7 +72,16 @@ public abstract class WebViewDatabase {
public abstract boolean hasHttpAuthUsernamePassword();
/**
* Clears any saved credentials for HTTP authentication.
* Clears any saved credentials for HTTP authentication. This method only clears the username
* and password stored in WebViewDatabase instance. The username and password are not read from
* the {@link WebViewDatabase} during {@link WebViewClient#onReceivedHttpAuthRequest}. It is up
* to the app to do this or not.
* <p>
* The username and password used for http authentication might be cached in the network stack
* itself, and are not cleared when this method is called. WebView does not provide a special
* mechanism to clear HTTP authentication for implementing client logout. The client logout
* mechanism should be implemented by the Web site designer (such as server sending a HTTP 401
* for invalidating credentials).
*
* @see WebView#getHttpAuthUsernamePassword
* @see WebView#setHttpAuthUsernamePassword