android.support.v4.content
Class FileProvider

java.lang.Object
  android.content.ContentProvider
      android.support.v4.content.FileProvider

All Implemented Interfaces:

android.content.ComponentCallbacks

public class FileProvider
extends android.content.ContentProvider

Provider to support easy sharing of private files between apps. When paired with features like Context.grantUriPermission(String, Uri, int) or Intent.FLAG_GRANT_READ_URI_PERMISSION, this provider ensures that receiving apps can always open the underlying file.

Apps should generally avoid sending raw filesystem paths across process boundaries, since the receiving app may not have the same access as the sender. Instead, apps should send Uri backed by a provider like FileProvider.

To use this provider, add it to your manifest:

And define one or more filesystem paths your provider should support in an XML resource. This provider will only support files which exist under these defined paths.

Then use getUriForFile(Context, String, File) at runtime to generate a Uri backed by the provider. Since the provider is not exported, these Uri can only be accessed by other apps when you explicitly grant access.

Constructor Summary

FileProvider()

Method Summary

void	attachInfo(android.content.Context context, android.content.pm.ProviderInfo info)
int	delete(android.net.Uri uri, java.lang.String selection, java.lang.String[] selectionArgs)
java.lang.String	getType(android.net.Uri uri)
static android.net.Uri	getUriForFile(android.content.Context context, java.lang.String authority, java.io.File file) Return a Uri that provides access to the given File.
android.net.Uri	insert(android.net.Uri uri, android.content.ContentValues values)
boolean	onCreate()
android.os.ParcelFileDescriptor	openFile(android.net.Uri uri, java.lang.String mode)
android.database.Cursor	query(android.net.Uri uri, java.lang.String[] projection, java.lang.String selection, java.lang.String[] selectionArgs, java.lang.String sortOrder)
int	update(android.net.Uri uri, android.content.ContentValues values, java.lang.String selection, java.lang.String[] selectionArgs)

Methods inherited from class android.content.ContentProvider

bulkInsert, getContext, getPathPermissions, getReadPermission, getWritePermission, isTemporary, onConfigurationChanged, onLowMemory, openAssetFile, openFileHelper, setPathPermissions, setReadPermission, setWritePermission

Methods inherited from class java.lang.Object

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

Constructor Detail

FileProvider

public FileProvider()

Method Detail

onCreate

public boolean onCreate()

Specified by:

onCreate in class android.content.ContentProvider

attachInfo

public void attachInfo(android.content.Context context,
                       android.content.pm.ProviderInfo info)

Overrides:

attachInfo in class android.content.ContentProvider

getUriForFile

public static android.net.Uri getUriForFile(android.content.Context context,
                                            java.lang.String authority,
                                            java.io.File file)

Return a Uri that provides access to the given File. The returned Uri can be used with features like Context.grantUriPermission(String, Uri, int) or Intent.FLAG_GRANT_READ_URI_PERMISSION to allow other apps to access private files. Providers only support files which exist under filesystem paths defined in their <meta-data>.

Parameters:

authority - The authority of a FileProvider defined as a <provider> in your manifest.

Throws:

java.lang.IllegalArgumentException - When the given File is outside the paths supported by the provider.

query

public android.database.Cursor query(android.net.Uri uri,
                                     java.lang.String[] projection,
                                     java.lang.String selection,
                                     java.lang.String[] selectionArgs,
                                     java.lang.String sortOrder)

Specified by:

query in class android.content.ContentProvider

getType

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

Specified by:

getType in class android.content.ContentProvider

insert

public android.net.Uri insert(android.net.Uri uri,
                              android.content.ContentValues values)

Specified by:

insert in class android.content.ContentProvider

update

public int update(android.net.Uri uri,
                  android.content.ContentValues values,
                  java.lang.String selection,
                  java.lang.String[] selectionArgs)

Specified by:

update in class android.content.ContentProvider

delete

public int delete(android.net.Uri uri,
                  java.lang.String selection,
                  java.lang.String[] selectionArgs)

Specified by:

delete in class android.content.ContentProvider

openFile

public android.os.ParcelFileDescriptor openFile(android.net.Uri uri,
                                                java.lang.String mode)
                                         throws java.io.FileNotFoundException

Overrides:

openFile in class android.content.ContentProvider

Throws:

java.io.FileNotFoundException