com.absio.broker.mapper

Class PublicKeyMapper

java.lang.Object

com.absio.broker.mapper.AbstractMapper

com.absio.broker.mapper.PublicKeyMapper

All Implemented Interfaces:

IPublicKeySource

public class PublicKeyMapper
extends AbstractMapper
implements IPublicKeySource

This maps all public key data to/from the Absio Broker™ application. All create, read, update and delete operations relating to public keys (signing and derivation) for other users in the system are handled by the mapper. No logic for encrypting or decrypting exists in the mapper.

Constructor Summary

Constructors

Constructor and Description
PublicKeyMapper(Session session) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	createOrUpdate(ECPublicKey publicKey, KeyType type, int index, boolean active) Creates or updates the public key on the Absio Broker™ application.
void	createOrUpdate(IndexedECPublicKey publicKey) Creates or updates the public key on the Absio Broker™ application.
List<IndexedECPublicKey>	get(UUID userId, KeyType type, Integer index) Gets all public keys matching the user ID, key type, key ring index and algorithm index.
IndexedECPublicKey	getByIndex(UUID userId, KeyType type, int index) This gets the public key that match the user ID, type and index from the Absio Broker™ application.
IndexedECPublicKey	getLatestActive(UUID userId, KeyType type) This gets the latest active public key that match the user ID and type from the Absio Broker™ application.

Methods inherited from class com.absio.broker.mapper.AbstractMapper

getClient, getCredentials, getServerTime, getSession, isAuthenticated, setSession

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicKeyMapper

public PublicKeyMapper(Session session)
                throws NoSuchAlgorithmException,
                       NoSuchPaddingException

Default constructor.

Parameters:

session - the session for the mapper

Throws:

NoSuchPaddingException - thrown if the default padding for symmetric encryption is not supported

NoSuchAlgorithmException - thrown if ECDH is not supported

Method Detail

createOrUpdate

public void createOrUpdate(IndexedECPublicKey publicKey)
                    throws BrokerException,
                           IOException,
                           InterruptedException

Creates or updates the public key on the Absio Broker™ application.

Parameters:

publicKey - the public key to create or update

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

InterruptedException - thrown when there is an interruption during rate limiting

createOrUpdate

public void createOrUpdate(ECPublicKey publicKey,
                           KeyType type,
                           int index,
                           boolean active)
                    throws BrokerException,
                           IOException,
                           InterruptedException

Creates or updates the public key on the Absio Broker™ application.

Parameters:

publicKey - the public key bytes

type - the KeyType of key

index - the index of the key

active - true if the key is active

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

InterruptedException - thrown when there is an interruption during rate limiting

get

public List<IndexedECPublicKey> get(UUID userId,
                                    KeyType type,
                                    Integer index)
                             throws BrokerException,
                                    IOException,
                                    InterruptedException

Gets all public keys matching the user ID, key type, key ring index and algorithm index.

NOTE: pass in null to ignore a parameter.

Parameters:

userId - the key owners user's ID or ignored if null

type - the key type or ignored if null

index - the key index or ignored if null

Returns:

a list of public keys that match the supplied criteria

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

InterruptedException - thrown when there is an interruption during rate limiting

getByIndex

public IndexedECPublicKey getByIndex(UUID userId,
                                     KeyType type,
                                     int index)
                              throws IllegalArgumentException,
                                     BrokerException,
                                     IOException,
                                     InterruptedException

This gets the public key that match the user ID, type and index from the Absio Broker™ application.

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:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

InterruptedException - thrown when there is an interruption during rate limiting

IllegalArgumentException - thrown if the parameter arguments are incorrect

getLatestActive

public IndexedECPublicKey getLatestActive(UUID userId,
                                          KeyType type)
                                   throws IllegalArgumentException,
                                          BrokerException,
                                          IOException,
                                          InterruptedException

This gets the latest active public key that match the user ID and type from the Absio Broker™ application. This calls GetListAsync and processes the list for active keys. It is needed for the IPublicKeySource interface.

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:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

InterruptedException - thrown when there is an interruption during rate limiting

IllegalArgumentException - thrown if the parameter arguments are incorrect