com.absio.file.mapper

Class PublicKeyMapper

java.lang.Object

com.absio.file.mapper.AbstractFileMapper

com.absio.file.mapper.AbstractDatabaseMapper

com.absio.file.mapper.PublicKeyMapper

All Implemented Interfaces:

IPublicKeySource

public class PublicKeyMapper
extends AbstractDatabaseMapper
implements IPublicKeySource

This maps all public keys to/from the OFS and DataAccess. All create, read, update, and delete operations are handled by the mapper.

Constructor Summary

Constructors

Constructor and Description
PublicKeyMapper(KeyRing keyRing, DataAccess dataAccess, OFS ofs) Create a PublicKey mapper for the OFS and data access.

Method Summary

Modifier and Type	Method and Description
void	create(UUID userId, IndexedECPublicKey publicKey) Creates a data access entry for the given user ID and public key.
void	delete(UUID userId, Integer index, KeyType type, Boolean active) Deletes public key records from the data access.
com.google.common.collect.ListMultimap<UUID,IndexedECPublicKey>	get(UUID userId, Integer index, KeyType type, Boolean active) Gets a map of user IDs and public keys from the data access and the key ring if applicable.
com.google.common.collect.ListMultimap<UUID,IndexedECPublicKey>	getAll() Gets a map of all user IDs and public keys from the data access and the key ring if applicable.
IndexedECPublicKey	getByIndex(UUID userId, KeyType type, int index) This gets the public key that match the user ID, type and inde.
IndexedECPublicKey	getLatestActive(UUID userId, KeyType type) This gets the latest active public key that match the user ID and type.
void	update(UUID userId, IndexedECPublicKey publicKey) Updates a data access entry for the given user ID and public key.

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

getDataAccess

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

PublicKeyMapper

public PublicKeyMapper(KeyRing keyRing,
                       DataAccess dataAccess,
                       OFS ofs)
                throws NoSuchAlgorithmException

Create a PublicKey mapper for the OFS and data access.

Parameters:

keyRing - the key ring

dataAccess - the data access for storing/retrieving the public keys

ofs - the OFS for storing/retrieving the data access

Throws:

NoSuchAlgorithmException - thrown if an error occurs initializing the encryption engine

Method Detail

create

public void create(UUID userId,
                   IndexedECPublicKey publicKey)
            throws SQLException

Creates a data access entry for the given user ID and public key.

Parameters:

userId - the user ID of the public key

publicKey - the public key to store

Throws:

SQLException - thrown if an error occurs while storing the public key

delete

public void delete(UUID userId,
                   Integer index,
                   KeyType type,
                   Boolean active)
            throws SQLException

Deletes public key records from the data access. Deleted keys can be filtered by user ID, index, type, and active state.

Parameters:

userId - the user ID's public keys to delete

index - the key index to delete

type - the key type to delete

active - the active state to delete

Throws:

SQLException - thrown if an error occurs while deleting the public key

get

public com.google.common.collect.ListMultimap<UUID,IndexedECPublicKey> get(UUID userId,
                                                                           Integer index,
                                                                           KeyType type,
                                                                           Boolean active)
                                                                    throws SQLException,
                                                                           InvalidKeySpecException

Gets a map of user IDs and public keys from the data access and the key ring if applicable. The public keys are optionally filterable by user ID, key index, usage type, and active state.

Parameters:

userId - the user ID to filter

index - the key index to filter

type - the key type to filter

active - the active state to filter

Returns:

the map of user IDs to public keys

Throws:

SQLException - thrown if an error occurs accessing the data access

InvalidKeySpecException - thrown if an error occurs decoding a stored key

getAll

public com.google.common.collect.ListMultimap<UUID,IndexedECPublicKey> getAll()
                                                                       throws SQLException,
                                                                              InvalidKeySpecException

Gets a map of all user IDs and public keys from the data access and the key ring if applicable.

Returns:

the map of user IDs to public keys

Throws:

SQLException - thrown if an error occurs accessing the data access

InvalidKeySpecException - thrown if an error occurs decoding a stored key

getByIndex

public IndexedECPublicKey getByIndex(UUID userId,
                                     KeyType type,
                                     int index)
                              throws Exception

Description copied from interface: IPublicKeySource

This gets the public key that match the user ID, type and inde.

Specified by:

getByIndex in interface IPublicKeySource

Parameters:

userId - the user id of the key owner

type - the KeyType of the key

index - the index of the key

Returns:

the IndexedECPublicKey for the user of the specified KeyType and index

Throws:

Exception - left open ended to allow the implementer to be less restrictive

getLatestActive

public IndexedECPublicKey getLatestActive(UUID userId,
                                          KeyType type)
                                   throws Exception

Description copied from interface: IPublicKeySource

This gets the latest active public key that match the user ID and type.

NOTE: if there is not an active key null will be returned.

Specified by:

getLatestActive in interface IPublicKeySource

Parameters:

userId - the user's ID

type - the KeyType of public key

Returns:

the latest active public key for the user of the specified KeyType

Throws:

Exception - left open ended to allow the implementer to be less restrictive

update

public void update(UUID userId,
                   IndexedECPublicKey publicKey)
            throws SQLException

Updates a data access entry for the given user ID and public key.

Parameters:

userId - the user ID of the public key

publicKey - the public key to store

Throws:

SQLException - thrown if an error occurs while updating the public key