Package com.mku.salmon.drive

Class JavaDrive

java.lang.Object

com.mku.file.VirtualDrive

com.mku.salmon.SalmonDrive

com.mku.salmon.drive.JavaDrive

public class JavaDrive
extends SalmonDrive

SalmonDrive implementation for standard Java file API. This provides a virtual drive implementation that you can use to store and access encrypted files. Use static methods open() or create() to create an instance.

Method Summary

Modifier and Type	Method	Description
static SalmonDrive	create(IRealFile dir, String password, INonceSequencer sequencer)	Helper method that creates and initializes a JavaDrive
IRealFile	getPrivateDir()	Get a private dir for sharing files with external applications.
SalmonFile	getRoot()	Return the virtual root directory of the drive.
void	onUnlockError()	When authentication succeeds.
void	onUnlockSuccess()	When authentication succeed.
static SalmonDrive	open(IRealFile dir, String password, INonceSequencer sequencer)	Helper method that opens and initializes a JavaDrive

Methods inherited from class com.mku.salmon.SalmonDrive

close, createDrive, getAuthConfigFilename, getAuthId, getBytesFromRealFile, getConfigFilename, getDefaultAuthConfigFilename, getDefaultFileChunkSize, getDriveConfig, getDriveId, getExportDir, getExportDirectoryName, getKey, getRealRoot, getSequencer, getShareDirectoryName, getVirtualDriveDirectoryName, hasConfig, initFS, initialize, openDrive, revokeAuthorization, setAuthConfigFilename, setConfigFilename, setDefaultFileChunkSize, setExportDirectoryName, setPassword, setSequencer, setShareDirectoryName, setVirtualDriveDirectoryName

Methods inherited from class java.lang.Object

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

Method Details

open

public static SalmonDrive open(IRealFile dir,
 String password,
 INonceSequencer sequencer)
                        throws IOException

Helper method that opens and initializes a JavaDrive

Parameters:

dir - The directory that hosts the drive.

password - The password.

sequencer - The nonce sequencer that will be used for encryption.

Returns:

The drive.

Throws:

IOException - Thrown if error occurs during opening the drive.

create

public static SalmonDrive create(IRealFile dir,
 String password,
 INonceSequencer sequencer)
                          throws IOException

Helper method that creates and initializes a JavaDrive

Parameters:

dir - The directory that will host the drive.

password - The password.

sequencer - The nonce sequencer that will be used for encryption.

Returns:

The drive.

Throws:

IOException - If error occurs during creating the drive.

getPrivateDir

public IRealFile getPrivateDir()
                        throws Exception

Get a private dir for sharing files with external applications.

Specified by:

getPrivateDir in class VirtualDrive

Returns:

The private directory

Throws:

Exception - Thrown if error occurs

onUnlockSuccess

public void onUnlockSuccess()

When authentication succeed.

Specified by:

onUnlockSuccess in class VirtualDrive

onUnlockError

public void onUnlockError()

When authentication succeeds.

Specified by:

onUnlockError in class VirtualDrive

getRoot

public SalmonFile getRoot()

Description copied from class: SalmonDrive

Return the virtual root directory of the drive.

Overrides:

getRoot in class SalmonDrive

Returns:

The virtual root directory of the drive