com.salesforce.androidsdk.smartstore.app

Class SmartStoreSDKManager

java.lang.Object

SalesforceSDKManager

com.salesforce.androidsdk.smartstore.app.SmartStoreSDKManager

Direct Known Subclasses:

MobileSyncSDKManager

public class SmartStoreSDKManager
extends SalesforceSDKManager

SDK Manager for all native applications that use SmartStore

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GLOBAL_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SmartStoreSDKManager(Context context, java.lang.Class<? extends Activity> mainActivity, java.lang.Class<? extends Activity> loginActivity, java.lang.Class<? extends Activity> nativeLoginActivity) Protected constructor.

Method Summary

Modifier and Type	Method and Description
protected void	cleanUp(UserAccount userAccount)
protected java.util.Map<java.lang.String,DevActionHandler>	getDevActions(Activity frontActivity)
java.util.List<java.lang.String>	getDevSupportInfos()
KeyValueEncryptedFileStore	getGlobalKeyValueStore(java.lang.String storeName) Get global key value store with given name
java.util.List<java.lang.String>	getGlobalKeyValueStoresPrefixList() Returns a list of global key value store names.
SmartStore	getGlobalSmartStore() Return default database used by smart store in the global context
SmartStore	getGlobalSmartStore(java.lang.String dbName) Returns the database used by smart store in the global context.
java.util.List<java.lang.String>	getGlobalStoresPrefixList() Returns a list of global store names.
static SmartStoreSDKManager	getInstance() Returns a singleton instance of this class.
KeyValueEncryptedFileStore	getKeyValueStore(java.lang.String storeName) Get key value store with given name for current user
KeyValueEncryptedFileStore	getKeyValueStore(java.lang.String storeName, UserAccount account) Get key value store with given name for given user
KeyValueEncryptedFileStore	getKeyValueStore(java.lang.String storeName, UserAccount account, java.lang.String communityId) Get key value store with given name for given user / community
java.util.List<java.lang.String>	getKeyValueStoresPrefixList() Returns a list of key value store names for current user.
java.util.List<java.lang.String>	getKeyValueStoresPrefixList(UserAccount account) Returns a list of key value store names for given user.
SmartStore	getSmartStore() Returns the database used by smart store for the current user.
SmartStore	getSmartStore(java.lang.String dbNamePrefix, UserAccount account, java.lang.String communityId) Returns the database used by smart store for a specified database name and user in the specified community.
SmartStore	getSmartStore(UserAccount account) Returns the database used by smart store for a specified user.
SmartStore	getSmartStore(UserAccount account, java.lang.String communityId) Returns the database used by smart store for a specified user in the specified community.
java.util.List<java.lang.String>	getUserStoresPrefixList() Returns a list of store names for current user.
java.util.List<java.lang.String>	getUserStoresPrefixList(UserAccount account) Returns a list of store names for given user.
boolean	hasGlobalKeyValueStore(java.lang.String storeName) Return whether there is a global key value store with given name
boolean	hasGlobalSmartStore(java.lang.String dbName) Returns whether global smart store is enabled or not.
boolean	hasKeyValueStore(java.lang.String storeName) Return whether there is a key value store with given name for current user
boolean	hasKeyValueStore(java.lang.String storeName, UserAccount account) Return whether there is a key value store with given name for given user
boolean	hasKeyValueStore(java.lang.String storeName, UserAccount account, java.lang.String communityId) Return whether there is a key value store with given name for given user / community id
boolean	hasSmartStore() Returns whether smart store is enabled for the current user or not.
boolean	hasSmartStore(java.lang.String dbNamePrefix, UserAccount account, java.lang.String communityId) Returns whether smart store is enabled for the specified database or not.
boolean	hasSmartStore(UserAccount account) Returns whether smart store is enabled for the specified user or not.
boolean	hasSmartStore(UserAccount account, java.lang.String communityId) Returns whether smart store is enabled for the specified community or not.
static void	initNative(Context context, java.lang.Class<? extends Activity> mainActivity) Initializes components required for this class to properly function.
static void	initNative(Context context, java.lang.Class<? extends Activity> mainActivity, java.lang.Class<? extends Activity> loginActivity) Initializes components required for this class to properly function.
static void	initNative(Context context, java.lang.Class<? extends Activity> mainActivity, java.lang.Class<? extends Activity> loginActivity, java.lang.Class<? extends Activity> nativeLoginActivity) Initializes components required for this class to properly function.
void	removeAllGlobalKeyValueStores() Removes all the global key value stores.
void	removeAllGlobalStores() Removes all the global stores.
void	removeAllKeyValueStores() Removes all the key value stores for current user.
void	removeAllKeyValueStores(UserAccount account) Removes all the key value stores for given user.
void	removeAllUserStores() Removes all the stores for current user.
void	removeAllUserStores(UserAccount account) Removes all the stores for current user.
void	removeGlobalKeyValueStore(java.lang.String storeName) Remove global key value store with given name
void	removeGlobalSmartStore(java.lang.String dbName) Removes the global smart store.
void	removeKeyValueStore(java.lang.String storeName) Remove key value store with given name for current user
void	removeKeyValueStore(java.lang.String storeName, UserAccount account) Remove key value store with given name for given user
void	removeKeyValueStore(java.lang.String storeName, UserAccount account, java.lang.String communityId) Remove key value store with given name for given user / community id
void	removeSmartStore() Removes the default smart store for the current user.
void	removeSmartStore(java.lang.String dbNamePrefix, UserAccount account, java.lang.String communityId) Removes the named smart store for the specified user and community.
void	removeSmartStore(UserAccount account) Removes the default smart store for the specified user.
void	removeSmartStore(UserAccount account, java.lang.String communityId) Removes the default smart store for the specified user and community.
void	setupGlobalStoreFromDefaultConfig() Setup global store using config found in res/raw/globalstore.json
void	setupUserStoreFromDefaultConfig() Setup user store using config found in res/raw/userstore.json

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_SUFFIX

public static final java.lang.String GLOBAL_SUFFIX

See Also:

Constant Field Values

Constructor Detail

SmartStoreSDKManager

protected SmartStoreSDKManager(Context context,
                               java.lang.Class<? extends Activity> mainActivity,
                               java.lang.Class<? extends Activity> loginActivity,
                               java.lang.Class<? extends Activity> nativeLoginActivity)

Protected constructor.

Parameters:

context - Application context.

mainActivity - Activity that should be launched after the login flow.

loginActivity - Login activity.

nativeLoginActivity - Native login activity.

Method Detail

initNative

public static void initNative(Context context,
                              java.lang.Class<? extends Activity> mainActivity)

Initializes components required for this class to properly function. This method should be called by native apps using the Salesforce Mobile SDK.

Parameters:

context - Application context.

mainActivity - Activity that should be launched after the login flow.

initNative

public static void initNative(Context context,
                              java.lang.Class<? extends Activity> mainActivity,
                              java.lang.Class<? extends Activity> loginActivity)

Initializes components required for this class to properly function. This method should be called by native apps using the Salesforce Mobile SDK.

Parameters:

context - Application context.

mainActivity - Activity that should be launched after the login flow.

loginActivity - Login activity.

initNative

public static void initNative(Context context,
                              java.lang.Class<? extends Activity> mainActivity,
                              java.lang.Class<? extends Activity> loginActivity,
                              java.lang.Class<? extends Activity> nativeLoginActivity)

Initializes components required for this class to properly function. This method should be called by native apps using the Salesforce Mobile SDK.

Parameters:

context - Application context.

mainActivity - Activity that should be launched after the login flow.

loginActivity - Login activity.

nativeLoginActivity - Native login activity.

getInstance

public static SmartStoreSDKManager getInstance()

Returns a singleton instance of this class.

Returns:

Singleton instance of SalesforceSDKManagerWithSmartStore.

cleanUp

protected void cleanUp(UserAccount userAccount)

getGlobalSmartStore

public SmartStore getGlobalSmartStore()

Return default database used by smart store in the global context

Returns:

SmartStore instance

getGlobalSmartStore

public SmartStore getGlobalSmartStore(java.lang.String dbName)

Returns the database used by smart store in the global context.

Parameters:

dbName - The database name. This must be a valid file name without a filename extension such as ".db". Pass 'null' for default.

Returns:

SmartStore instance.

getSmartStore

public SmartStore getSmartStore()

Returns the database used by smart store for the current user.

Returns:

SmartStore instance.

getSmartStore

public SmartStore getSmartStore(UserAccount account)

Returns the database used by smart store for a specified user.

Parameters:

account - UserAccount instance.

Returns:

SmartStore instance.

getSmartStore

public SmartStore getSmartStore(UserAccount account,
                                java.lang.String communityId)

Returns the database used by smart store for a specified user in the specified community.

Parameters:

account - UserAccount instance.

communityId - Community ID.

Returns:

SmartStore instance.

getSmartStore

public SmartStore getSmartStore(java.lang.String dbNamePrefix,
                                UserAccount account,
                                java.lang.String communityId)

Returns the database used by smart store for a specified database name and user in the specified community.

Parameters:

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

account - UserAccount instance.

communityId - Community ID.

Returns:

SmartStore instance.

hasGlobalSmartStore

public boolean hasGlobalSmartStore(java.lang.String dbName)

Returns whether global smart store is enabled or not.

Parameters:

dbName - Database name. This must be a valid file name without a filename extension such as ".db". Pass 'null' for default.

Returns:

True - if the specified global database exists, False - otherwise.

hasSmartStore

public boolean hasSmartStore()

Returns whether smart store is enabled for the current user or not.

Returns:

True - if the user has a smart store database, False - otherwise.

hasSmartStore

public boolean hasSmartStore(UserAccount account)

Returns whether smart store is enabled for the specified user or not.

Parameters:

account - UserAccount instance.

Returns:

True - if the user has a smart store database, False - otherwise.

hasSmartStore

public boolean hasSmartStore(UserAccount account,
                             java.lang.String communityId)

Returns whether smart store is enabled for the specified community or not.

Parameters:

account - UserAccount instance.

communityId - Community ID.

Returns:

True - if the user has a smart store database, False - otherwise.

hasSmartStore

public boolean hasSmartStore(java.lang.String dbNamePrefix,
                             UserAccount account,
                             java.lang.String communityId)

Returns whether smart store is enabled for the specified database or not.

Parameters:

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

account - UserAccount instance.

communityId - Community ID.

Returns:

True - if the user has a smart store database, False - otherwise.

removeGlobalSmartStore

public void removeGlobalSmartStore(java.lang.String dbName)

Removes the global smart store.

Parameters:

dbName - Database name. This must be a valid file name without a filename extension such as ".db". Pass 'null' for default.

removeSmartStore

public void removeSmartStore()

Removes the default smart store for the current user.

removeSmartStore

public void removeSmartStore(UserAccount account)

Removes the default smart store for the specified user.

Parameters:

account - UserAccount instance.

removeSmartStore

public void removeSmartStore(UserAccount account,
                             java.lang.String communityId)

Removes the default smart store for the specified user and community.

Parameters:

account - UserAccount instance.

communityId - Community ID.

removeSmartStore

public void removeSmartStore(java.lang.String dbNamePrefix,
                             UserAccount account,
                             java.lang.String communityId)

Removes the named smart store for the specified user and community.

Parameters:

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

account - UserAccount instance.

communityId - Community ID.

getGlobalStoresPrefixList

public java.util.List<java.lang.String> getGlobalStoresPrefixList()

Returns a list of global store names.

Returns:

The list of global store names

getUserStoresPrefixList

public java.util.List<java.lang.String> getUserStoresPrefixList()

Returns a list of store names for current user.

Returns:

The list of store names for current user

getUserStoresPrefixList

public java.util.List<java.lang.String> getUserStoresPrefixList(UserAccount account)

Returns a list of store names for given user.

Parameters:

account - user account

Returns:

The list of store names for given user

removeAllGlobalStores

public void removeAllGlobalStores()

Removes all the global stores.

removeAllUserStores

public void removeAllUserStores()

Removes all the stores for current user.

removeAllUserStores

public void removeAllUserStores(UserAccount account)

Removes all the stores for current user.

Parameters:

account - user account

setupGlobalStoreFromDefaultConfig

public void setupGlobalStoreFromDefaultConfig()

Setup global store using config found in res/raw/globalstore.json

setupUserStoreFromDefaultConfig

public void setupUserStoreFromDefaultConfig()

Setup user store using config found in res/raw/userstore.json

getDevActions

protected java.util.Map<java.lang.String,DevActionHandler> getDevActions(Activity frontActivity)

getDevSupportInfos

public java.util.List<java.lang.String> getDevSupportInfos()

getKeyValueStore

public KeyValueEncryptedFileStore getKeyValueStore(java.lang.String storeName)

Get key value store with given name for current user

Parameters:

storeName - store name

Returns:

a KeyValueEncryptedFileStore

getKeyValueStore

public KeyValueEncryptedFileStore getKeyValueStore(java.lang.String storeName,
                                                   UserAccount account)

Get key value store with given name for given user

Parameters:

storeName - store name

account - user account

Returns:

a KeyValueEncryptedFileStore

getKeyValueStore

public KeyValueEncryptedFileStore getKeyValueStore(java.lang.String storeName,
                                                   UserAccount account,
                                                   java.lang.String communityId)

Get key value store with given name for given user / community

Parameters:

storeName - store name

account - user account

communityId - community id

Returns:

a KeyValueEncryptedFileStore

hasKeyValueStore

public boolean hasKeyValueStore(java.lang.String storeName)

Return whether there is a key value store with given name for current user

hasKeyValueStore

public boolean hasKeyValueStore(java.lang.String storeName,
                                UserAccount account)

Return whether there is a key value store with given name for given user

hasKeyValueStore

public boolean hasKeyValueStore(java.lang.String storeName,
                                UserAccount account,
                                java.lang.String communityId)

Return whether there is a key value store with given name for given user / community id

removeKeyValueStore

public void removeKeyValueStore(java.lang.String storeName)

Remove key value store with given name for current user

removeKeyValueStore

public void removeKeyValueStore(java.lang.String storeName,
                                UserAccount account)

Remove key value store with given name for given user

removeKeyValueStore

public void removeKeyValueStore(java.lang.String storeName,
                                UserAccount account,
                                java.lang.String communityId)

Remove key value store with given name for given user / community id

getKeyValueStoresPrefixList

public java.util.List<java.lang.String> getKeyValueStoresPrefixList()

Returns a list of key value store names for current user.

Returns:

list of store names

getKeyValueStoresPrefixList

public java.util.List<java.lang.String> getKeyValueStoresPrefixList(UserAccount account)

Returns a list of key value store names for given user.

Parameters:

account - user account

Returns:

list of store names

removeAllKeyValueStores

public void removeAllKeyValueStores()

Removes all the key value stores for current user.

removeAllKeyValueStores

public void removeAllKeyValueStores(UserAccount account)

Removes all the key value stores for given user.

Parameters:

account - user account

getGlobalKeyValueStore

public KeyValueEncryptedFileStore getGlobalKeyValueStore(java.lang.String storeName)

Get global key value store with given name

Parameters:

storeName - store name

Returns:

a KeyValueEncryptedFileStore

hasGlobalKeyValueStore

public boolean hasGlobalKeyValueStore(java.lang.String storeName)

Return whether there is a global key value store with given name

removeGlobalKeyValueStore

public void removeGlobalKeyValueStore(java.lang.String storeName)

Remove global key value store with given name

getGlobalKeyValueStoresPrefixList

public java.util.List<java.lang.String> getGlobalKeyValueStoresPrefixList()

Returns a list of global key value store names.

Returns:

The list of global key value store names

removeAllGlobalKeyValueStores

public void removeAllGlobalKeyValueStores()

Removes all the global key value stores.