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) Deprecated.
static void	activate(PCUser user, java.lang.String activationCode, PCActivateCallback callback) Activates the user with provided activation code.
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 void	getScoringSettings(PCUser user, PCGetScoringSettingsCallback callback) Gets Scoring settings from PC Server.
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	migrate(java.lang.String source, java.lang.String name, java.lang.String password, java.security.cert.Certificate certificate, PCMigrationCallback callback) Performs migration of the key from PCSDK 4 to the current version of PCSDK. The prerequisites to calling this method are the following: Both PCSDK 4 and the current PCSDK are embedded into the same application The key being migrated is active in PCSDK 4 (i.e., accessible via PCSDK 4 methods, not expired) The given value of source and the certificate are obtained from PCSDK 4 method PCKey.exportRawWithCertificate(...). The given value of password is the same as was used in PCSDK 4 Note that after the successful migration the key will present in both the current PCSDK and PCSDK 4.
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, PCKeysProcessor keysProcessor, PCRegisterCallback callback)
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, PCKeysProcessor keysProcessor, PCRenewCallback 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 void	renew(PCUser user, PCRenewCallback callback) Renew User's keys
static int	store(PCUser user, java.lang.String keyName, java.lang.String password) Deprecated.
static void	store(PCUser user, java.lang.String keyName, java.lang.String password, PCStoreCallback callback) Stores a new user or updates an existing object in storage. User's keys are encrypted with provided password before being stored. If new user is being stored, condition PCUser.isReadyToAutoSign() == true must be satisfied.
static int	submitPassword(PCUser user, java.lang.String password) Deprecated.
static void	submitPassword(PCUser user, java.lang.String password, PCSubmitPasswordCallback callback) Submits password for the target PCUser, extracted from storage. Switches PCUser.isReadyToAutoSign() to true. In case PCUser.areOnlineCredentialsRequired() returns true, this method performs a network request and the passed callback is invoked asynchronously with some delay.

Methods inherited from class java.lang.Object

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

Constructor Detail

PCUsersManager

public PCUsersManager()

Method Detail

activate

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

Deprecated.

Activates the user with provided activation code. Should be called immediately after importUser(String) if PCUser.isActivated() returns false.
Switches PCUser.isReadyToAutoSign() to true.
This method is deprecated but still can be used for keys for which PCUser.areOnlineCredentialsRequired() returns false. For universal case use activate(PCUser, String, PCActivateCallback)

Parameters:

user - Target PCUser

activationCode - Activation code

Returns:

Code of PCError. PCError.PC_ERROR_OK is returned upon a success.

See Also:

activate(PCUser, String, PCActivateCallback)

activate

public static void activate(PCUser user,
                            java.lang.String activationCode,
                            PCActivateCallback callback)

Activates the user with provided activation code. Should be called immediately after importUser(String) if PCUser.isActivated() returns false.
Switches PCUser.isReadyToAutoSign() to true.
In case PCUser.areOnlineCredentialsRequired() returns true, this method performs a network request and the passed callback is invoked asynchronously with some delay. Otherwise, the callback is invoked immediately

Parameters:

user - Target PCUser

activationCode - The submitted activation code

callback - Implementation of PCActivateCallback to handle results

submitPassword

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

Deprecated.

Submits password for the target PCUser, extracted from storage.
Switches PCUser.isReadyToAutoSign() to true.
This method is deprecated but still can be used for keys for which PCUser.areOnlineCredentialsRequired() returns false. For universal case use submitPassword(PCUser, String, PCSubmitPasswordCallback)

Parameters:

user - Target PCUser

password - Provided password

Returns:

@return Code of PCError. PCError.PC_ERROR_OK is returned upon a success.

See Also:

submitPassword(PCUser, String, PCSubmitPasswordCallback)

submitPassword

public static void submitPassword(PCUser user,
                                  java.lang.String password,
                                  PCSubmitPasswordCallback callback)

Submits password for the target PCUser, extracted from storage.
Switches PCUser.isReadyToAutoSign() to true.
In case PCUser.areOnlineCredentialsRequired() returns true, this method performs a network request and the passed callback is invoked asynchronously with some delay. Otherwise, the callback is invoked immediately

Parameters:

user - Target PCUser

password - Provided password

callback - Implementation of PCSubmitPasswordCallback for handling results

store

@Deprecated
public static int store(PCUser user,
                                    java.lang.String keyName,
                                    java.lang.String password)

Deprecated.

Stores a new user or updates an existing object in storage.
User's keys are encrypted with provided password before being stored.
If new user is being stored, condition PCUser.isReadyToAutoSign() == true must be satisfied. The same is required if the existing user is being updated with a new password. This method is deprecated but still can be used for keys for which PCUser.areOnlineCredentialsRequired() returns false. For universal case use store(PCUser, String, String, PCStoreCallback)

Parameters:

user - Target PCUser

keyName - Unique key name. When storing user for the first time, it must not be null. If it is not null when the user is already exists, the name will be changed in storage.

password - Password which will be used to encrypt keys in storage. It can be null when the user has already been stored and the method is called with non-null keyName only for changing name.

Returns:

Code of PCError. PCError.PC_ERROR_OK is returned upon a success.

See Also:

store(PCUser, String, String)

store

public static void store(PCUser user,
                         java.lang.String keyName,
                         java.lang.String password,
                         PCStoreCallback callback)

Stores a new user or updates an existing object in storage.
User's keys are encrypted with provided password before being stored.
If new user is being stored, condition PCUser.isReadyToAutoSign() == true must be satisfied. The same is required if the existing user is being updated with a new password. In case PCUser.areOnlineCredentialsRequired() returns true, this method performs a network request and the passed callback is invoked asynchronously with some delay. Otherwise, the callback is invoked immediately

Parameters:

user - Target PCUser

keyName - Unique key name. When storing user for the first time, it must not be null. If it is not null when the user is already exists, the name will be changed in storage.

password - Password which will be used to encrypt keys in storage. It can be null when the user has already been stored and the method is called with non-null keyName only for changing name.

callback - Implementation of PCStoreCallback for handling results

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

register

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

renew

public static void renew(PCUser user,
                         PCRenewCallback callback)

Renew User's keys

Parameters:

user - User object

callback - PCGeneralCallback for handling results

See Also:

renew(PCUser, PCKeysProcessor, PCRenewCallback)

renew

public static void renew(PCUser user,
                         PCKeysProcessor keysProcessor,
                         PCRenewCallback 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

keysProcessor - Instance of keys processor

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

migrate

public static void migrate(java.lang.String source,
                           java.lang.String name,
                           java.lang.String password,
                           java.security.cert.Certificate certificate,
                           PCMigrationCallback callback)

Performs migration of the key from PCSDK 4 to the current version of PCSDK.
The prerequisites to calling this method are the following:

1. Both PCSDK 4 and the current PCSDK are embedded into the same application
2. The key being migrated is active in PCSDK 4 (i.e., accessible via PCSDK 4 methods, not expired)
3. The given value of source and the certificate are obtained from PCSDK 4 method PCKey.exportRawWithCertificate(...).
4. The given value of password is the same as was used in PCSDK 4

Note that after the successful migration the key will present in both the current PCSDK and PCSDK 4. Thus, it must be removed from the PCSDK 4 manually by calling Paycontrol.deleteKey(...)

Parameters:

source - The key info exported by PCSDK 4 in compatible format, i.e., either XML or multi-line plaintext

name - The desired name of the PCUser to be created. Can be same as returned by PCKey.getKeyName() in PCSDK 4

password - The password used in PCSDK 4 to protect the key

certificate - Self-signed certificate generated by PCSDK 4

callback - Instance of PCMigrationCallback to handle the results

getFingerPrint

public static java.lang.String getFingerPrint()

Generate device fingerprint

Returns:

device fingerprint

getScoringSettings

public static void getScoringSettings(PCUser user,
                                      PCGetScoringSettingsCallback callback)

Gets Scoring settings from PC Server. These settings then should be used to initialize GIB Mobile SDK

Parameters:

user - Target PCUser

callback - Instance of PCGetScoringSettingsCallback for handling results