Package eirb.pub.app.vault

Class VaultFile

java.lang.Object

eirb.pub.app.vault.VaultFile

Direct Known Subclasses:

ServerVaultFile

public class VaultFile
extends Object

Constructor Summary

Constructors

Constructor	Description
VaultFile(InputStream stream)
VaultFile(Path filePath)	Create a VaultFile object based on a file

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)
static VaultFile	emptyVaultFile(String name, String password)	Create a new VaultFile object with a name, lock with a password
InputStream	getInputStream()	Get an InputStream object that represent the vaultFile and can be used to be saved in a file for example
String	getName()	Get the name of the vault File
PlainVault	getVault(String password)	Retrieve vault (plain) with a password Will get the vault key from the ciphers key with a key generated with a password and unlock the cipher vault with the previously obtained Vault Key and iv
void	lock()	Lock the vault, that means that the previous PlainVault generated by getVault will not work anymore.
void	removePropertyChangeListener(PropertyChangeListener listener)
void	saveToFile(Path filePath)	Save VaultFile in the file system
void	setFrom(VaultFile vaultFile)	update important elements of cypherVault

Methods inherited from class java.lang.Object

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

Constructor Details

VaultFile

public VaultFile(InputStream stream)
          throws VaultFileFormatException,
VaultFileIOException

Throws:

VaultFileFormatException

VaultFileIOException

VaultFile

public VaultFile(Path filePath)
          throws VaultFileFormatException,
VaultFileIOException

Create a VaultFile object based on a file

Parameters:

filePath - location of the file

Throws:

VaultFileIOException - when a IO operation failed during file parsing

VaultFileFormatException - if the provided file do not respect the requirements

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

emptyVaultFile

public static VaultFile emptyVaultFile(String name,
 String password)
                                throws VaultFileGenerationException

Create a new VaultFile object with a name, lock with a password

Parameters:

name - name of the new Vault

password - for the vault

Returns:

VaultFile

Throws:

NullPointerException - if no string or no password is provided

VaultFileGenerationException

getVault

public PlainVault getVault(String password)
                    throws PasswordException,
CipherVaultException

Retrieve vault (plain) with a password Will get the vault key from the ciphers key with a key generated with a password and unlock the cipher vault with the previously obtained Vault Key and iv

Parameters:

password - user password

Returns:

plain vault

Throws:

PasswordException - if the password don't unlock any cipher key

CipherVaultException - when the decryption of the vault with the vault key didn't work

lock

public void lock()
          throws VaultFileGenerationException

Lock the vault, that means that the previous PlainVault generated by getVault will not work anymore. PlainVault memory will be safely delete. You have to unlock (with getVault) again.

Throws:

VaultFileGenerationException - when an encryption error occurred during the locking process

saveToFile

public void saveToFile(Path filePath)
                throws VaultFileIOException

Save VaultFile in the file system

Parameters:

filePath - path for saving

Throws:

VaultFileIOException - if the writing operation failed

getInputStream

public InputStream getInputStream()

Get an InputStream object that represent the vaultFile and can be used to be saved in a file for example

Returns:

representation of the VaultFile as an InputStream

getName

public String getName()

Get the name of the vault File

Returns:

vault name

setFrom

public void setFrom(VaultFile vaultFile)
             throws CipherException,
VaultException

update important elements of cypherVault

Throws:

CipherException

VaultException