com.absio.file.mapper

Class KeyFileMapper

java.lang.Object

com.absio.file.mapper.AbstractFileMapper

com.absio.file.mapper.KeyFileMapper

public class KeyFileMapper
extends AbstractFileMapper

This maps all KeyFile data to/from the OFS. All create, read, update and delete operations relating to raw KeyFile data (encrypted KeyRing) are handled by the mapper. No logic for encrypting or decrypting exists in the mapper.

Constructor Summary

Constructors

Constructor and Description
KeyFileMapper(KeyRing keyRing, OFS ofs) Create a KeyFile mapper for the given KeyRing and OFS.

Method Summary

Modifier and Type	Method and Description
boolean	createOrUpdate(UUID userId, byte[] encryptedKeyFileBlob, boolean overwrite) Creates or updates the user's KeyFile bytes in the OFS, possibly creating both directory and file.
void	delete(UUID userId) Delete the users KeyFile from the OFS.
byte[]	get(UUID userId) Get the encrypted KeyFile bytes from the OFS.

Methods inherited from class com.absio.file.mapper.AbstractFileMapper

getKeyRing, getOfs, setKeyRing

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyFileMapper

public KeyFileMapper(KeyRing keyRing,
                     OFS ofs)

Create a KeyFile mapper for the given KeyRing and OFS.

Parameters:

keyRing - the key ring of the mapper

ofs - the ofs of the mapper

Method Detail

createOrUpdate

public boolean createOrUpdate(UUID userId,
                              byte[] encryptedKeyFileBlob,
                              boolean overwrite)
                       throws NoSuchAlgorithmException,
                              IOException

Creates or updates the user's KeyFile bytes in the OFS, possibly creating both directory and file.

Parameters:

userId - the user id that owns the key file

encryptedKeyFileBlob - the KeyFile (encrypted KeyRing)

overwrite - true if the KeyFile should overwrite an existing file

Returns:

true if the KeyFile was successfully written

Throws:

NoSuchAlgorithmException - thrown if the hash algorithm used by the OFS is not supported

IOException - thrown if there were any issues trying to write the KeyFile

delete

public void delete(UUID userId)
            throws IOException,
                   NoSuchAlgorithmException

Delete the users KeyFile from the OFS.

Parameters:

userId - the user id that owns the key file

Throws:

IOException - thrown if there were any issues trying to delete the KeyFile

NoSuchAlgorithmException - thrown if the hash algorithm used by the OFS is not supported

get

public byte[] get(UUID userId)
           throws NoSuchAlgorithmException,
                  IOException

Get the encrypted KeyFile bytes from the OFS.

Parameters:

userId - the user id that owns the key file

Returns:

the encrypted KeyFile bytes. Null if the KeyFile does not exist in the OFS.

Throws:

NoSuchAlgorithmException - thrown if the hash algorithm used by the OFS is not supported

IOException - thrown if there were any issues trying to get the KeyFile