WebViewFactoryProvider.java revision 9f3ed850b6521bec8a946a54bb8a15565b4aa67e 
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 method:
41         * {@link android.webkit.WebSettings#getDefaultUserAgent(Context) }
42         */
43        String getDefaultUserAgent(Context context);
44
45        /**
46         * Used for tests only.
47         */
48         void freeMemoryForTests();
49
50        /**
51         * Implements the API method:
52         * {@link android.webkit.WebView#setWebContentsDebuggingEnabled(boolean) }
53         */
54        void setWebContentsDebuggingEnabled(boolean enable);
55
56        /**
57         * Implements the API method:
58         * {@link android.webkit.WebView#clearClientCertPreferences(Runnable) }
59         */
60        void clearClientCertPreferences(Runnable onCleared);
61
62        /**
63         * Implements the API method:
64         * {@link android.webkit.WebView#optOutDataReductionProxy() }
65         */
66        void optOutDataReductionProxy();
67
68        /**
69         * Implements the API method:
70         * {@link android.webkit.WebView#setSlowWholeDocumentDrawEnabled(boolean) }
71         */
72        void enableSlowWholeDocumentDraw();
73    }
74
75    Statics getStatics();
76
77    /**
78     * Construct a new WebViewProvider.
79     * @param webView the WebView instance bound to this implementation instance. Note it will not
80     * necessarily be fully constructed at the point of this call: defer real initialization to
81     * WebViewProvider.init().
82     * @param privateAccess provides access into WebView internal methods.
83     */
84    WebViewProvider createWebView(WebView webView, WebView.PrivateAccess privateAccess);
85
86    /**
87     * Gets the singleton GeolocationPermissions instance for this WebView implementation. The
88     * implementation must return the same instance on subsequent calls.
89     * @return the single GeolocationPermissions instance.
90     */
91    GeolocationPermissions getGeolocationPermissions();
92
93    /**
94     * Gets the singleton CookieManager instance for this WebView implementation. The
95     * implementation must return the same instance on subsequent calls.
96     *
97     * @return the singleton CookieManager instance
98     */
99    CookieManager getCookieManager();
100
101    /**
102     * Gets the singleton WebIconDatabase instance for this WebView implementation. The
103     * implementation must return the same instance on subsequent calls.
104     *
105     * @return the singleton WebIconDatabase instance
106     */
107    WebIconDatabase getWebIconDatabase();
108
109    /**
110     * Gets the singleton WebStorage instance for this WebView implementation. The
111     * implementation must return the same instance on subsequent calls.
112     *
113     * @return the singleton WebStorage instance
114     */
115    WebStorage getWebStorage();
116
117    /**
118     * Gets the singleton WebViewDatabase instance for this WebView implementation. The
119     * implementation must return the same instance on subsequent calls.
120     *
121     * @return the singleton WebViewDatabase instance
122     */
123    WebViewDatabase getWebViewDatabase(Context context);
124}
125