com.absio.broker.mapper

Class UserMapper

java.lang.Object

com.absio.broker.mapper.AbstractMapper

com.absio.broker.mapper.UserMapper

public class UserMapper
extends AbstractMapper

This handles all user operations with the Absio Broker™ application. It is used for create, delete and authentication of users.

Constructor Summary

Constructors

Constructor and Description
UserMapper(Session session) Default constructor.

Method Summary

Modifier and Type	Method and Description
UUID	create(List<IndexedECPrivateKey> keys) Create a user on the Absio Broker™ application.
void	delete() Deletes the authenticated user from the server.
void	logIn(KeyRing keyRing) Uses the provided KeyRing to authenticate with 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

UserMapper

public UserMapper(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

create

public UUID create(List<IndexedECPrivateKey> keys)
            throws IOException,
                   BrokerException,
                   InterruptedException

Create a user on the Absio Broker™ application. This will return the new user's ID. The public portion of the passed in private keys will be passed to the Absio Broker™ application. They will be stored in relation to the new user.

Parameters:

keys - the set of private keys for the new user - ONLY the public portion will be passed to Absio Broker™ application

Returns:

the user id for the newly created user - represented as a UUID

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

delete

public void delete()
            throws IOException,
                   BrokerException,
                   InterruptedException

Deletes the authenticated user from the server.

NOTE: this cannot be undone!

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

logIn

public void logIn(KeyRing keyRing)
           throws BrokerException,
                  SignatureException,
                  IOException,
                  InvalidKeyException,
                  InterruptedException

Uses the provided KeyRing to authenticate with the Absio Broker™ application. If successful the credentials for the authenticated session will be set on the ServerMapperRestClientSession of the mapper.

Parameters:

keyRing - the user's private key ring.

Throws:

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

SignatureException - thrown when there was an error signing data to be sent to Absio Broker™ application

IOException - thrown when there are any IO issues

InvalidKeyException - thrown when there was an error with the key for signing data to be sent to Absio Broker™ application

InterruptedException - thrown when there is an interruption during rate limiting