com.cryptshare.api

Class ProtectedFileStore

java.lang.Object

com.cryptshare.api.ProtectedFileStore

All Implemented Interfaces:

IStore

public class ProtectedFileStore
extends java.lang.Object
implements IStore

Implementation of IStore that persists to the file system, and encrypts the store.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue(java.lang.String key) Gets a stored value from the store.
static ProtectedFileStore	open(java.nio.file.Path storePath) Opens a verification store that loads from and persists to the given store file.
static ProtectedFileStore	open(java.nio.file.Path storePath, IProtectionService protectionService) Opens a verification store that loads from and persists to the given store file.
static ProtectedFileStore	open(java.nio.file.Path storePath, ProtectionScope protectionScope) Opens a verification store that loads from and persists to the given store file.
void	persist() Saves this store object to the store file.
void	removeValue(java.lang.String key) Removes a specific value from the store.
void	setValue(java.lang.String key, java.lang.String value) Sets a value in the store.

Methods inherited from class java.lang.Object

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

Method Detail

open

public static ProtectedFileStore open(java.nio.file.Path storePath)
                               throws ClientException

Opens a verification store that loads from and persists to the given store file. If it does not exist, it will be created. The file contents are protected on machine scope. This means that the created client store file cannot be used on another host. Depending on the OS, a default IProtectionService is to protect the store:

• Linux/MacOS: AES encryption, using AesProtectionService with LinuxKeySourceProvider.
• Windows: Windows DPAPI, using DpApiProtectionService.

Parameters:

storePath - The path to the store. If the path points to an existing directory, a file named 'client.store' will be created in there.

Returns:

An instance of a ProtectedFileStore, with all values loaded.

Throws:

ClientException - If opening fails.

open

public static ProtectedFileStore open(java.nio.file.Path storePath,
                                      ProtectionScope protectionScope)
                               throws ClientException

Opens a verification store that loads from and persists to the given store file. If it does not exist, it will be created. Depending on the OS, a default IProtectionService is to protect the store:

• Linux/MacOS: AES encryption, using AesProtectionService with LinuxKeySourceProvider.
• Windows: Windows DPAPI, using DpApiProtectionService.

Parameters:

storePath - The path to the store. If the path points to an existing directory, a file named 'client.store' will be created in there.

protectionScope - The ProtectionScope that is used to protect the data.

Returns:

An instance of a ProtectedFileStore, with all values loaded.

Throws:

ClientException - If opening fails.

open

public static ProtectedFileStore open(java.nio.file.Path storePath,
                                      IProtectionService protectionService)
                               throws ClientException

Opens a verification store that loads from and persists to the given store file. If it does not exist, it will be created.

Parameters:

storePath - The path to the store. If the path points to an existing directory, a file named 'client.store' will be created in there.

protectionService - An implementation of IProtectionService that is used to protect the data before writing it to disk.

Returns:

An instance of a ProtectedFileStore, with all values loaded.

Throws:

ClientException - If opening fails.

getValue

public java.lang.String getValue(java.lang.String key)

Gets a stored value from the store.

Specified by:

getValue in interface IStore

Parameters:

key - Unique key to identify the value. If null, the method returns null.

Returns:

The value that corresponds to the given key, or null, if the key was null or not found.

setValue

public void setValue(java.lang.String key,
                     java.lang.String value)

Sets a value in the store.

Specified by:

setValue in interface IStore

Parameters:

key - Unique key for the value. If null, the method call has no effect.

value - Value to be stored. If null, the method call has no effect.

removeValue

public void removeValue(java.lang.String key)

Removes a specific value from the store.

Specified by:

removeValue in interface IStore

Parameters:

key - Unique key to identify the value. If null, the method call has no effect.

persist

public void persist()
             throws ClientException

Saves this store object to the store file.

Specified by:

persist in interface IStore

Throws:

ClientException - client exception