com.absio.file

Class OFS

java.lang.Object

com.absio.file.OFS

public class OFS
extends Object

This class represents an obfuscated file system (OFS) located in a directory on the host file system. Within the OFS, file and directory names are obfuscated to prevent external identification of data. Files within the OFS are located based on deterministic hashing of a random or static seed.

Method Summary

Modifier and Type	Method and Description
static OFS	create(Path baseDirectoryPath) Creates and populates the file system.
static OFS	create(Path baseDirectoryPath, String subDirectorySeed) Creates and populates the file system.
void	createRootDirectories() Creates the root directories of the OFS.
Path	getHashedPath(String fileSeed) Gets a deterministic hashed file path in the OFS directory.
Path	getRootPath() Gets the root path initialized with this OFS instance.
Path	getUnusedHashedPath() Finds a random, unused hashed file path in the OFS directory.
void	wipeDirectory() Deletes the OFS directory and all underlying data associated with the initialized settings.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OFS create(Path baseDirectoryPath)
                  throws IOException,
                         NoSuchAlgorithmException

Creates and populates the file system. The root path of the OFS will be created from based on the base directory.

Parameters:

baseDirectoryPath - the root directory path

Returns:

the OFS instance

Throws:

IOException - thrown if an error occurs accessing the file system

NoSuchAlgorithmException - thrown if a hash was unable to be generated

create

public static OFS create(Path baseDirectoryPath,
                         String subDirectorySeed)
                  throws IOException,
                         NoSuchAlgorithmException

Creates and populates the file system. The root path of the OFS will be created from a combination of the base directory and a hash of the sub-directory seed.

Parameters:

baseDirectoryPath - the root directory path

subDirectorySeed - seed for obfuscating the base directory

Returns:

the OFS instance

Throws:

IOException - thrown if an error occurs accessing the file system

NoSuchAlgorithmException - thrown if a hash was unable to be generated

createRootDirectories

public void createRootDirectories()
                           throws IOException

Creates the root directories of the OFS.

Throws:

IOException - thrown if an error occurs accessing the file system

getHashedPath

public Path getHashedPath(String fileSeed)
                   throws NoSuchAlgorithmException

Gets a deterministic hashed file path in the OFS directory.

Parameters:

fileSeed - the static seed to locate the file

Returns:

the hashed Path instance

Throws:

NoSuchAlgorithmException - thrown if a hash was unable to be generated

getRootPath

public Path getRootPath()

Gets the root path initialized with this OFS instance.

Returns:

the instance root path

getUnusedHashedPath

public Path getUnusedHashedPath()
                         throws IOException,
                                NoSuchAlgorithmException

Finds a random, unused hashed file path in the OFS directory.

Returns:

path to a nonexistent file within the OFS

Throws:

IOException - thrown if an error occurs accessing the file system

NoSuchAlgorithmException - thrown if a hash was unable to be generated

wipeDirectory

public void wipeDirectory()
                   throws IOException

Deletes the OFS directory and all underlying data associated with the initialized settings.

WARNING: This operation cannot be undone. Makes sure you really want to delete all files and directories associated with the OFS.

Throws:

IOException - thrown if an error occurs while deleting the directory