org.apache.cordova

Class CordovaResourceApi

java.lang.Object

org.apache.cordova.CordovaResourceApi

public class CordovaResourceApi
extends java.lang.Object

What this classes provides: 1. Helpers for reading & writing to URLs. - E.g. handles assets, resources, content providers, files, data URIs, http[s] - E.g. Can be used to query for mime-type & content length. 2. To allow plugins to redirect URLs (via remapUrl). - All plugins should call remapUrl() on URLs they receive from JS *before* passing the URL onto other utility functions in this classes. - For an example usage of this, refer to the org.apache.cordova.file plugin. Future Work: - Consider using a Cursor to query content URLs for their size (like the file plugin does). - Allow plugins to remapUri to "cdv-plugin://plugin-name/foo", which CordovaResourceApi would then delegate to pluginManager.getPlugin(plugin-name).openForRead(url) - Currently, plugins *can* do this by remapping to a data: URL, but it's inefficient for large payloads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CordovaResourceApi.OpenForReadResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Thread	jsThread
static java.lang.String	PLUGIN_URI_SCHEME
static int	URI_TYPE_ASSET
static int	URI_TYPE_CONTENT
static int	URI_TYPE_DATA
static int	URI_TYPE_FILE
static int	URI_TYPE_HTTP
static int	URI_TYPE_HTTPS
static int	URI_TYPE_PLUGIN
static int	URI_TYPE_RESOURCE
static int	URI_TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
CordovaResourceApi(android.content.Context context, PluginManager pluginManager)

Method Summary

Modifier and Type	Method and Description
void	copyResource(CordovaResourceApi.OpenForReadResult input, java.io.OutputStream outputStream)
void	copyResource(android.net.Uri sourceUri, java.io.OutputStream outputStream)
void	copyResource(android.net.Uri sourceUri, android.net.Uri dstUri)
java.net.HttpURLConnection	createHttpConnection(android.net.Uri uri)
java.lang.String	getMimeType(android.net.Uri uri)
static int	getUriType(android.net.Uri uri)
boolean	isThreadCheckingEnabled()
java.io.File	mapUriToFile(android.net.Uri uri) Returns a File that points to the resource, or null if the resource is not on the local filesystem.
CordovaResourceApi.OpenForReadResult	openForRead(android.net.Uri uri) Opens a stream to the given URI, also providing the MIME type & length.
CordovaResourceApi.OpenForReadResult	openForRead(android.net.Uri uri, boolean skipThreadCheck) Opens a stream to the given URI, also providing the MIME type & length.
java.io.OutputStream	openOutputStream(android.net.Uri uri)
java.io.OutputStream	openOutputStream(android.net.Uri uri, boolean append) Opens a stream to the given URI.
java.lang.String	remapPath(java.lang.String path)
android.net.Uri	remapUri(android.net.Uri uri)
void	setThreadCheckingEnabled(boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

URI_TYPE_FILE

public static final int URI_TYPE_FILE

See Also:

Constant Field Values

URI_TYPE_ASSET

public static final int URI_TYPE_ASSET

See Also:

Constant Field Values

URI_TYPE_CONTENT

public static final int URI_TYPE_CONTENT

See Also:

Constant Field Values

URI_TYPE_RESOURCE

public static final int URI_TYPE_RESOURCE

See Also:

Constant Field Values

URI_TYPE_DATA

public static final int URI_TYPE_DATA

See Also:

Constant Field Values

URI_TYPE_HTTP

public static final int URI_TYPE_HTTP

See Also:

Constant Field Values

URI_TYPE_HTTPS

public static final int URI_TYPE_HTTPS

See Also:

Constant Field Values

URI_TYPE_PLUGIN

public static final int URI_TYPE_PLUGIN

See Also:

Constant Field Values

URI_TYPE_UNKNOWN

public static final int URI_TYPE_UNKNOWN

See Also:

Constant Field Values

PLUGIN_URI_SCHEME

public static final java.lang.String PLUGIN_URI_SCHEME

See Also:

Constant Field Values

jsThread

public static java.lang.Thread jsThread

Constructor Detail

CordovaResourceApi

public CordovaResourceApi(android.content.Context context,
                          PluginManager pluginManager)

Method Detail

setThreadCheckingEnabled

public void setThreadCheckingEnabled(boolean value)

isThreadCheckingEnabled

public boolean isThreadCheckingEnabled()

getUriType

public static int getUriType(android.net.Uri uri)

remapUri

public android.net.Uri remapUri(android.net.Uri uri)

remapPath

public java.lang.String remapPath(java.lang.String path)

mapUriToFile

public java.io.File mapUriToFile(android.net.Uri uri)

Returns a File that points to the resource, or null if the resource is not on the local filesystem.

getMimeType

public java.lang.String getMimeType(android.net.Uri uri)

openForRead

public CordovaResourceApi.OpenForReadResult openForRead(android.net.Uri uri)
                                                 throws java.io.IOException

Opens a stream to the given URI, also providing the MIME type & length.

Returns:

Never returns null.

Throws:

Throws - an InvalidArgumentException for relative URIs. Relative URIs should be resolved before being passed into this function.

Throws - an IOException if the URI cannot be opened.

Throws - an IllegalStateException if called on a foreground thread.

java.io.IOException

openForRead

public CordovaResourceApi.OpenForReadResult openForRead(android.net.Uri uri,
                                                        boolean skipThreadCheck)
                                                 throws java.io.IOException

Opens a stream to the given URI, also providing the MIME type & length.

Returns:

Never returns null.

Throws:

Throws - an InvalidArgumentException for relative URIs. Relative URIs should be resolved before being passed into this function.

Throws - an IOException if the URI cannot be opened.

Throws - an IllegalStateException if called on a foreground thread and skipThreadCheck is false.

java.io.IOException

openOutputStream

public java.io.OutputStream openOutputStream(android.net.Uri uri)
                                      throws java.io.IOException

Throws:

java.io.IOException

openOutputStream

public java.io.OutputStream openOutputStream(android.net.Uri uri,
                                             boolean append)
                                      throws java.io.IOException

Opens a stream to the given URI.

Returns:

Never returns null.

Throws:

Throws - an InvalidArgumentException for relative URIs. Relative URIs should be resolved before being passed into this function.

Throws - an IOException if the URI cannot be opened.

java.io.IOException

createHttpConnection

public java.net.HttpURLConnection createHttpConnection(android.net.Uri uri)
                                                throws java.io.IOException

Throws:

java.io.IOException

copyResource

public void copyResource(CordovaResourceApi.OpenForReadResult input,
                         java.io.OutputStream outputStream)
                  throws java.io.IOException

Throws:

java.io.IOException

copyResource

public void copyResource(android.net.Uri sourceUri,
                         java.io.OutputStream outputStream)
                  throws java.io.IOException

Throws:

java.io.IOException

copyResource

public void copyResource(android.net.Uri sourceUri,
                         android.net.Uri dstUri)
                  throws java.io.IOException

Throws:

java.io.IOException