SalesforceMobileSDK-Android

14.0.0-rc.0

SmartStore/com.salesforce.androidsdk.smartstore.store/KeyValueEncryptedFileStore

KeyValueEncryptedFileStore

open class KeyValueEncryptedFileStore : 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.

Constructors

KeyValueEncryptedFileStore

constructor(ctx: Context, storeName: String, encryptionKey: String)

Constructor

Properties

val KEY_SUFFIX: String = ".key"

KEY_VALUE_STORES

val KEY_VALUE_STORES: String = "keyvaluestores"

val KV_VERSION: Int = 2

MAX_STORE_NAME_LENGTH

val MAX_STORE_NAME_LENGTH: Int = 96

val storeDir: File

val VALUE_SUFFIX: String = ".value"

VERSION_FILE_NAME

val VERSION_FILE_NAME: String = "version"

Functions

changeEncryptionKey

open fun changeEncryptionKey(newEncryptionKey: String): Boolean

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

computeParentDir

open fun computeParentDir(ctx: Context): File

Return parent directory for all key stores

open fun contains(key: String): Boolean

Return true if store contains a file for the given key

open fun count(): Int

open fun deleteAll(): Boolean

Deletes all stored values.

open fun deleteValue(key: String): Boolean

Deletes stored value for given key.

open fun getStoreName(): String

getStoreVersion

open fun getStoreVersion(): Int

open fun getStream(key: String): InputStream

Returns stream for value of given key.

open fun getValue(key: String): String

Returns value stored for given key.

hasKeyValueStore

open fun hasKeyValueStore(ctx: Context, storeName: String): Boolean

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

open fun isEmpty(): Boolean

isValidStoreName

open fun isValidStoreName(storeName: String): Boolean

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

open fun keySet(): Set<String>

Get all keys.

removeKeyValueStore

open fun removeKeyValueStore(ctx: Context, storeName: String)

Remove key value store with given (full) name

open fun saveStream(key: String, stream: InputStream): Boolean

Save value given as an input stream for the given key.

open fun saveValue(key: String, value: String): Boolean

Save value for the given key.