com.salesforce.androidsdk.smartstore.store

Class KeyValueEncryptedFileStore

java.lang.Object

com.salesforce.androidsdk.smartstore.store.KeyValueEncryptedFileStore

All Implemented Interfaces:

KeyValueStore

public class KeyValueEncryptedFileStore
extends java.lang.Object
implements KeyValueStore

Key-value store backed by file system. Currently uses an in-memory solution for encryption and decryption. While this solution is not particularly good from a memory standpoint, we will need to employ this as a workaround for now, until we figure out how we can achieve acceptable performance with a streaming solution, since CipherInputStream is a lot slower with AES-GCM.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_SUFFIX
static java.lang.String	KEY_VALUE_STORES
static int	KV_VERSION
static int	MAX_STORE_NAME_LENGTH
static java.lang.String	VALUE_SUFFIX
static java.lang.String	VERSION_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
KeyValueEncryptedFileStore(Context ctx, java.lang.String storeName, java.lang.String encryptionKey) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	changeEncryptionKey(java.lang.String newEncryptionKey) Change encryption key All files are read/decrypted with old key and encrypted/written back with new key
static java.io.File	computeParentDir(Context ctx) Return parent directory for all key stores
boolean	contains(java.lang.String key) Return true if store contains a file for the given key
int	count()
boolean	deleteAll() Deletes all stored values.
boolean	deleteValue(java.lang.String key) Deletes stored value for given key.
java.io.File	getStoreDir()
java.lang.String	getStoreName()
int	getStoreVersion()
java.io.InputStream	getStream(java.lang.String key) Returns stream for value of given key.
java.lang.String	getValue(java.lang.String key) Returns value stored for given key.
static boolean	hasKeyValueStore(Context ctx, java.lang.String storeName) Return boolean indicating if a key value store with the given (full) name already exists
boolean	isEmpty()
static boolean	isValidStoreName(java.lang.String storeName) Store name can only contain letters, digits and _ and cannot exceed 96 characters
java.util.Set<java.lang.String>	keySet() Get all keys.
static void	removeKeyValueStore(Context ctx, java.lang.String storeName) Remove key value store with given (full) name
boolean	saveStream(java.lang.String key, java.io.InputStream stream) Save value given as an input stream for the given key.
boolean	saveValue(java.lang.String key, java.lang.String value) Save value for the given key.

Methods inherited from class java.lang.Object

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

Field Detail

KV_VERSION

public static final int KV_VERSION

See Also:

Constant Field Values

MAX_STORE_NAME_LENGTH

public static final int MAX_STORE_NAME_LENGTH

See Also:

Constant Field Values

KEY_SUFFIX

public static final java.lang.String KEY_SUFFIX

See Also:

Constant Field Values

VALUE_SUFFIX

public static final java.lang.String VALUE_SUFFIX

See Also:

Constant Field Values

VERSION_FILE_NAME

public static final java.lang.String VERSION_FILE_NAME

See Also:

Constant Field Values

KEY_VALUE_STORES

public static final java.lang.String KEY_VALUE_STORES

See Also:

Constant Field Values

Constructor Detail

KeyValueEncryptedFileStore

public KeyValueEncryptedFileStore(Context ctx,
                                  java.lang.String storeName,
                                  java.lang.String encryptionKey)

Constructor

Parameters:

storeName - name for key value store

encryptionKey - encryption key for key value store

Method Detail

hasKeyValueStore

public static boolean hasKeyValueStore(Context ctx,
                                       java.lang.String storeName)

Return boolean indicating if a key value store with the given (full) name already exists

Parameters:

ctx -

storeName - full store name

Returns:

True - if store was found

removeKeyValueStore

public static void removeKeyValueStore(Context ctx,
                                       java.lang.String storeName)

Remove key value store with given (full) name

Parameters:

ctx -

storeName - full store name

computeParentDir

public static java.io.File computeParentDir(Context ctx)

Return parent directory for all key stores

Parameters:

ctx -

Returns:

File for parent directory

isValidStoreName

public static boolean isValidStoreName(java.lang.String storeName)

Store name can only contain letters, digits and _ and cannot exceed 96 characters

Parameters:

storeName -

Returns:

True if the name provided is valid for a store

contains

public boolean contains(java.lang.String key)

Return true if store contains a file for the given key

Specified by:

contains in interface KeyValueStore

Parameters:

key -

Returns:

saveValue

public boolean saveValue(java.lang.String key,
                         java.lang.String value)

Save value for the given key.

Specified by:

saveValue in interface KeyValueStore

Parameters:

key - Unique identifier.

value - Value to be persisted.

Returns:

True - if successful, False - otherwise.

saveStream

public boolean saveStream(java.lang.String key,
                          java.io.InputStream stream)

Save value given as an input stream for the given key. NB: does not close provided input stream

Specified by:

saveStream in interface KeyValueStore

Parameters:

key - Unique identifier.

stream - Stream to be persisted.

Returns:

True - if successful, False - otherwise.

getValue

public java.lang.String getValue(java.lang.String key)

Returns value stored for given key.

Specified by:

getValue in interface KeyValueStore

Parameters:

key - Unique identifier.

Returns:

value for given key or null if key not found.

getStream

public java.io.InputStream getStream(java.lang.String key)

Returns stream for value of given key.

Specified by:

getStream in interface KeyValueStore

Parameters:

key - Unique identifier.

Returns:

stream to value for given key or null if key not found.

deleteValue

public boolean deleteValue(java.lang.String key)

Deletes stored value for given key.

Specified by:

deleteValue in interface KeyValueStore

Parameters:

key - Unique identifier.

Returns:

True - if successful, False - otherwise.

deleteAll

public boolean deleteAll()

Deletes all stored values.

Specified by:

deleteAll in interface KeyValueStore

Returns:

true if successful

keySet

public java.util.Set<java.lang.String> keySet()

Get all keys. NB: will throw UnsupportedOperationException for a v1 store

Specified by:

keySet in interface KeyValueStore

count

public int count()

Specified by:

count in interface KeyValueStore

Returns:

number of entries in the store.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface KeyValueStore

Returns:

True if store is empty.

getStoreDir

public java.io.File getStoreDir()

Returns:

store directory

getStoreName

public java.lang.String getStoreName()

Specified by:

getStoreName in interface KeyValueStore

Returns:

store name

getStoreVersion

public int getStoreVersion()

Returns:

store version

changeEncryptionKey

public boolean changeEncryptionKey(java.lang.String newEncryptionKey)

Change encryption key All files are read/decrypted with old key and encrypted/written back with new key

Parameters:

newEncryptionKey -

Returns:

true if successful