page.title=Creating a Content Provider
@jd:body
<div id="qv-wrapper">
<div id="qv">
<h2>In this document</h2>
<ol>
<li>
<a href="#DataStorage">Designing Data Storage</a>
</li>
<li>
<a href="#ContentURI">Designing Content URIs</a>
</li>
<li>
<a href="#ContentProvider">Implementing the ContentProvider Class</a>
<ol>
<li>
<a href="#RequiredAccess">Required Methods</a>
</li>
<li>
<a href="#Query">Implementing the query() method</a>
</li>
<li>
<a href="#Insert">Implementing the insert() method</a>
</li>
<li>
<a href="#Delete">Implementing the delete() method</a>
</li>
<li>
<a href="#Update">Implementing the update() method</a>
</li>
<li>
<a href="#OnCreate">Implementing the onCreate() method</a>
</li>
</ol>
</li>
<li>
<a href="#MIMETypes">Implementing Content Provider MIME Types</a>
<ol>
<li>
<a href="#TableMIMETypes">MIME types for tables</a>
</li>
<li>
<a href="#FileMIMETypes">MIME types for files</a>
</li>
</ol>
</li>
<li>
<a href="#ContractClass">Implementing a Contract Class</a>
</li>
<li>
<a href="#Permissions">Implementing Content Provider Permissions</a>
</li>
<li>
<a href="#ProviderElement">The <provider> Element</a>
</li>
<li>
<a href="#Intents">Intents and Data Access</a>
</li>
</ol>
<h2>Key classes</h2>
<ol>
<li>
{@link android.content.ContentProvider}
</li>
<li>
{@link android.database.Cursor}
</li>
<li>
{@link android.net.Uri}
</li>
</ol>
<h2>Related Samples</h2>
<ol>
<li>
<a
href="{@docRoot}resources/samples/NotePad/index.html">
Note Pad sample application
</a>
</li>
</ol>
<h2>See also</h2>
<ol>
<li>
<a href="{@docRoot}guide/topics/providers/content-provider-basics.html">
Content Provider Basics</a>
</li>
<li>
<a href="{@docRoot}guide/topics/providers/calendar-provider.html">
Calendar Provider</a>
</li>
</ol>
</div>
</div>
<p>
A content provider manages access to a central repository of data. You implement a
provider as one or more classes in an Android application, along with elements in
the manifest file. One of your classes implements a subclass
{@link android.content.ContentProvider}, which is the interface between your provider and
other applications. Although content providers are meant to make data available to other
applications, you may of course have activities in your application that allow the user
to query and modify the data managed by your provider.
</p>
<p>
The rest of this topic is a basic list of steps for building a content provider and a list
of APIs to use.
</p>
<!-- Before You Start Building -->
<h2 id="BeforeYouStart">Before You Start Building</h2>
<p>
Before you start building a provider, do the following:
</p>
<ol>
<li>
<strong>Decide if you need a content provider</strong>. You need to build a content
provider if you want to provide one or more of the following features:
<ul>
<li>You want to offer complex data or files to other applications.</li>
<li>You want to allow users to copy complex data from your app into other apps.</li>
<li>You want to provide custom search suggestions using the search framework.</li>
</ul>
<p>
You <em>don't</em> need a provider to use an SQLite database if the use is entirely within
your own application.
</p>
</li>
<li>
If you haven't done so already, read the topic
<a href="{@docRoot}guide/topics/providers/content-provider-basics.html">
Content Provider Basics</a> to learn more about providers.
</li>
</ol>
<p>
Next, follow these steps to build your provider:
</p>
<ol>
<li>
Design the raw storage for your data. A content provider offers data in two ways:
<dl>
<dt>
File data
</dt>
<dd>
Data that normally goes into files, such as
photos, audio, or videos. Store the files in your application's private
space. In response to a request for a file from another application, your
provider can offer a handle to the file.
</dd>
<dt>
"Structured" data
</dt>
<dd>
Data that normally goes into a database, array, or similar structure.
Store the data in a form that's compatible with tables of rows and columns. A row
represents an entity, such as a person or an item in inventory. A column represents
some data for the entity, such a person's name or an item's price. A common way to
store this type of data is in an SQLite database, but you can use any type of
persistent storage. To learn more about the storage types available in the
Android system, see the section <a href="#DataStorage">
Designing Data Storage</a>.
</dd>
</dl>
</li>
<li>
Define a concrete implementation of the {@link android.content.ContentProvider} class and
its required methods. This class is the interface between your data and the rest of the
Android system. For more information about this class, see the section
<a href="#ContentProvider">Implementing the ContentProvider Class</a>.
</li>
<li>
Define the provider's authority string, its content URIs, and column names. If you want
the provider's application to handle intents, also define intent actions, extras data,
and flags. Also define the permissions that you will require for applications that want
to access your data. You should consider defining all of these values as constants in a
separate contract class; later, you can expose this class to other developers. For more
information about content URIs, see the
section <a href="#ContentURI">Designing Content URIs</a>.
For more information about intents, see the
section <a href="#Intents">Intents and Data Access</a>.
</li>
<li>
Add other optional pieces, such as sample data or an implementation
of {@link android.content.AbstractThreadedSyncAdapter} that can synchronize data between
the provider and cloud-based data.
</li>
</ol>
<!-- Designing Data Storage -->
<h2 id="DataStorage">Designing Data Storage</h2>
<p>
A content provider is the interface to data saved in a structured format. Before you create
the interface, you must decide how to store the data. You can store the data in any form you
like, and then design the interface to read and write the data as necessary.
</p>
<p>
These are some of the data storage technologies that are available in Android:
</p>
<ul>
<li>
The Android system includes an SQLite database API that Android's own providers use
to store table-oriented data. The
{@link android.database.sqlite.SQLiteOpenHelper} class helps you create databases, and the
{@link android.database.sqlite.SQLiteDatabase} class is the base class for accessing
databases.
<p>
Remember that you don't have to use a database to implement your repository. A provider
appears externally as a set of tables, similar to a relational database, but this is
not a requirement for the provider's internal implementation.
</p>
</li>
<li>
For storing file data, Android has a variety of file-oriented APIs.
To learn more about file storage, read the topic
<a href="{@docRoot}guide/topics/data/data-storage.html">Data Storage</a>. If you're
designing a provider that offers media-related data such as music or videos, you can
have a provider that combines table data and files.
</li>
<li>
For working with network-based data, use classes in {@link java.net} and
{@link android.net}. You can also synchronize network-based data to a local data
store such as a database, and then offer the data as tables or files.
The <a href="{@docRoot}resources/samples/SampleSyncAdapter/index.html">
Sample Sync Adapter</a> sample application demonstrates this type of synchronization.
</li>
</ul>
<h3 id="DataDesign">
Data design considerations
</h3>
<p>
Here are some tips for designing your provider's data structure:
</p>
<ul>
<li>
Table data should always have a "primary key" column that the provider maintains
as a unique numeric value for each row. You can use this value to link the row to related
rows in other tables (using it as a "foreign key"). Although you can use any name
for this column, using {@link android.provider.BaseColumns#_ID BaseColumns._ID} is the best
choice, because linking the results of a provider query to a
{@link android.widget.ListView} requires one of the retrieved columns to have the name
<code>_ID</code>.
</li>
<li>
If you want to provide bitmap images or other very large pieces of file-oriented data, store
the data in a file and then provide it indirectly rather than storing it directly in a
table. If you do this, you need to tell users of your provider that they need to use a
{@link android.content.ContentResolver} file method to access the data.
</li>
<li>
Use the Binary Large OBject (BLOB) data type to store data that varies in size or has a
varying structure. For example, you can use a BLOB column to store a
<a href="http://code.google.com/p/protobuf">protocol buffer</a> or
<a href="http://www.json.org">JSON structure</a>.
<p>
You can also use a BLOB to implement a <em>schema-independent</em> table. In
this type of table, you define a primary key column, a MIME type column, and one or
more generic columns as BLOB. The meaning of the data in the BLOB columns is indicated
by the value in the MIME type column. This allows you to store different row types in
the same table. The Contacts Provider's "data" table
{@link android.provider.ContactsContract.Data} is an example of a schema-independent
table.
</p>
</li>
</ul>
<!-- Designing Content URIs -->
<h2 id="ContentURI">Designing Content URIs</h2>
<p>
A <strong>content URI</strong> is a URI that identifies data in a provider. Content URIs include
the symbolic name of the entire provider (its <strong>authority</strong>) and a
name that points to a table or file (a <strong>path</strong>). The optional id part points to
an individual row in a table. Every data access method of
{@link android.content.ContentProvider} has a content URI as an argument; this allows you to
determine the table, row, or file to access.
</p>
<p>
The basics of content URIs are described in the topic
<a href="{@docRoot}guide/topics/providers/content-provider-basics.html">
Content Provider Basics</a>.
</p>
<h3>Designing an authority</h3>
<p>
A provider usually has a single authority, which serves as its Android-internal name. To
avoid conflicts with other providers, you should use Internet domain ownership (in reverse)
as the basis of your provider authority. Because this recommendation is also true for Android
package names, you can define your provider authority as an extension of the name
of the package containing the provider. For example, if your Android package name is
<code>com.example.<appname></code>, you should give your provider the
authority <code>com.example.<appname>.provider</code>.
</p>
<h3>Designing a path structure</h3>
<p>
Developers usually create content URIs from the authority by appending paths that point to
individual tables. For example, if you have two tables <em>table1</em> and
<em>table2</em>, you combine the authority from the previous example to yield the
content URIs
<code>com.example.<appname>.provider/table1</code> and
<code>com.example.<appname>.provider/table2</code>. Paths aren't
limited to a single segment, and there doesn't have to be a table for each level of the path.
</p>
<h3>Handling content URI IDs</h3>
<p>
By convention, providers offer access to a single row in a table by accepting a content URI
with an ID value for the row at the end of the URI. Also by convention, providers match the
ID value to the table's <code>_ID</code> column, and perform the requested access against the
row that matches.
</p>
<p>
This convention facilitates a common design pattern for apps accessing a provider. The app
does a query against the provider and displays the resulting {@link android.database.Cursor}
in a {@link android.widget.ListView} using a {@link android.widget.CursorAdapter}.
The definition of {@link android.widget.CursorAdapter} requires one of the columns in the
{@link android.database.Cursor} to be <code>_ID</code>
</p>
<p>
The user then picks one of the displayed rows from the UI in order to look at or modify the
data. The app gets the corresponding row from the {@link android.database.Cursor} backing the
{@link android.widget.ListView}, gets the <code>_ID</code> value for this row, appends it to
the content URI, and sends the access request to the provider. The provider can then do the
query or modification against the exact row the user picked.
</p>
<h3>Content URI patterns</h3>
<p>
To help you choose which action to take for an incoming content URI, the provider API includes
the convenience class {@link android.content.UriMatcher}, which maps content URI "patterns" to
integer values. You can use the integer values in a <code>switch</code> statement that
chooses the desired action for the content URI or URIs that match a particular pattern.
</p>
<p>
A content URI pattern matches content URIs using wildcard characters:
</p>
<ul>
<li>
<strong><code>*</code>:</strong> Matches a string of any valid characters of any length.
</li>
<li>
<strong><code>#</code>:</strong> Matches a string of numeric characters of any length.
</li>
</ul>
<p>
As an example of designing and coding content URI handling, consider a provider with the
authority <code>com.example.app.provider</code> that recognizes the following content URIs
pointing to tables:
</p>
<ul>
<li>
<code>content://com.example.app.provider/table1</code>: A table called <code>table1</code>.
</li>
<li>
<code>content://com.example.app.provider/table2/dataset1</code>: A table called
<code>dataset1</code>.
</li>
<li>
<code>content://com.example.app.provider/table2/dataset2</code>: A table called
<code>dataset2</code>.
</li>
<li>
<code>content://com.example.app.provider/table3</code>: A table called <code>table3</code>.
</li>
</ul>
<p>
The provider also recognizes these content URIs if they have a row ID appended to them, as
for example <code>content://com.example.app.provider/table3/1</code> for the row identified by
<code>1</code> in <code>table3</code>.
</p>
<p>
The following content URI patterns would be possible:
</p>
<dl>
<dt>
<code>content://com.example.app.provider/*</code>
</dt>
<dd>
Matches any content URI in the provider.
</dd>
<dt>
<code>content://com.example.app.provider/table2/*</code>:
</dt>
<dd>
Matches a content URI for the tables <code>dataset1</code>
and <code>dataset2</code>, but doesn't match content URIs for <code>table1</code> or
<code>table3</code>.
</dd>
<dt>
<code>content://com.example.app.provider/table3/#</code>: Matches a content URI
for single rows in <code>table3</code>, such as
<code>content://com.example.app.provider/table3/6</code> for the row identified by
<code>6</code>.
</dt>
</dl>
<p>
The following code snippet shows how the methods in {@link android.content.UriMatcher} work.
This code handles URIs for an entire table differently from URIs for a
single row, by using the content URI pattern
<code>content://<authority>/<path></code> for tables, and
<code>content://<authority>/<path>/<id></code> for single rows.
</p>
<p>
The method {@link android.content.UriMatcher#addURI(String, String, int) addURI()} maps an
authority and path to an integer value. The method {@link android.content.UriMatcher#match(Uri)
match()} returns the integer value for a URI. A <code>switch</code> statement
chooses between querying the entire table, and querying for a single record:
</p>
<pre class="prettyprint">
public class ExampleProvider extends ContentProvider {
...
// Creates a UriMatcher object.
private static final UriMatcher sUriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
static {
/*
* The calls to addURI() go here, for all of the content URI patterns that the provider
* should recognize. For this snippet, only the calls for table 3 are shown.
*/
/*
* Sets the integer value for multiple rows in table 3 to 1. Notice that no wildcard is used
* in the path
*/
sUriMatcher.addURI("com.example.app.provider", "table3", 1);
/*
* Sets the code for a single row to 2. In this case, the "#" wildcard is
* used. "content://com.example.app.provider/table3/3" matches, but
* "content://com.example.app.provider/table3 doesn't.
*/
sUriMatcher.addURI("com.example.app.provider", "table3/#", 2);
}
...
// Implements ContentProvider.query()
public Cursor query(
Uri uri,
String[] projection,
String selection,
String[] selectionArgs,
String sortOrder) {
...
/*
* Choose the table to query and a sort order based on the code returned for the incoming
* URI. Here, too, only the statements for table 3 are shown.
*/
switch (sUriMatcher.match(uri)) {
// If the incoming URI was for all of table3
case 1:
if (TextUtils.isEmpty(sortOrder)) sortOrder = "_ID ASC";
break;
// If the incoming URI was for a single row
case 2:
/*
* Because this URI was for a single row, the _ID value part is
* present. Get the last path segment from the URI; this is the _ID value.
* Then, append the value to the WHERE clause for the query
*/
selection = selection + "_ID = " uri.getLastPathSegment();
break;
default:
...
// If the URI is not recognized, you should do some error handling here.
}
// call the code to actually do the query
}
</pre>
<p>
Another class, {@link android.content.ContentUris}, provides convenience methods for working
with the <code>id</code> part of content URIs. The classes {@link android.net.Uri} and
{@link android.net.Uri.Builder} include convenience methods for parsing existing
{@link android.net.Uri} objects and building new ones.
</p>
<!-- Implementing the ContentProvider class -->
<h2 id="ContentProvider">Implementing the ContentProvider Class</h2>
<p>
The {@link android.content.ContentProvider} instance manages access
to a structured set of data by handling requests from other applications. All forms
of access eventually call {@link android.content.ContentResolver}, which then calls a concrete
method of {@link android.content.ContentProvider} to get access.
</p>
<h3 id="RequiredAccess">Required methods</h3>
<p>
The abstract class {@link android.content.ContentProvider} defines six abstract methods that
you must implement as part of your own concrete subclass. All of these methods except
{@link android.content.ContentProvider#onCreate() onCreate()} are called by a client application
that is attempting to access your content provider:
</p>
<dl>
<dt>
{@link android.content.ContentProvider#query(Uri, String[], String, String[], String)
query()}
</dt>
<dd>
Retrieve data from your provider. Use the arguments to select the table to
query, the rows and columns to return, and the sort order of the result.
Return the data as a {@link android.database.Cursor} object.
</dd>
<dt>
{@link android.content.ContentProvider#insert(Uri, ContentValues) insert()}
</dt>
<dd>
Insert a new row into your provider. Use the arguments to select the
destination table and to get the column values to use. Return a content URI for the
newly-inserted row.
</dd>
<dt>
{@link android.content.ContentProvider#update(Uri, ContentValues, String, String[])
update()}
</dt>
<dd>
Update existing rows in your provider. Use the arguments to select the table and rows
to update and to get the updated column values. Return the number of rows updated.
</dd>
<dt>
{@link android.content.ContentProvider#delete(Uri, String, String[]) delete()}
</dt>
<dd>
Delete rows from your provider. Use the arguments to select the table and the rows to
delete. Return the number of rows deleted.
</dd>
<dt>
{@link android.content.ContentProvider#getType(Uri) getType()}
</dt>
<dd>
Return the MIME type corresponding to a content URI. This method is described in more
detail in the section <a href="#MIMETypes">Implementing Content Provider MIME Types</a>.
</dd>
<dt>
{@link android.content.ContentProvider#onCreate() onCreate()}
</dt>
<dd>
Initialize your provider. The Android system calls this method immediately after it
creates your provider. Notice that your provider is not created until a
{@link android.content.ContentResolver} object tries to access it.
</dd>
</dl>
<p>
Notice that these methods have the same signature as the identically-named
{@link android.content.ContentResolver} methods.
</p>
<p>
Your implementation of these methods should account for the following:
</p>
<ul>
<li>
All of these methods except {@link android.content.ContentProvider#onCreate() onCreate()}
can be called by multiple threads at once, so they must be thread-safe. To learn
more about multiple threads, see the topic
<a href="{@docRoot}guide/components/processes-and-threads.html">
Processes and Threads</a>.
</li>
<li>
Avoid doing lengthy operations in {@link android.content.ContentProvider#onCreate()
onCreate()}. Defer initialization tasks until they are actually needed.
The section <a href="#OnCreate">Implementing the onCreate() method</a>
discusses this in more detail.
</li>
<li>
Although you must implement these methods, your code does not have to do anything except
return the expected data type. For example, you may want to prevent other applications
from inserting data into some tables. To do this, you can ignore the call to
{@link android.content.ContentProvider#insert(Uri, ContentValues) insert()} and return
0.
</li>
</ul>
<h3 id="Query">Implementing the query() method</h3>
<p>
The
{@link android.content.ContentProvider#query(Uri, String[], String, String[], String)
ContentProvider.query()} method must return a {@link android.database.Cursor} object, or if it
fails, throw an {@link java.lang.Exception}. If you are using an SQLite database as your data
storage, you can simply return the {@link android.database.Cursor} returned by one of the
<code>query()</code> methods of the {@link android.database.sqlite.SQLiteDatabase} class.
If the query does not match any rows, you should return a {@link android.database.Cursor}
instance whose {@link android.database.Cursor#getCount()} method returns 0.
You should return <code>null</code> only if an internal error occurred during the query process.
</p>
<p>
If you aren't using an SQLite database as your data storage, use one of the concrete subclasses
of {@link android.database.Cursor}. For example, the {@link android.database.MatrixCursor} class
implements a cursor in which each row is an array of {@link java.lang.Object}. With this class,
use {@link android.database.MatrixCursor#addRow(Object[]) addRow()} to add a new row.
</p>
<p>
Remember that the Android system must be able to communicate the {@link java.lang.Exception}
across process boundaries. Android can do this for the following exceptions that may be useful
in handling query errors:
</p>
<ul>
<li>
{@link java.lang.IllegalArgumentException} (You may choose to throw this if your provider
receives an invalid content URI)
</li>
<li>
{@link java.lang.NullPointerException}
</li>
</ul>
<h3 id="Insert">Implementing the insert() method</h3>
<p>
The {@link android.content.ContentProvider#insert(Uri, ContentValues) insert()} method adds a
new row to the appropriate table, using the values in the {@link android.content.ContentValues}
argument. If a column name is not in the {@link android.content.ContentValues} argument, you
may want to provide a default value for it either in your provider code or in your database
schema.
</p>
<p>
This method should return the content URI for the new row. To construct this, append the new
row's <code>_ID</code> (or other primary key) value to the table's content URI, using
{@link android.content.ContentUris#withAppendedId(Uri, long) withAppendedId()}.
</p>
<h3 id="Delete">Implementing the delete() method</h3>
<p>
The {@link android.content.ContentProvider#delete(Uri, String, String[]) delete()} method
does not have to physically delete rows from your data storage. If you are using a sync adapter
with your provider, you should consider marking a deleted row
with a "delete" flag rather than removing the row entirely. The sync adapter can
check for deleted rows and remove them from the server before deleting them from the provider.
</p>
<h3 id="Update">Implementing the update() method</h3>
<p>
The {@link android.content.ContentProvider#update(Uri, ContentValues, String, String[])
update()} method takes the same {@link android.content.ContentValues} argument used by
{@link android.content.ContentProvider#insert(Uri, ContentValues) insert()}, and the
same <code>selection</code> and <code>selectionArgs</code> arguments used by
{@link android.content.ContentProvider#delete(Uri, String, String[]) delete()} and
{@link android.content.ContentProvider#query(Uri, String[], String, String[], String)
ContentProvider.query()}. This may allow you to re-use code between these methods.
</p>
<h3 id="OnCreate">Implementing the onCreate() method</h3>
<p>
The Android system calls {@link android.content.ContentProvider#onCreate()
onCreate()} when it starts up the provider. You should perform only fast-running initialization
tasks in this method, and defer database creation and data loading until the provider actually
receives a request for the data. If you do lengthy tasks in
{@link android.content.ContentProvider#onCreate() onCreate()}, you will slow down your
provider's startup. In turn, this will slow down the response from the provider to other
applications.
</p>
<p>
For example, if you are using an SQLite database you can create
a new {@link android.database.sqlite.SQLiteOpenHelper} object in
{@link android.content.ContentProvider#onCreate() ContentProvider.onCreate()},
and then create the SQL tables the first time you open the database. To facilitate this, the
first time you call {@link android.database.sqlite.SQLiteOpenHelper#getWritableDatabase
getWritableDatabase()}, it automatically calls the
{@link android.database.sqlite.SQLiteOpenHelper#onCreate(SQLiteDatabase)
SQLiteOpenHelper.onCreate()} method.
</p>
<p>
The following two snippets demonstrate the interaction between
{@link android.content.ContentProvider#onCreate() ContentProvider.onCreate()} and
{@link android.database.sqlite.SQLiteOpenHelper#onCreate(SQLiteDatabase)
SQLiteOpenHelper.onCreate()}. The first snippet is the implementation of
{@link android.content.ContentProvider#onCreate() ContentProvider.onCreate()}:
</p>
<pre class="prettyprint">
public class ExampleProvider extends ContentProvider
/*
* Defines a handle to the database helper object. The MainDatabaseHelper class is defined
* in a following snippet.
*/
private MainDatabaseHelper mOpenHelper;
// Defines the database name
private static final String DBNAME = "mydb";
// Holds the database object
private SQLiteDatabase db;
public boolean onCreate() {
/*
* Creates a new helper object. This method always returns quickly.
* Notice that the database itself isn't created or opened
* until SQLiteOpenHelper.getWritableDatabase is called
*/
mOpenHelper = new MainDatabaseHelper(
getContext(), // the application context
DBNAME, // the name of the database)
null, // uses the default SQLite cursor
1 // the version number
);
return true;
}
...
// Implements the provider's insert method
public Cursor insert(Uri uri, ContentValues values) {
// Insert code here to determine which table to open, handle error-checking, and so forth
...
/*
* Gets a writeable database. This will trigger its creation if it doesn't already exist.
*
*/
db = mOpenHelper.getWritableDatabase();
}
}
</pre>
<p>
The next snippet is the implementation of
{@link android.database.sqlite.SQLiteOpenHelper#onCreate(SQLiteDatabase)
SQLiteOpenHelper.onCreate()}, including a helper class:
</p>
<pre class="prettyprint">
...
// A string that defines the SQL statement for creating a table
private static final String SQL_CREATE_MAIN = "CREATE TABLE " +
"main " + // Table's name
"(" + // The columns in the table
" _ID INTEGER PRIMARY KEY, " +
" WORD TEXT"
" FREQUENCY INTEGER " +
" LOCALE TEXT )";
...
/**
* Helper class that actually creates and manages the provider's underlying data repository.
*/
protected static final class MainDatabaseHelper extends SQLiteOpenHelper {
/*
* Instantiates an open helper for the provider's SQLite data repository
* Do not do database creation and upgrade here.
*/
MainDatabaseHelper(Context context) {
super(context, DBNAME, null, 1);
}
/*
* Creates the data repository. This is called when the provider attempts to open the
* repository and SQLite reports that it doesn't exist.
*/
public void onCreate(SQLiteDatabase db) {
// Creates the main table
db.execSQL(SQL_CREATE_MAIN);
}
}
</pre>
<!-- Implementing ContentProvider MIME Types -->
<h2 id="MIMETypes">Implementing ContentProvider MIME Types</h2>
<p>
The {@link android.content.ContentProvider} class has two methods for returning MIME types:
</p>
<dl>
<dt>
{@link android.content.ContentProvider#getType(Uri) getType()}
</dt>
<dd>
One of the required methods that you must implement for any provider.
</dd>
<dt>
{@link android.content.ContentProvider#getStreamTypes(Uri, String) getStreamTypes()}
</dt>
<dd>
A method that you're expected to implement if your provider offers files.
</dd>
</dl>
<h3 id="TableMIMETypes">MIME types for tables</h3>
<p>
The {@link android.content.ContentProvider#getType(Uri) getType()} method returns a
{@link java.lang.String} in MIME format that describes the type of data returned by the content
URI argument. The {@link android.net.Uri} argument can be a pattern rather than a specific URI;
in this case, you should return the type of data associated with content URIs that match the
pattern.
</p>
<p>
For common types of data such as as text, HTML, or JPEG,
{@link android.content.ContentProvider#getType(Uri) getType()} should return the standard
MIME type for that data. A full list of these standard types is available on the
<a href="http://www.iana.org/assignments/media-types/index.htm">IANA MIME Media Types</a>
website.
</p>
<p>
For content URIs that point to a row or rows of table data,
{@link android.content.ContentProvider#getType(Uri) getType()} should return
a MIME type in Android's vendor-specific MIME format:
</p>
<ul>
<li>
Type part: <code>vnd</code>
</li>
<li>
Subtype part:
<ul>
<li>
If the URI pattern is for a single row: <code>android.cursor.<strong>item</strong>/</code>
</li>
<li>
If the URI pattern is for more than one row: <code>android.cursor.<strong>dir</strong>/</code>
</li>
</ul>
</li>
<li>
Provider-specific part: <code>vnd.<name></code>.<code><type></code>
<p>
You supply the <code><name></code> and <code><type></code>.
The <code><name></code> value should be globally unique,
and the <code><type></code> value should be unique to the corresponding URI
pattern. A good choice for <code><name></code> is your company's name or
some part of your application's Android package name. A good choice for the
<code><type></code> is a string that identifies the table associated with the
URI.
</p>
</li>
</ul>
<p>
For example, if a provider's authority is
<code>com.example.app.provider</code>, and it exposes a table named
<code>table1</code>, the MIME type for multiple rows in <code>table1</code> is:
</p>
<pre>
vnd.android.cursor.<strong>dir</strong>/vnd.com.example.provider.table1
</pre>
<p>
For a single row of <code>table1</code>, the MIME type is:
</p>
<pre>
vnd.android.cursor.<strong>item</strong>/vnd.com.example.provider.table1
</pre>
<h3 id="FileMIMETypes">MIME types for files</h3>
<p>
If your provider offers files, implement
{@link android.content.ContentProvider#getStreamTypes(Uri, String) getStreamTypes()}.
The method returns a {@link java.lang.String} array of MIME types for the files your provider
can return for a given content URI. You should filter the MIME types you offer by the MIME type
filter argument, so that you return only those MIME types that the client wants to handle.
</p>
<p>
For example, consider a provider that offers photo images as files in <code>.jpg</code>,
<code>.png</code>, and <code>.gif</code> format.
If an application calls {@link android.content.ContentResolver#getStreamTypes(Uri, String)
ContentResolver.getStreamTypes()} with the filter string <code>image/*</code> (something that
is an "image"),
then the {@link android.content.ContentProvider#getStreamTypes(Uri, String)
ContentProvider.getStreamTypes()} method should return the array:
</p>
<pre>
{ "image/jpeg", "image/png", "image/gif"}
</pre>
<p>
If the app is only interested in <code>.jpg</code> files, then it can call
{@link android.content.ContentResolver#getStreamTypes(Uri, String)
ContentResolver.getStreamTypes()} with the filter string <code>*\/jpeg</code>, and
{@link android.content.ContentProvider#getStreamTypes(Uri, String)
ContentProvider.getStreamTypes()} should return:
<pre>
{"image/jpeg"}
</pre>
<p>
If your provider doesn't offer any of the MIME types requested in the filter string,
{@link android.content.ContentProvider#getStreamTypes(Uri, String) getStreamTypes()}
should return <code>null</code>.
</p>
<!-- Implementing a Contract Class -->
<h2 id="ContractClass">Implementing a Contract Class</h2>
<p>
A contract class is a <code>public final</code> class that contains constant definitions for the
URIs, column names, MIME types, and other meta-data that pertain to the provider. The class
establishes a contract between the provider and other applications by ensuring that the provider
can be correctly accessed even if there are changes to the actual values of URIs, column names,
and so forth.
</p>
<p>
A contract class also helps developers because it usually has mnemonic names for its constants,
so developers are less likely to use incorrect values for column names or URIs. Since it's a
class, it can contain Javadoc documentation. Integrated development environments such as
Android Studio can auto-complete constant names from the contract class and display Javadoc for
the constants.
</p>
<p>
Developers can't access the contract class's class file from your application, but they can
statically compile it into their application from a <code>.jar</code> file you provide.
</p>
<p>
The {@link android.provider.ContactsContract} class and its nested classes are examples of
contract classes.
</p>
<h2 id="Permissions">Implementing Content Provider Permissions</h2>
<p>
Permissions and access for all aspects of the Android system are described in detail in the
topic <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a>.
The topic <a href="{@docRoot}guide/topics/data/data-storage.html">Data Storage</a> also
described the security and permissions in effect for various types of storage.
In brief, the important points are:
</p>
<ul>
<li>
By default, data files stored on the device's internal storage are private to your
application and provider.
</li>
<li>
{@link android.database.sqlite.SQLiteDatabase} databases you create are private to your
application and provider.
</li>
<li>
By default, data files that you save to external storage are <em>public</em> and
<em>world-readable</em>. You can't use a content provider to restrict access to files in
external storage, because other applications can use other API calls to read and write them.
</li>
<li>
The method calls for opening or creating files or SQLite databases on your device's internal
storage can potentially give both read and write access to all other applications. If you
use an internal file or database as your provider's repository, and you give it
"world-readable" or "world-writeable" access, the permissions you set for your provider in
its manifest won't protect your data. The default access for files and databases in
internal storage is "private", and for your provider's repository you shouldn't change this.
</li>
</ul>
<p>
If you want to use content provider permissions to control access to your data, then you should
store your data in internal files, SQLite databases, or the "cloud" (for example,
on a remote server), and you should keep files and databases private to your application.
</p>
<h3>Implementing permissions</h3>
<p>
All applications can read from or write to your provider, even if the underlying data is
private, because by default your provider does not have permissions set. To change this,
set permissions for your provider in your manifest file, using attributes or child
elements of the <code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element. You can set permissions that apply to the entire provider,
or to certain tables, or even to certain records, or all three.
</p>
<p>
You define permissions for your provider with one or more
<code><a href="{@docRoot}guide/topics/manifest/permission-element.html">
<permission></a></code> elements in your manifest file. To make the
permission unique to your provider, use Java-style scoping for the
<code><a href="{@docRoot}guide/topics/manifest/permission-element.html#nm">
android:name</a></code> attribute. For example, name the read permission
<code>com.example.app.provider.permission.READ_PROVIDER</code>.
</p>
<p>
The following list describes the scope of provider permissions, starting with the
permissions that apply to the entire provider and then becoming more fine-grained.
More fine-grained permissions take precedence over ones with larger scope:
</p>
<dl>
<dt>
Single read-write provider-level permission
</dt>
<dd>
One permission that controls both read and write access to the entire provider, specified
with the <code><a href="{@docRoot}guide/topics/manifest/provider-element.html#prmsn">
android:permission</a></code> attribute of the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element.
</dd>
<dt>
Separate read and write provider-level permission
</dt>
<dd>
A read permission and a write permission for the entire provider. You specify them
with the <code><a href="{@docRoot}guide/topics/manifest/provider-element.html#rprmsn">
android:readPermission</a></code> and
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#wprmsn">
android:writePermission</a></code> attributes of the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element. They take precedence over the permission required by
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#prmsn">
android:permission</a></code>.
</dd>
<dt>
Path-level permission
</dt>
<dd>
Read, write, or read/write permission for a content URI in your provider. You specify
each URI you want to control with a
<code><a href="{@docRoot}guide/topics/manifest/path-permission-element.html">
<path-permission></a></code> child element of the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element. For each content URI you specify, you can specify a
read/write permission, a read permission, or a write permission, or all three. The read and
write permissions take precedence over the read/write permission. Also, path-level
permission takes precedence over provider-level permissions.
</dd>
<dt>
Temporary permission
</dt>
<dd>
A permission level that grants temporary access to an application, even if the application
doesn't have the permissions that are normally required. The temporary
access feature reduces the number of permissions an application has to request in
its manifest. When you turn on temporary permissions, the only applications that need
"permanent" permissions for your provider are ones that continually access all
your data.
<p>
Consider the permissions you need to implement an email provider and app, when you
want to allow an outside image viewer application to display photo attachments from your
provider. To give the image viewer the necessary access without requiring permissions,
set up temporary permissions for content URIs for photos. Design your email app so
that when the user wants to display a photo, the app sends an intent containing the
photo's content URI and permission flags to the image viewer. The image viewer can
then query your email provider to retrieve the photo, even though the viewer doesn't
have the normal read permission for your provider.
</p>
<p>
To turn on temporary permissions, either set the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#gprmsn">
android:grantUriPermissions</a></code> attribute of the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element, or add one or more
<code><a href="{@docRoot}guide/topics/manifest/grant-uri-permission-element.html">
<grant-uri-permission></a></code> child elements to your
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element. If you use temporary permissions, you have to call
{@link android.content.Context#revokeUriPermission(Uri, int)
Context.revokeUriPermission()} whenever you remove support for a content URI from your
provider, and the content URI is associated with a temporary permission.
</p>
<p>
The attribute's value determines how much of your provider is made accessible.
If the attribute is set to <code>true</code>, then the system will grant temporary
permission to your entire provider, overriding any other permissions that are required
by your provider-level or path-level permissions.
</p>
<p>
If this flag is set to <code>false</code>, then you must add
<code><a href="{@docRoot}guide/topics/manifest/grant-uri-permission-element.html">
<grant-uri-permission></a></code> child elements to your
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element. Each child element specifies the content URI or
URIs for which temporary access is granted.
</p>
<p>
To delegate temporary access to an application, an intent must contain
the {@link android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION} or the
{@link android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION} flags, or both. These
are set with the {@link android.content.Intent#setFlags(int) setFlags()} method.
</p>
<p>
If the <code><a href="{@docRoot}guide/topics/manifest/provider-element.html#gprmsn">
android:grantUriPermissions</a></code> attribute is not present, it's assumed to be
<code>false</code>.
</p>
</dd>
</dl>
<!-- The Provider Element -->
<h2 id="ProviderElement">The <provider> Element</h2>
<p>
Like {@link android.app.Activity} and {@link android.app.Service} components,
a subclass of {@link android.content.ContentProvider}
must be defined in the manifest file for its application, using the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element. The Android system gets the following information from
the element:
<dl>
<dt>
Authority
(<a href="{@docRoot}guide/topics/manifest/provider-element.html#auth">{@code
android:authorities}</a>)
</dt>
<dd>
Symbolic names that identify the entire provider within the system. This
attribute is described in more detail in the section
<a href="#ContentURI">Designing Content URIs</a>.
</dd>
<dt>
Provider class name
(<code>
<a href="{@docRoot}guide/topics/manifest/provider-element.html#nm">android:name</a>
</code>)
</dt>
<dd>
The class that implements {@link android.content.ContentProvider}. This class is
described in more detail in the section
<a href="#ContentProvider">Implementing the ContentProvider Class</a>.
</dd>
<dt>
Permissions
</dt>
<dd>
Attributes that specify the permissions that other applications must have in order to access
the provider's data:
<ul>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#gprmsn">
android:grantUriPermssions</a></code>: Temporary permission flag.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#prmsn">
android:permission</a></code>: Single provider-wide read/write permission.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#rprmsn">
android:readPermission</a></code>: Provider-wide read permission.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#wprmsn">
android:writePermission</a></code>: Provider-wide write permission.
</li>
</ul>
<p>
Permissions and their corresponding attributes are described in more
detail in the section
<a href="#Permissions">Implementing Content Provider Permissions</a>.
</p>
</dd>
<dt>
Startup and control attributes
</dt>
<dd>
These attributes determine how and when the Android system starts the provider, the
process characteristics of the provider, and other run-time settings:
<ul>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#enabled">
android:enabled</a></code>: Flag allowing the system to start the provider.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#exported">
android:exported</a></code>: Flag allowing other applications to use this provider.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#init">
android:initOrder</a></code>: The order in which this provider should be started,
relative to other providers in the same process.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#multi">
android:multiProcess</a></code>: Flag allowing the system to start the provider
in the same process as the calling client.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#proc">
android:process</a></code>: The name of the process in which the provider should
run.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#sync">
android:syncable</a></code>: Flag indicating that the provider's data is to be
sync'ed with data on a server.
</li>
</ul>
<p>
The attributes are fully documented in the dev guide topic for the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code>
element.
</p>
</dd>
<dt>
Informational attributes
</dt>
<dd>
An optional icon and label for the provider:
<ul>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#icon">
android:icon</a></code>: A drawable resource containing an icon for the provider.
The icon appears next to the provider's label in the list of apps in
<em>Settings</em> > <em>Apps</em> > <em>All</em>.
</li>
<li>
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html#label">
android:label</a></code>: An informational label describing the provider or its
data, or both. The label appears in the list of apps in
<em>Settings</em> > <em>Apps</em> > <em>All</em>.
</li>
</ul>
<p>
The attributes are fully documented in the dev guide topic for the
<code><a href="{@docRoot}guide/topics/manifest/provider-element.html">
<provider></a></code> element.
</p>
</dd>
</dl>
<!-- Intent Access -->
<h2 id="Intents">Intents and Data Access</h2>
<p>
Applications can access a content provider indirectly with an {@link android.content.Intent}.
The application does not call any of the methods of {@link android.content.ContentResolver} or
{@link android.content.ContentProvider}. Instead, it sends an intent that starts an activity,
which is often part of the provider's own application. The destination activity is in charge of
retrieving and displaying the data in its UI. Depending on the action in the intent, the
destination activity may also prompt the user to make modifications to the provider's data.
An intent may also contain "extras" data that the destination activity displays
in the UI; the user then has the option of changing this data before using it to modify the
data in the provider.
</p>
<p>
</p>
<p>
You may want to use intent access to help ensure data integrity. Your provider may depend
on having data inserted, updated, and deleted according to strictly defined business logic. If
this is the case, allowing other applications to directly modify your data may lead to
invalid data. If you want developers to use intent access, be sure to document it thoroughly.
Explain to them why intent access using your own application's UI is better than trying to
modify the data with their code.
</p>
<p>
Handling an incoming intent that wishes to modify your provider's data is no different from
handling other intents. You can learn more about using intents by reading the topic
<a href="{@docRoot}guide/components/intents-filters.html">Intents and Intent Filters</a>.
</p>