com.couchbase.lite

Class BlobStore

java.lang.Object

com.couchbase.lite.BlobStore

public class BlobStore
extends java.lang.Object

A persistent content-addressable store for arbitrary-size data blobs. Each blob is stored as a file named by its SHA-1 getDigest.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENCRYPTION_ALGORITHM
static java.lang.String	ENCRYPTION_MARKER_FILENAME
static java.lang.String	FILE_EXTENSION
static java.lang.String	TMP_FILE_EXTENSION
static java.lang.String	TMP_FILE_PREFIX

Constructor Summary

Constructors

Constructor and Description
BlobStore(Context context, java.lang.String path, SymmetricKey encryptionKey)
BlobStore(Context context, java.lang.String path, SymmetricKey encryptionKey, boolean autoMigrate)

Method Summary

Modifier and Type	Method and Description
Action	actionToChangeEncryptionKey(SymmetricKey newKey)
java.util.Set<BlobKey>	allKeys()
byte[]	blobForKey(BlobKey key)
java.io.InputStream	blobStreamForKey(BlobKey key)
void	changeEncryptionKey(SymmetricKey newKey)
int	count()
int	deleteBlobs()
int	deleteBlobsExceptWithKeys(java.util.List<BlobKey> keysToKeep)
java.lang.String	getBlobPathForKey(BlobKey key) Path to file storing the blob.
SymmetricKey	getEncryptionKey()
boolean	getKeyForFilename(BlobKey outKey, java.lang.String filename)
java.lang.String	getPath()
java.lang.String	getRawPathForKey(BlobKey key)
long	getSizeOfBlob(BlobKey key)
boolean	hasBlobForKey(BlobKey key)
boolean	isEncrypted()
boolean	isGZipped(BlobKey key)
static BlobKey	keyForBlob(byte[] data)
static BlobKey	keyForBlobFromFile(java.io.File file)
protected static void	migrateBlobstoreFilenames(java.io.File directory)
boolean	storeBlob(byte[] data, BlobKey outKey)
java.io.File	tempDir()
long	totalDataSize()

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

See Also:

Constant Field Values

TMP_FILE_EXTENSION

public static final java.lang.String TMP_FILE_EXTENSION

See Also:

Constant Field Values

TMP_FILE_PREFIX

public static final java.lang.String TMP_FILE_PREFIX

See Also:

Constant Field Values

ENCRYPTION_ALGORITHM

public static final java.lang.String ENCRYPTION_ALGORITHM

See Also:

Constant Field Values

ENCRYPTION_MARKER_FILENAME

public static final java.lang.String ENCRYPTION_MARKER_FILENAME

See Also:

Constant Field Values

Constructor Detail

BlobStore

public BlobStore(Context context,
                 java.lang.String path,
                 SymmetricKey encryptionKey)
          throws CouchbaseLiteException

Throws:

CouchbaseLiteException

BlobStore

public BlobStore(Context context,
                 java.lang.String path,
                 SymmetricKey encryptionKey,
                 boolean autoMigrate)
          throws CouchbaseLiteException

Throws:

CouchbaseLiteException

Method Detail

actionToChangeEncryptionKey

public Action actionToChangeEncryptionKey(SymmetricKey newKey)

changeEncryptionKey

public void changeEncryptionKey(SymmetricKey newKey)
                         throws ActionException

Throws:

ActionException

migrateBlobstoreFilenames

protected static void migrateBlobstoreFilenames(java.io.File directory)

keyForBlob

public static BlobKey keyForBlob(byte[] data)

keyForBlobFromFile

public static BlobKey keyForBlobFromFile(java.io.File file)

getBlobPathForKey

public java.lang.String getBlobPathForKey(BlobKey key)

Path to file storing the blob. Returns null if the blob is encrypted.

Parameters:

key -

Returns:

path to file storing the blob.

getRawPathForKey

public java.lang.String getRawPathForKey(BlobKey key)

getSizeOfBlob

public long getSizeOfBlob(BlobKey key)

getKeyForFilename

public boolean getKeyForFilename(BlobKey outKey,
                                 java.lang.String filename)

hasBlobForKey

public boolean hasBlobForKey(BlobKey key)

blobForKey

public byte[] blobForKey(BlobKey key)

blobStreamForKey

public java.io.InputStream blobStreamForKey(BlobKey key)

storeBlob

public boolean storeBlob(byte[] data,
                         BlobKey outKey)

allKeys

public java.util.Set<BlobKey> allKeys()

count

public int count()

totalDataSize

public long totalDataSize()

deleteBlobsExceptWithKeys

public int deleteBlobsExceptWithKeys(java.util.List<BlobKey> keysToKeep)

deleteBlobs

public int deleteBlobs()

isGZipped

public boolean isGZipped(BlobKey key)

tempDir

public java.io.File tempDir()

getPath

public java.lang.String getPath()

getEncryptionKey

public SymmetricKey getEncryptionKey()

isEncrypted

public boolean isEncrypted()