com.salesforce.androidsdk.smartstore.store

Class DBOpenHelper

java.lang.Object

SQLiteOpenHelper

com.salesforce.androidsdk.smartstore.store.DBOpenHelper

public class DBOpenHelper
extends SQLiteOpenHelper

Helper class to manage SmartStore's database creation and version management.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATABASES
static int	DB_VERSION
static java.lang.String	DEFAULT_DB_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBOpenHelper(java.lang.String encryptionKey, Context context, java.lang.String dbName)

Method Summary

Modifier and Type	Method and Description
static void	changeKey(SQLiteDatabase db, java.lang.String oldKey, java.lang.String newKey) Changes the encryption key on the database.
static void	deleteAllDatabases(Context ctx, UserAccount userAccount) Deletes all databases of given user.
static void	deleteAllUserDatabases(Context ctx) Deletes all remaining authenticated databases.
static void	deleteDatabase(Context ctx, java.lang.String dbNamePrefix, UserAccount account, java.lang.String communityId) Deletes the underlying database for the specified user and community.
static void	deleteDatabase(Context ctx, UserAccount account) Deletes the underlying database for the specified user account.
static void	deleteDatabase(Context ctx, UserAccount account, java.lang.String communityId) Deletes the underlying database for the specified user and community.
static java.util.List<java.lang.String>	getGlobalDatabasePrefixList(Context ctx, UserAccount account, java.lang.String communityId) Returns a list of all prefixes for user databases.
static DBOpenHelper	getOpenHelper(java.lang.String encryptionKey, Context ctx, java.lang.String dbNamePrefix, UserAccount account, java.lang.String communityId) Returns the DBOpenHelper instance for the given database name.
static DBOpenHelper	getOpenHelper(java.lang.String encryptionKey, Context ctx, UserAccount account) Returns the DBOpenHelper instance associated with this user account.
static DBOpenHelper	getOpenHelper(java.lang.String encryptionKey, Context ctx, UserAccount account, java.lang.String communityId) Returns the DBOpenHelper instance associated with this user and community.
static java.util.Map<java.lang.String,DBOpenHelper>	getOpenHelpers() Returns a map of all DBOpenHelper instances created.
static java.util.List<java.lang.String>	getUserDatabasePrefixList(Context ctx, UserAccount account, java.lang.String communityId) Returns a list of all prefixes for user databases.
protected static void	loadLibsIfNeeded(Context context)
void	onConfigure(SQLiteDatabase db)
void	onCreate(SQLiteDatabase db)
void	onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion)
static boolean	removeAllFiles(java.io.File dir) Removes all files and folders in the given directory recursively as well as removes itself.
static boolean	smartStoreExists(Context ctx, java.lang.String dbNamePrefix, UserAccount account, java.lang.String communityId) Determines if a smart store currently exists for the given database name, account and/or community id.
static boolean	smartStoreExists(Context ctx, UserAccount account, java.lang.String communityId) Determines if a smart store currently exists for the given account and/or community id.

Methods inherited from class java.lang.Object

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

Field Detail

DB_VERSION

public static final int DB_VERSION

See Also:

Constant Field Values

DEFAULT_DB_NAME

public static final java.lang.String DEFAULT_DB_NAME

See Also:

Constant Field Values

DATABASES

public static final java.lang.String DATABASES

See Also:

Constant Field Values

Constructor Detail

DBOpenHelper

protected DBOpenHelper(java.lang.String encryptionKey,
                       Context context,
                       java.lang.String dbName)

Method Detail

getOpenHelpers

public static java.util.Map<java.lang.String,DBOpenHelper> getOpenHelpers()

Returns a map of all DBOpenHelper instances created. The key is the database name and the value is the instance itself.

Returns:

Map of DBOpenHelper instances.

getUserDatabasePrefixList

public static java.util.List<java.lang.String> getUserDatabasePrefixList(Context ctx,
                                                                         UserAccount account,
                                                                         java.lang.String communityId)

Returns a list of all prefixes for user databases.

Returns:

List of Database names(prefixes).

getGlobalDatabasePrefixList

public static java.util.List<java.lang.String> getGlobalDatabasePrefixList(Context ctx,
                                                                           UserAccount account,
                                                                           java.lang.String communityId)

Returns a list of all prefixes for user databases.

Returns:

List of Database names(prefixes).

getOpenHelper

public static DBOpenHelper getOpenHelper(java.lang.String encryptionKey,
                                         Context ctx,
                                         UserAccount account)

Returns the DBOpenHelper instance associated with this user account.

Parameters:

encryptionKey - Password for database.

ctx - Context.

account - User account.

Returns:

DBOpenHelper instance.

getOpenHelper

public static DBOpenHelper getOpenHelper(java.lang.String encryptionKey,
                                         Context ctx,
                                         UserAccount account,
                                         java.lang.String communityId)

Returns the DBOpenHelper instance associated with this user and community.

Parameters:

encryptionKey - Password for database.

ctx - Context.

account - User account.

communityId - Community ID.

Returns:

DBOpenHelper instance.

getOpenHelper

public static DBOpenHelper getOpenHelper(java.lang.String encryptionKey,
                                         Context ctx,
                                         java.lang.String dbNamePrefix,
                                         UserAccount account,
                                         java.lang.String communityId)

Returns the DBOpenHelper instance for the given database name.

Parameters:

encryptionKey - password for database.

ctx - Context.

dbNamePrefix - The database name. This must be a valid file name without a filename extension such as ".db".

account - User account. If this method is called before authentication, we will simply return the smart store DB, which is not associated with any user account. Otherwise, we will return a unique database at the community level.

communityId - Community ID.

Returns:

DBOpenHelper instance.

loadLibsIfNeeded

protected static void loadLibsIfNeeded(Context context)

onConfigure

public void onConfigure(SQLiteDatabase db)

onCreate

public void onCreate(SQLiteDatabase db)

onUpgrade

public void onUpgrade(SQLiteDatabase db,
                      int oldVersion,
                      int newVersion)

deleteDatabase

public static void deleteDatabase(Context ctx,
                                  UserAccount account)

Deletes the underlying database for the specified user account.

Parameters:

ctx - Context.

account - User account.

deleteDatabase

public static void deleteDatabase(Context ctx,
                                  UserAccount account,
                                  java.lang.String communityId)

Deletes the underlying database for the specified user and community.

Parameters:

ctx - Context.

account - User account.

communityId - Community ID.

deleteDatabase

public static void deleteDatabase(Context ctx,
                                  java.lang.String dbNamePrefix,
                                  UserAccount account,
                                  java.lang.String communityId)

Deletes the underlying database for the specified user and community.

Parameters:

ctx - Context.

dbNamePrefix - The database name. This must be a valid file name without a filename extension such as ".db".

account - User account.

communityId - Community ID.

deleteAllUserDatabases

public static void deleteAllUserDatabases(Context ctx)

Deletes all remaining authenticated databases. We pass in the key prefix for an organization here, because all authenticated DBs will have to go against an org, which means the org ID will be a part of the DB name. This prevents the global DBs from being removed.

Parameters:

ctx - Context.

deleteAllDatabases

public static void deleteAllDatabases(Context ctx,
                                      UserAccount userAccount)

Deletes all databases of given user.

Parameters:

ctx - Context.

userAccount - User account.

smartStoreExists

public static boolean smartStoreExists(Context ctx,
                                       UserAccount account,
                                       java.lang.String communityId)

Determines if a smart store currently exists for the given account and/or community id.

Parameters:

ctx - Context.

account - User account.

communityId - Community ID.

Returns:

boolean indicating if a smartstore already exists.

smartStoreExists

public static boolean smartStoreExists(Context ctx,
                                       java.lang.String dbNamePrefix,
                                       UserAccount account,
                                       java.lang.String communityId)

Determines if a smart store currently exists for the given database name, account and/or community id.

Parameters:

ctx - Context.

dbNamePrefix - The database name. This must be a valid file name without a filename extension such as ".db".

account - User account.

communityId - Community ID.

Returns:

boolean indicating if a smartstore already exists.

removeAllFiles

public static boolean removeAllFiles(java.io.File dir)

Removes all files and folders in the given directory recursively as well as removes itself.

Parameters:

dir - Directory to remove all files and folders recursively.

Returns:

True if all delete operations were successful. False otherwise.

changeKey

public static void changeKey(SQLiteDatabase db,
                             java.lang.String oldKey,
                             java.lang.String newKey)

Changes the encryption key on the database.

Parameters:

db - Database object.

oldKey - Old encryption key.

newKey - New encryption key.