org.researchstack.backbone.storage.file

Class SimpleFileAccess

java.lang.Object

org.researchstack.backbone.storage.file.SimpleFileAccess

All Implemented Interfaces:

FileAccess

public class SimpleFileAccess
extends java.lang.Object
implements FileAccess

This class is a simple implementation of FileAccess that passes all data read/written through the encrypter for encryption/decryption. An encrypter such as UnencryptedProvider can be used to write unencrypted data instead.

Constructor Summary

Constructors

Constructor and Description
SimpleFileAccess()

Method Summary

Modifier and Type	Method and Description
void	checkPath(java.lang.String path)
void	clearData(android.content.Context context, java.lang.String path)
boolean	dataExists(android.content.Context context, java.lang.String path) See if we have the data.
void	moveData(android.content.Context context, java.lang.String fromPath, java.lang.String toPath)
byte[]	readData(android.content.Context context, java.lang.String path) Read data.
void	setEncrypter(Encrypter encrypter) Set the encrypter.
void	writeData(android.content.Context context, java.lang.String path, byte[] data) Save data.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleFileAccess

public SimpleFileAccess()

Method Detail

writeData

@WorkerThread
public void writeData(android.content.Context context,
                                    java.lang.String path,
                                    byte[] data)

Description copied from interface: FileAccess

Save data. Do not call this before you init or you'll get an exception. Also, networked storage has the high probability of network based exceptions. Use extra caution in those situations.

Specified by:

writeData in interface FileAccess

Parameters:

context - Can be Application context, but we'll be careful not to store, so don't worry too much.

path - Path relative to the implementation's root store. Must start with '/'. No relative paths.

data - Byte array. May implement streams in the future if all implementations support it.

readData

@WorkerThread
public byte[] readData(android.content.Context context,
                                     java.lang.String path)

Description copied from interface: FileAccess

Read data. Do not call this before you init or you'll get an exception. Also, networked storage has the high probability of network based exceptions. Use extra caution in those situations. If the path does not exist, you'll get an exception, not a null. Just FYI. That may change.

Specified by:

readData in interface FileAccess

Parameters:

context - Can be Application context, but we'll be careful not to store, so don't worry too much.

path - Path relative to the implementation's root store. Must start with '/'. No relative paths.

moveData

public void moveData(android.content.Context context,
                     java.lang.String fromPath,
                     java.lang.String toPath)

Specified by:

moveData in interface FileAccess

dataExists

@WorkerThread
public boolean dataExists(android.content.Context context,
                                        java.lang.String path)

Description copied from interface: FileAccess

See if we have the data.

Specified by:

dataExists in interface FileAccess

Parameters:

context - Can be Application context, but we'll be careful not to store, so don't worry too much.

path - Path relative to the implementation's root store. Must start with '/'. No relative paths.

Returns:

Well...

clearData

public void clearData(android.content.Context context,
                      java.lang.String path)

Specified by:

clearData in interface FileAccess

setEncrypter

public void setEncrypter(Encrypter encrypter)

Description copied from interface: FileAccess

Set the encrypter. All data is passed through this object to be encrypted before save/decrypted after loading. For no encryption, use an encrypter that passes the data back unchanged.

Specified by:

setEncrypter in interface FileAccess

Parameters:

encrypter - Encrypter.

checkPath

public void checkPath(java.lang.String path)