128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine/* 228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Copyright (C) 2016 The Android Open Source Project 328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Licensed under the Apache License, Version 2.0 (the "License"); 528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * you may not use this file except in compliance with the License. 628c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * You may obtain a copy of the License at 728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * http://www.apache.org/licenses/LICENSE-2.0 928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 1028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Unless required by applicable law or agreed to in writing, software 1128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * distributed under the License is distributed on an "AS IS" BASIS, 1228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * See the License for the specific language governing permissions and 1428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * limitations under the License. 1528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 1628c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 1728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodinepackage android.webkit; 1828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 1928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine/** 2028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Manages settings state for all Service Workers. These settings are not tied to 2128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * the lifetime of any WebView because service workers can outlive WebView instances. 2228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * The settings are similar to {@link WebSettings} but only settings relevant to 2328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Service Workers are supported. 2428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 2528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine// This is an abstract base class: concrete ServiceWorkerControllers must 2628c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine// create a class derived from this, and return an instance of it in the 2728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine// ServiceWorkerController.getServiceWorkerWebSettings() method implementation. 2828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodinepublic abstract class ServiceWorkerWebSettings { 2928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 3028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 3128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Overrides the way the cache is used, see {@link WebSettings#setCacheMode}. 3228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 33b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine * @param mode the mode to use. One of {@link WebSettings#LOAD_DEFAULT}, 34b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine * {@link WebSettings#LOAD_CACHE_ELSE_NETWORK}, {@link WebSettings#LOAD_NO_CACHE} 35b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine * or {@link WebSettings#LOAD_CACHE_ONLY}. The default value is 36b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine * {@link WebSettings#LOAD_DEFAULT}. 3728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 38b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine public abstract void setCacheMode(@WebSettings.CacheMode int mode); 3928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 4028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 4128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Gets the current setting for overriding the cache mode. 4228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 4328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * @return the current setting for overriding the cache mode 4428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * @see #setCacheMode 4528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 46b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine @WebSettings.CacheMode 4728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine public abstract int getCacheMode(); 4828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 4928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 5028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Enables or disables content URL access from Service Workers, see 5128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * {@link WebSettings#setAllowContentAccess}. 5228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 5328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine public abstract void setAllowContentAccess(boolean allow); 5428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 5528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 5628c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Gets whether Service Workers support content URL access. 5728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 5828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * @see #setAllowContentAccess 5928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 6028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine public abstract boolean getAllowContentAccess(); 6128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 6228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 6328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Enables or disables file access within Service Workers, see 6428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * {@link WebSettings#setAllowFileAccess}. 6528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 6628c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine public abstract void setAllowFileAccess(boolean allow); 6728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 6828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 6928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Gets whether Service Workers support file access. 7028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 7128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * @see #setAllowFileAccess 7228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 7328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine public abstract boolean getAllowFileAccess(); 7428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 7528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 76b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine * Sets whether Service Workers should not load resources from the network, 7728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * see {@link WebSettings#setBlockNetworkLoads}. 7828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 79b90f5389ddd704bb50bb7846ff3298920e7bb40aTim Volodine * @param flag true means block network loads by the Service Workers 8028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 8128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine public abstract void setBlockNetworkLoads(boolean flag); 8228c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 8328c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine /** 8428c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * Gets whether Service Workers are prohibited from loading any resources from the network. 8528c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * 8628c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * @return true if the Service Workers are not allowed to load any resources from the network 8728c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine * @see #setBlockNetworkLoads 8828c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine */ 8928c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine public abstract boolean getBlockNetworkLoads(); 9028c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine} 9128c83564419de9f4f3d22aff630244dc4cbc3c2fTim Volodine 92