tech.paycon.sdk.v5

Class PCUsersManager

java.lang.Object

tech.paycon.sdk.v5.PCUsersManager

public class PCUsersManager
extends java.lang.Object

PCSDK Users Manager

Constructor Summary

Constructors

Constructor and Description
PCUsersManager()

Method Summary

Modifier and Type	Method and Description
static int	activate(PCUser user, java.lang.String activationCode) Activate User with provided activation code switches isReadyToSign to true value
static boolean	delete(PCUser user) Removes user from the storage.
static PCUser	getById(java.lang.String userId) Returns user from storage by it's id
static void	getCertificateInfo(PCUser user, PCGetCertificateInfoCallback callback) Extracts information about user's certificate from PC Server
static java.lang.String	getFingerPrint() Generate device fingerprint
static PCUser	importUser(java.lang.String source) Create User object by input string (storageID, QR-code value, JSON-value, XML-value, Deep Link value)
static java.util.List<PCUser>	listStorage() List users in the storage
static void	register(PCUser user, java.lang.String pushID, PCNetCallback callback) Register User and device on PCSDK Server Following actions will be executed: - generate key pair (if required) - register public key (if new key pair was generated) - check if push address was changed - register new push address (if required) - calculate device fingerprint (if required) - register device fingerprint (if required)
static void	register(PCUser user, java.lang.String pushID, PCPushServiceType pushServiceType, PCNetCallback callback) Register User and device on PCSDK Server Following actions will be executed: - generate key pair (if required) - register public key (if new key pair was generated) - check if push address was changed - register new push address (if required) - calculate device fingerprint (if required) - register device fingerprint (if required)
static void	registerExtAuthTemplate(PCUser user, PCExtendedAuth extAuth, PCNetCallback callback) Register Extended authentication template on PCSDK Server
static void	renew(PCUser user, PCGeneralCallback callback) Renew User's keys When User's keys expiration date is close, keys should be renewed This function renews User's keys automatically with existing User's keys Existing keys MUST be not expired
static int	store(PCUser user, java.lang.String keyName, java.lang.String storePassword) Store / Update User object in storage User's keys are stored in encrypted state with provided password isReadyToSign must be true If User exists in the storage, then record will be updated In this case keyName, storePassword are optional
static int	submitPassword(PCUser user, java.lang.String password) Submit password for the User, extracted from storage switches isReadyToSign to true value

Methods inherited from class java.lang.Object

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

Constructor Detail

PCUsersManager

public PCUsersManager()

Method Detail

activate

public static int activate(PCUser user,
                           java.lang.String activationCode)

Activate User with provided activation code
switches isReadyToSign to true value

Parameters:

user - User object

activationCode - Activation code

Returns:

Error code PCError

submitPassword

public static int submitPassword(PCUser user,
                                 java.lang.String password)

Submit password for the User, extracted from storage
switches isReadyToSign to true value

Parameters:

user - User object

password - Password

Returns:

Error code PCError

store

public static int store(PCUser user,
                        java.lang.String keyName,
                        java.lang.String storePassword)

Store / Update User object in storage
User's keys are stored in encrypted state with provided password
isReadyToSign must be true
If User exists in the storage, then record will be updated
In this case keyName, storePassword are optional

Parameters:

user - User object

keyName - User name in storage {store} | New User name in storage {update}

storePassword - Store password

Returns:

Error code PCError

register

public static void register(PCUser user,
                            java.lang.String pushID,
                            PCNetCallback callback)

Register User and device on PCSDK Server
Following actions will be executed:
- generate key pair (if required)
- register public key (if new key pair was generated)
- check if push address was changed
- register new push address (if required)
- calculate device fingerprint (if required)
- register device fingerprint (if required)

Parameters:

user - User object

pushID - Firebase push token

callback - callback function to process results PCNetCallback

register

public static void register(PCUser user,
                            java.lang.String pushID,
                            PCPushServiceType pushServiceType,
                            PCNetCallback callback)

Register User and device on PCSDK Server
Following actions will be executed:
- generate key pair (if required)
- register public key (if new key pair was generated)
- check if push address was changed
- register new push address (if required)
- calculate device fingerprint (if required)
- register device fingerprint (if required)

Parameters:

user - Target PCUser object

pushID - Push token

pushServiceType - Type of service used for receiving push notifications. Supported services are Firebase and HMS

callback - PCNetCallback to process results

renew

public static void renew(PCUser user,
                         PCGeneralCallback callback)

Renew User's keys
When User's keys expiration date is close, keys should be renewed
This function renews User's keys automatically with existing User's keys
Existing keys MUST be not expired

Parameters:

user - User object

callback - callback PCGeneralCallback

registerExtAuthTemplate

public static void registerExtAuthTemplate(PCUser user,
                                           PCExtendedAuth extAuth,
                                           PCNetCallback callback)

Register Extended authentication template on PCSDK Server

Parameters:

user - User object

extAuth - Extended authentication data

callback - callback PCNetCallback

getCertificateInfo

public static void getCertificateInfo(PCUser user,
                                      PCGetCertificateInfoCallback callback)

Extracts information about user's certificate from PC Server

Parameters:

user - Target PCUser object

callback - PCGetCertificateInfoCallback for handling results

getById

public static PCUser getById(java.lang.String userId)

Returns user from storage by it's id

Parameters:

userId - ID of user

Returns:

PCUser object or null if user with such id is not found

listStorage

public static java.util.List<PCUser> listStorage()

List users in the storage

delete

public static boolean delete(PCUser user)

Removes user from the storage. Also invalidates given object in RAM so that it cannot be used anymore

Parameters:

user - User object

Returns:

True if user is deleted successfully or false if user is ot found in storage or null is passed to function

importUser

public static PCUser importUser(java.lang.String source)

Create User object by input string (storageID, QR-code value, JSON-value, XML-value, Deep Link value)

Parameters:

source - User data or identifier

Returns:

User object

getFingerPrint

public static java.lang.String getFingerPrint()

Generate device fingerprint

Returns:

device fingerprint