com.sybase.persistence

Class SharedDataVault

java.lang.Object

com.sybase.persistence.DataVault

com.sybase.persistence.SharedDataVault

public final class SharedDataVault
extends DataVault

Shared implementation of the data vault that uses content providers under the hood. This allows its contents to be shared between applications.

Nested Class Summary

Nested classes/interfaces inherited from class com.sybase.persistence.DataVault

DataVault.DVDataName, DataVault.DVPasswordPolicy

Field Summary

Fields inherited from class com.sybase.persistence.DataVault

ERR_MSG_INVALID_PARAMETER, ERR_MSG_VAULT_DELETED, ERR_MSG_VAULT_EXISTS, id, lock, LOG_TAG

Method Summary

Modifier and Type	Method and Description
static SharedDataVault	createVault(java.lang.String dataVaultId, char[] password) Creates a new shared data vault with the specified identifier and password.
static SharedDataVault	createVault(java.lang.String dataVaultId, java.lang.String password, java.lang.String salt) Deprecated.
static void	deleteVault(java.lang.String dataVaultId) Deletes the shared vault for the specified identifier.
static SharedDataVault	getVault(java.lang.String dataVaultId) Returns the shared data vault for the specified identifier, if it exists.
static void	init(android.content.Context context) Initialization function that must be called with a context before any of the other vault methods are called.
static boolean	vaultExists(java.lang.String dataVaultId) Checks if a shared data vault exists for the specified identifier.

Methods inherited from class com.sybase.persistence.DataVault

changePassword, changePassword, decrypt, decrypt, delete, deleteValue, encrypt, encrypt, getDataNames, getLockTimeout, getPasswordPolicy, getRetryLimit, getString, getValue, isDefaultPasswordUsed, isLocked, lock, modifyPassword, modifyPassword, resetLockTimeout, setLockTimeout, setPasswordPolicy, setRetryLimit, setString, setValue, unlock, unlock

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(android.content.Context context)

Initialization function that must be called with a context before any of the other vault methods are called.

Parameters:

context - a context from which the application context is taken, must be non-null

createVault

public static SharedDataVault createVault(java.lang.String dataVaultId,
                                          char[] password)

Creates a new shared data vault with the specified identifier and password. For encryption key derivation random salts are automatically generated by DataVault.

The created data vault is in unlocked state.

This method requires that the library be initialized with DataVault.init(Context) beforehand.

Parameters:

dataVaultId - the identifier of the new vault, must be non-null

password - password for encrypting the vault, must be non-null

Returns:

the freshly created data vault in unlocked state, always non-null

Throws:

DataVaultException - if the vault cannot be created

createVault

@Deprecated
public static SharedDataVault createVault(java.lang.String dataVaultId,
                                                      java.lang.String password,
                                                      java.lang.String salt)

Deprecated.

Does the same thing as createVault(String, char[]). The salt parameter is ignored.

Parameters:

dataVaultId - the identifier of the new vault, must be non-null

password - password for encrypting the vault, can be null

salt - the salt, ignored

Returns:

the freshly created data vault in unlocked state, always non-null

Throws:

DataVaultException - if the vault cannot be created

getVault

public static SharedDataVault getVault(java.lang.String dataVaultId)

Returns the shared data vault for the specified identifier, if it exists. Concerning the state and identity of the returned object, the rules documented by DataVault.getVault(String) apply.

This method requires that the library be initialized with DataVault.init(Context) beforehand.

Parameters:

dataVaultId - the data vault identifier, must be non-null

Returns:

the shared data vault, always non-null

Throws:

DataVaultException - if any error occurs during retrieval

deleteVault

public static void deleteVault(java.lang.String dataVaultId)

Deletes the shared vault for the specified identifier.

This method requires that the library be initialized with DataVault.init(Context) beforehand.

Parameters:

dataVaultId - the data vault identifier, must be non-null

Throws:

DataVaultException - if any error occurs during removal

vaultExists

public static boolean vaultExists(java.lang.String dataVaultId)

Checks if a shared data vault exists for the specified identifier.

This method requires that the library be initialized with DataVault.init(Context) beforehand.

Parameters:

dataVaultId - the data vault identifier, must be non-null

Throws:

DataVaultException - if any error occurs