am 72950e65: am d47be031: am 43e533de: Merge "Restore 4 classes that were... (1ec0c91f) · Commits · e / os / android_frameworks_base

core/java/android/webkit/CacheManager.java

0 → 100644

+341 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2006 The Android Open Source Project
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package android.webkit;

			import android.content.Context;
			import android.net.http.Headers;
			import android.util.Log;

			import java.io.File;
			import java.io.FileInputStream;
			import java.io.FileNotFoundException;
			import java.io.IOException;
			import java.io.InputStream;
			import java.io.OutputStream;
			import java.util.Map;


			/**
			* Manages the HTTP cache used by an application's {@link WebView} instances.
			* @deprecated Access to the HTTP cache will be removed in a future release.
			* @hide Since {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1}
			*/
			// The class CacheManager provides the persistent cache of content that is
			// received over the network. The component handles parsing of HTTP headers and
			// utilizes the relevant cache headers to determine if the content should be
			// stored and if so, how long it is valid for. Network requests are provided to
			// this component and if they can not be resolved by the cache, the HTTP headers
			// are attached, as appropriate, to the request for revalidation of content. The
			// class also manages the cache size.
			//
			// CacheManager may only be used if your activity contains a WebView.
			@Deprecated
			public final class CacheManager {
			/**
			* Represents a resource stored in the HTTP cache. Instances of this class
			* can be obtained by calling
			* {@link CacheManager#getCacheFile CacheManager.getCacheFile(String, Map<String, String>))}.
			*
			* @deprecated Access to the HTTP cache will be removed in a future release.
			*/
			@Deprecated
			public static class CacheResult {
			// these fields are saved to the database
			int httpStatusCode;
			long contentLength;
			long expires;
			String expiresString;
			String localPath;
			String lastModified;
			String etag;
			String mimeType;
			String location;
			String encoding;
			String contentdisposition;
			String crossDomain;

			// these fields are NOT saved to the database
			InputStream inStream;
			OutputStream outStream;
			File outFile;

			/**
			* Gets the status code of this cache entry.
			*
			* @return the status code of this cache entry
			*/
			public int getHttpStatusCode() {
			return httpStatusCode;
			}

			/**
			* Gets the content length of this cache entry.
			*
			* @return the content length of this cache entry
			*/
			public long getContentLength() {
			return contentLength;
			}

			/**
			* Gets the path of the file used to store the content of this cache
			* entry, relative to the base directory of the cache. See
			* {@link CacheManager#getCacheFileBaseDir CacheManager.getCacheFileBaseDir()}.
			*
			* @return the path of the file used to store this cache entry
			*/
			public String getLocalPath() {
			return localPath;
			}

			/**
			* Gets the expiry date of this cache entry, expressed in milliseconds
			* since midnight, January 1, 1970 UTC.
			*
			* @return the expiry date of this cache entry
			*/
			public long getExpires() {
			return expires;
			}

			/**
			* Gets the expiry date of this cache entry, expressed as a string.
			*
			* @return the expiry date of this cache entry
			*
			*/
			public String getExpiresString() {
			return expiresString;
			}

			/**
			* Gets the date at which this cache entry was last modified, expressed
			* as a string.
			*
			* @return the date at which this cache entry was last modified
			*/
			public String getLastModified() {
			return lastModified;
			}

			/**
			* Gets the entity tag of this cache entry.
			*
			* @return the entity tag of this cache entry
			*/
			public String getETag() {
			return etag;
			}

			/**
			* Gets the MIME type of this cache entry.
			*
			* @return the MIME type of this cache entry
			*/
			public String getMimeType() {
			return mimeType;
			}

			/**
			* Gets the value of the HTTP 'Location' header with which this cache
			* entry was received.
			*
			* @return the HTTP 'Location' header for this cache entry
			*/
			public String getLocation() {
			return location;
			}

			/**
			* Gets the encoding of this cache entry.
			*
			* @return the encoding of this cache entry
			*/
			public String getEncoding() {
			return encoding;
			}

			/**
			* Gets the value of the HTTP 'Content-Disposition' header with which
			* this cache entry was received.
			*
			* @return the HTTP 'Content-Disposition' header for this cache entry
			*
			*/
			public String getContentDisposition() {
			return contentdisposition;
			}

			/**
			* Gets the input stream to the content of this cache entry, to allow
			* content to be read. See
			* {@link CacheManager#getCacheFile CacheManager.getCacheFile(String, Map<String, String>)}.
			*
			* @return an input stream to the content of this cache entry
			*/
			public InputStream getInputStream() {
			return inStream;
			}

			/**
			* Gets an output stream to the content of this cache entry, to allow
			* content to be written. See
			* {@link CacheManager#saveCacheFile CacheManager.saveCacheFile(String, CacheResult)}.
			*
			* @return an output stream to the content of this cache entry
			*/
			// Note that this is always null for objects returned by getCacheFile()!
			public OutputStream getOutputStream() {
			return outStream;
			}


			/**
			* Sets an input stream to the content of this cache entry.
			*
			* @param stream an input stream to the content of this cache entry
			*/
			public void setInputStream(InputStream stream) {
			this.inStream = stream;
			}

			/**
			* Sets the encoding of this cache entry.
			*
			* @param encoding the encoding of this cache entry
			*/
			public void setEncoding(String encoding) {
			this.encoding = encoding;
			}

			/**
			* @hide
			*/
			public void setContentLength(long contentLength) {
			this.contentLength = contentLength;
			}
			}

			/**
			* Gets the base directory in which the files used to store the contents of
			* cache entries are placed. See
			* {@link CacheManager.CacheResult#getLocalPath CacheManager.CacheResult.getLocalPath()}.
			*
			* @return the base directory of the cache
			* @deprecated This method no longer has any effect and always returns null.
			*/
			@Deprecated
			public static File getCacheFileBaseDir() {
			return null;
			}

			/**
			* Gets whether the HTTP cache is disabled.
			*
			* @return true if the HTTP cache is disabled
			* @deprecated This method no longer has any effect and always returns false.
			*/
			@Deprecated
			public static boolean cacheDisabled() {
			return false;
			}

			/**
			* Starts a cache transaction. Returns true if this is the only running
			* transaction. Otherwise, this transaction is nested inside currently
			* running transactions and false is returned.
			*
			* @return true if this is the only running transaction
			* @deprecated This method no longer has any effect and always returns false.
			*/
			@Deprecated
			public static boolean startCacheTransaction() {
			return false;
			}

			/**
			* Ends the innermost cache transaction and returns whether this was the
			* only running transaction.
			*
			* @return true if this was the only running transaction
			* @deprecated This method no longer has any effect and always returns false.
			*/
			@Deprecated
			public static boolean endCacheTransaction() {
			return false;
			}

			/**
			* Gets the cache entry for the specified URL, or null if none is found.
			* If a non-null value is provided for the HTTP headers map, and the cache
			* entry needs validation, appropriate headers will be added to the map.
			* The input stream of the CacheEntry object should be closed by the caller
			* when access to the underlying file is no longer required.
			*
			* @param url the URL for which a cache entry is requested
			* @param headers a map from HTTP header name to value, to be populated
			* for the returned cache entry
			* @return the cache entry for the specified URL
			* @deprecated This method no longer has any effect and always returns null.
			*/
			@Deprecated
			public static CacheResult getCacheFile(String url,
			Map<String, String> headers) {
			return null;
			}

			/**
			* Adds a cache entry to the HTTP cache for the specicifed URL. Also closes
			* the cache entry's output stream.
			*
			* @param url the URL for which the cache entry should be added
			* @param cacheResult the cache entry to add
			* @deprecated Access to the HTTP cache will be removed in a future release.
			*/
			@Deprecated
			public static void saveCacheFile(String url, CacheResult cacheResult) {
			saveCacheFile(url, 0, cacheResult);
			}

			static void saveCacheFile(String url, long postIdentifier,
			CacheResult cacheRet) {
			try {
			cacheRet.outStream.close();
			} catch (IOException e) {
			return;
			}

			// This method is exposed in the public API but the API provides no
			// way to obtain a new CacheResult object with a non-null output
			// stream ...
			// - CacheResult objects returned by getCacheFile() have a null
			// output stream.
			// - new CacheResult objects have a null output stream and no
			// setter is provided.
			// Since this method throws a null pointer exception in this case,
			// it is effectively useless from the point of view of the public
			// API.
			//
			// With the Chromium HTTP stack we continue to throw the same
			// exception for 'backwards compatibility' with the Android HTTP
			// stack.
			//
			// This method is not used from within this package, and for public API
			// use, we should already have thrown an exception above.
			assert false;
			}
			}

core/java/android/webkit/PluginData.java

0 → 100644

+141 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2009 The Android Open Source Project
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package android.webkit;

			import java.io.InputStream;
			import java.util.Map;

			/**
			* This class encapsulates the content generated by a plugin. The
			* data itself is meant to be loaded into webkit via the
			* PluginContentLoader class, which needs to be able to construct an
			* HTTP response. For this, it needs a stream with the response body,
			* the length of the body, the response headers, and the response
			* status code. The PluginData class is the container for all these
			* parts.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public final class PluginData {
			/**
			* The content stream.
			*/
			private InputStream mStream;
			/**
			* The content length.
			*/
			private long mContentLength;
			/**
			* The associated HTTP response headers stored as a map of
			* lowercase header name to [ unmodified header name, header value].
			* TODO: This design was always a hack. Remove (involves updating
			* the Gears C++ side).
			*/
			private Map<String, String[]> mHeaders;

			/**
			* The associated HTTP response code.
			*/
			private int mStatusCode;

			/**
			* Creates a PluginData instance.
			*
			* @param stream The stream that supplies content for the plugin.
			* @param length The length of the plugin content.
			* @param headers The response headers. Map of
			* lowercase header name to [ unmodified header name, header value]
			* @param length The HTTP response status code.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public PluginData(
			InputStream stream,
			long length,
			Map<String, String[]> headers,
			int code) {
			mStream = stream;
			mContentLength = length;
			mHeaders = headers;
			mStatusCode = code;
			}

			/**
			* Returns the input stream that contains the plugin content.
			*
			* @return An InputStream instance with the plugin content.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public InputStream getInputStream() {
			return mStream;
			}

			/**
			* Returns the length of the plugin content.
			*
			* @return the length of the plugin content.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public long getContentLength() {
			return mContentLength;
			}

			/**
			* Returns the HTTP response headers associated with the plugin
			* content.
			*
			* @return A Map<String, String[]> containing all headers. The
			* mapping is 'lowercase header name' to ['unmodified header
			* name', header value].
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public Map<String, String[]> getHeaders() {
			return mHeaders;
			}

			/**
			* Returns the HTTP status code for the response.
			*
			* @return The HTTP statue code, e.g 200.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public int getStatusCode() {
			return mStatusCode;
			}
			}

core/java/android/webkit/UrlInterceptHandler.java

0 → 100644

+60 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2008 The Android Open Source Project
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package android.webkit;

			import android.webkit.CacheManager.CacheResult;
			import android.webkit.PluginData;
			import java.util.Map;

			/**
			* @hide
			* @deprecated This interface was inteded to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public interface UrlInterceptHandler {

			/**
			* Given an URL, returns the CacheResult which contains the
			* surrogate response for the request, or null if the handler is
			* not interested.
			*
			* @param url URL string.
			* @param headers The headers associated with the request. May be null.
			* @return The CacheResult containing the surrogate response.
			*
			* @hide
			* @deprecated Do not use, this interface is deprecated.
			*/
			@Deprecated
			public CacheResult service(String url, Map<String, String> headers);

			/**
			* Given an URL, returns the PluginData which contains the
			* surrogate response for the request, or null if the handler is
			* not interested.
			*
			* @param url URL string.
			* @param headers The headers associated with the request. May be null.
			* @return The PluginData containing the surrogate response.
			*
			* @hide
			* @deprecated Do not use, this interface is deprecated.
			*/
			@Deprecated
			public PluginData getPluginData(String url, Map<String, String> headers);
			}

core/java/android/webkit/UrlInterceptRegistry.java

0 → 100644

+167 −0

Original line number	Original line	Diff line number	Diff line
			/*
			* Copyright (C) 2008 The Android Open Source Project
			*
			* Licensed under the Apache License, Version 2.0 (the "License");
			* you may not use this file except in compliance with the License.
			* You may obtain a copy of the License at
			*
			* http://www.apache.org/licenses/LICENSE-2.0
			*
			* Unless required by applicable law or agreed to in writing, software
			* distributed under the License is distributed on an "AS IS" BASIS,
			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
			* See the License for the specific language governing permissions and
			* limitations under the License.
			*/

			package android.webkit;

			import android.webkit.CacheManager.CacheResult;
			import android.webkit.PluginData;
			import android.webkit.UrlInterceptHandler;

			import java.util.Iterator;
			import java.util.LinkedList;
			import java.util.Map;

			/**
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public final class UrlInterceptRegistry {

			private final static String LOGTAG = "intercept";

			private static boolean mDisabled = false;

			private static LinkedList mHandlerList;

			private static synchronized LinkedList getHandlers() {
			if(mHandlerList == null)
			mHandlerList = new LinkedList<UrlInterceptHandler>();
			return mHandlerList;
			}

			/**
			* set the flag to control whether url intercept is enabled or disabled
			*
			* @param disabled true to disable the cache
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public static synchronized void setUrlInterceptDisabled(boolean disabled) {
			mDisabled = disabled;
			}

			/**
			* get the state of the url intercept, enabled or disabled
			*
			* @return return if it is disabled
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public static synchronized boolean urlInterceptDisabled() {
			return mDisabled;
			}

			/**
			* Register a new UrlInterceptHandler. This handler will be called
			* before any that were previously registered.
			*
			* @param handler The new UrlInterceptHandler object
			* @return true if the handler was not previously registered.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public static synchronized boolean registerHandler(
			UrlInterceptHandler handler) {
			if (!getHandlers().contains(handler)) {
			getHandlers().addFirst(handler);
			return true;
			} else {
			return false;
			}
			}

			/**
			* Unregister a previously registered UrlInterceptHandler.
			*
			* @param handler A previously registered UrlInterceptHandler.
			* @return true if the handler was found and removed from the list.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public static synchronized boolean unregisterHandler(
			UrlInterceptHandler handler) {
			return getHandlers().remove(handler);
			}

			/**
			* Given an url, returns the CacheResult of the first
			* UrlInterceptHandler interested, or null if none are.
			*
			* @return A CacheResult containing surrogate content.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public static synchronized CacheResult getSurrogate(
			String url, Map<String, String> headers) {
			if (urlInterceptDisabled()) {
			return null;
			}
			Iterator iter = getHandlers().listIterator();
			while (iter.hasNext()) {
			UrlInterceptHandler handler = (UrlInterceptHandler) iter.next();
			CacheResult result = handler.service(url, headers);
			if (result != null) {
			return result;
			}
			}
			return null;
			}

			/**
			* Given an url, returns the PluginData of the first
			* UrlInterceptHandler interested, or null if none are or if
			* intercepts are disabled.
			*
			* @return A PluginData instance containing surrogate content.
			*
			* @hide
			* @deprecated This class was intended to be used by Gears. Since Gears was
			* deprecated, so is this class.
			*/
			@Deprecated
			public static synchronized PluginData getPluginData(
			String url, Map<String, String> headers) {
			if (urlInterceptDisabled()) {
			return null;
			}
			Iterator iter = getHandlers().listIterator();
			while (iter.hasNext()) {
			UrlInterceptHandler handler = (UrlInterceptHandler) iter.next();
			PluginData data = handler.getPluginData(url, headers);
			if (data != null) {
			return data;
			}
			}
			return null;
			}
			}