WebViewFactoryProvider.java revision 99c12e8d5f12f239c28644a837937810299e5e3f 
1/*
2 * Copyright (C) 2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.webkit;
18
19import android.content.Context;
20
21/**
22 * This is the main entry-point into the WebView back end implementations, which the WebView
23 * proxy class uses to instantiate all the other objects as needed. The backend must provide an
24 * implementation of this interface, and make it available to the WebView via mechanism TBD.
25 * @hide
26 */
27public interface WebViewFactoryProvider {
28    /**
29     * This Interface provides glue for implementing the backend of WebView static methods which
30     * cannot be implemented in-situ in the proxy class.
31     */
32    interface Statics {
33        /**
34         * Implements the API method:
35         * {@link android.webkit.WebView#findAddress(String)}
36         */
37        String findAddress(String addr);
38
39        /**
40         * Implements the API methods:
41         * {@link android.webkit.WebView#enablePlatformNotifications()}
42         * {@link android.webkit.WebView#disablePlatformNotifications()}
43         */
44        void setPlatformNotificationsEnabled(boolean enable);
45    }
46
47    Statics getStatics();
48
49    /**
50     * Construct a new WebViewProvider.
51     * @param webView the WebView instance bound to this implementation instance. Note it will not
52     * necessarily be fully constructed at the point of this call: defer real initialization to
53     * WebViewProvider.init().
54     * @param privateAccess provides access into WebView internal methods.
55     */
56    WebViewProvider createWebView(WebView webView, WebView.PrivateAccess privateAccess);
57
58    /**
59     * Gets the singleton GeolocationPermissions instance for this WebView implementation. The
60     * implementation must return the same instance on subsequent calls.
61     * @return the single GeolocationPermissions instance.
62     */
63    GeolocationPermissions getGeolocationPermissions();
64
65    /**
66     * Gets the singleton CookieManager instance for this WebView implementation. The
67     * implementation must return the same instance on subsequent calls.
68     *
69     * @return the singleton CookieManager instance
70     */
71    CookieManager getCookieManager();
72
73    /**
74     * Gets the singleton WebIconDatabase instance for this WebView implementation. The
75     * implementation must return the same instance on subsequent calls.
76     *
77     * @return the singleton WebIconDatabase instance
78     */
79    WebIconDatabase getWebIconDatabase();
80
81    /**
82     * Gets the singleton WebStorage instance for this WebView implementation. The
83     * implementation must return the same instance on subsequent calls.
84     *
85     * @return the singleton WebStorage instance
86     */
87    WebStorage getWebStorage();
88
89    /**
90     * Gets the singleton WebViewDatabase instance for this WebView implementation. The
91     * implementation must return the same instance on subsequent calls.
92     *
93     * @return the singleton WebViewDatabase instance
94     */
95    WebViewDatabase getWebViewDatabase(Context context);
96}
97