PCUser (PayControl SDK for Android, Version 5.5)

java.lang.Object
- tech.paycon.sdk.v5.PCUser

All Implemented Interfaces:

java.io.Serializable
```
public class PCUser
extends java.lang.Object
implements java.io.Serializable
```
PCSDK User

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PCUser.ActivationState` Current user state: NOT_INITIALIZED - not initialized NOT_ACTIVATED - activation code required ACTIVATED - active
`static class`	`PCUser.ExtendedAuthMethods` Extended authentication method
`static class`	`PCUser.PCCodeType` Code type to calculate

Constructor Summary

Constructors
Constructor and Description

PCUser()

Constructors
Constructor and Description
`PCUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areOnlineCredentialsRequired()` Flag which indicates that activation code and password are checked online when submitted
`java.lang.String`	`getActivationCodeForRenewal()` Calculates activation code for renewal.
`int`	`getApiVersion()` Returns level of API which is used to interact with PC Server
`java.lang.String`	`getAppExtra()` Get additional data
`int`	`getCodeExpirationInterval(PCUser.PCCodeType code_type)` Get generated signatures and codes expiration interval By default - 180 seconds
`java.util.Date`	`getExpirationDate()` Get user's expiration date
`PCUser.ExtendedAuthMethods[]`	`getExtAuthAvailableMethods()` Get Extended authentication methods list for the User
`java.lang.String`	`getExternalKeyAlias()` In case the asymmetric key pair is generated on the external device (i.e.
`int`	`getKeyIndex()` Returns index of the symmetric key.
`int`	`getKeysProcessorPolicy()` Returns keys processing policy for current user. 0 - No external keys processor allowed (key pair must be generated and stored on a device) 1 - Key pair can be generated and stored either on a smartphone or external device (like a smart-card) 2 - Some external keys processor must be used (key pair cannot be generated and stored on a smartphone) Application MUST check policy and store user's key with required method
`java.lang.String`	`getName()` Get User's Name used to store in device storage
`int`	`getPasswordPolicy()` Get password policy identifier 0 - User's keys can be stored without action from User (Application can generate store password by itself).
`java.lang.String`	`getPCExternalUrl()` Get PCSDK External Server URL
`byte[]`	`getPublicKey()` Get User's public key in ASN.1 format
`java.lang.String`	`getRegisteredPushToken()` Get push token registered on PCSDK Server
`java.lang.String`	`getStorageId()` Get User's ID in PCSDK storage on the device
`java.lang.String`	`getSuggestedUserName()` Get User's Name suggested by the system
`java.lang.String`	`getSystemId()` Get PCSDK System ID
`java.lang.String`	`getSystemName()` Get PCSDK System Name
`java.lang.String`	`getUserId()` Get User ID in PCSDK service
`boolean`	`hasAutoSignKeyPair()` Check if user has generated key pair
`boolean`	`hasKeyPair()` Check if user has generated key pair
`boolean`	`isActivated()` Check if User is activated
`boolean`	`isAutosignEnabled()` Flag which indicates if the key can be used to sign transactions automatically
`boolean`	`isCollectDeviceInfo()` Check if collecting device information is required
`boolean`	`isCollectEvents()` Check if collecting device events during network interaction is required
`boolean`	`isCollectLocation()` Check if collecting location is required Application should check this flag and, if it set, ask additional privileges ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION
`boolean`	`isCollectSIMInfo()` Check if collecting SIM information is required Application should check this flag and, if it set, ask additional privileges READ_PHONE_STATE
`boolean`	`isDenyRenewPubKey()` Check if renew public key is forbidden by PCSDK Server If this flag is true, then PCSDK Server will accept only the first Public Key for the user Following requests to set Public Key will be rejected
`boolean`	`isDenyStoreWithOSProtection()` Check if OS protection (like Google Fingerprint) for User's keys is forbidden If flag is set then Application MUST NOT allow to use TouchID/FaceID/Google Fingerprint to store User's keys
`boolean`	`isReadyToSign()` Check if User's keys are ready to sign (password submitted / user is activated)
`boolean`	`isRemoteUpdateEnabled()` Flag which indicates at possibility of remote updates (primarily used for backups)
`boolean`	`isScoringEnabled()` Flag indicates if the device scoring can be performed for the key
`boolean`	`isWithFingerPrint()` Check if use device fingerprinting required (link signatures to device unique properties)
`int`	`reset()` Reset user's state
`void`	`setCodeExpirationInterval(PCUser.PCCodeType code_type, int interval)` Set generated signatures and codes expiration interval By default - 180 seconds
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PCUser
```
public PCUser()
```
- Method Detail
  - hasKeyPair
```
public boolean hasKeyPair()
```
    Check if user has generated key pair
    
    Returns:
    
    true, if key pair exists; false in other case
  - hasAutoSignKeyPair
```
public boolean hasAutoSignKeyPair()
```
    Check if user has generated key pair
    
    Returns:
    
    true, if key pair exists; false in other case
  - reset
```
public int reset()
```
    Reset user's state
    
    Returns:
    
    error PCError
  - getExpirationDate
```
public java.util.Date getExpirationDate()
```
    Get user's expiration date
    
    Returns:
    
    User's keys expiration date
  - getUserId
```
public java.lang.String getUserId()
```
    Get User ID in PCSDK service
    
    Returns:
    
    User ID
  - getName
```
public java.lang.String getName()
```
    Get User's Name used to store in device storage
    
    Returns:
    
    User's Name
  - getSuggestedUserName
```
public java.lang.String getSuggestedUserName()
```
    Get User's Name suggested by the system
    
    Returns:
    
    User's Name
  - getSystemId
```
public java.lang.String getSystemId()
```
    Get PCSDK System ID
    
    Returns:
    
    PCSDK System ID
  - getSystemName
```
public java.lang.String getSystemName()
```
    Get PCSDK System Name
    
    Returns:
    
    PCSDK System Name
  - getExtAuthAvailableMethods
```
public PCUser.ExtendedAuthMethods[] getExtAuthAvailableMethods()
```
    Get Extended authentication methods list for the User
    
    Returns:
    
    Extended authentication methods list PCUser.ExtendedAuthMethods
  - getCodeExpirationInterval
```
public int getCodeExpirationInterval(PCUser.PCCodeType code_type)
```
    Get generated signatures and codes expiration interval
    By default - 180 seconds
    
    Parameters:
    
    code_type - code type
  - setCodeExpirationInterval
```
public void setCodeExpirationInterval(PCUser.PCCodeType code_type,
                                      int interval)
```
    Set generated signatures and codes expiration interval
    By default - 180 seconds
    
    Parameters:
    
    code_type - code type
    
    interval - new interval
  - getPCExternalUrl
```
public java.lang.String getPCExternalUrl()
```
    Get PCSDK External Server URL
    
    Returns:
    
    PCSDK External Server URL
  - getStorageId
```
public java.lang.String getStorageId()
```
    Get User's ID in PCSDK storage on the device
    
    Returns:
    
    User's ID in PCSDK storage on the device
  - getApiVersion
```
public int getApiVersion()
```
    Returns level of API which is used to interact with PC Server
    
    Returns:
    
    API version or 0 if it is unknown
  - getKeyIndex
```
public int getKeyIndex()
```
    Returns index of the symmetric key. The indexes start at 1. That is, "1" is assigned for the first symmetric key generated by the sever. "0" means that the key has no index. All the PCUsers with API version prior to 5 have zero key index
    
    Returns:
    
    Actual key index or 0 if it is not assigned
  - isActivated
```
public boolean isActivated()
```
    Check if User is activated
    
    Returns:
    
    false, if activation code required
  - isReadyToSign
```
public boolean isReadyToSign()
```
    Check if User's keys are ready to sign (password submitted / user is activated)
    
    Returns:
    
    true, if keys are ready to sign
  - getPublicKey
```
public byte[] getPublicKey()
```
    Get User's public key in ASN.1 format
    
    Returns:
    
    User's public key
  - getRegisteredPushToken
```
public java.lang.String getRegisteredPushToken()
```
    Get push token registered on PCSDK Server
    
    Returns:
    
    registered push token
  - getExternalKeyAlias
```
public java.lang.String getExternalKeyAlias()
```
    In case the asymmetric key pair is generated on the external device (i.e. some other instance of PCKeysProcessor than PCRegularKeysProcessor is used), the external device should use this unique alias to link the key pair with PCUser
    
    Returns:
    
    Suggested external alias
  - isWithFingerPrint
```
public boolean isWithFingerPrint()
```
    Check if use device fingerprinting required (link signatures to device unique properties)
    
    Returns:
    
    device fingerprinting required
  - isDenyRenewPubKey
```
public boolean isDenyRenewPubKey()
```
    Check if renew public key is forbidden by PCSDK Server
    If this flag is true, then PCSDK Server will accept only the first Public Key for the user
    Following requests to set Public Key will be rejected
    
    Returns:
    
    renew public key is forbidden
  - isCollectEvents
```
public boolean isCollectEvents()
```
    Check if collecting device events during network interaction is required
    
    Returns:
    
    collecting device events is required
  - isCollectDeviceInfo
```
public boolean isCollectDeviceInfo()
```
    Check if collecting device information is required
    
    Returns:
    
    collecting device information is required
  - isCollectSIMInfo
```
public boolean isCollectSIMInfo()
```
    Check if collecting SIM information is required
    Application should check this flag and, if it set, ask additional privileges READ_PHONE_STATE
    
    Returns:
    
    collecting SIM information is required
  - isCollectLocation
```
public boolean isCollectLocation()
```
    Check if collecting location is required
    Application should check this flag and, if it set, ask additional privileges ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION
    
    Returns:
    
    collecting location is required
  - getPasswordPolicy
```
public int getPasswordPolicy()
```
    Get password policy identifier
    0 - User's keys can be stored without action from User (Application can generate store password by itself). If user specifies password then min length - 6 symbols
    1 - Min password length - 6 symbols. Store password MUST be provided by the User
    2 - Min password length - 8 symbols. Upper case AND lower case symbols are required
    3 - Min password length - 8 symbols. Upper case AND lower case symbols AND digits are required.
    Application MUST check policy and store user's key with required method
    
    Returns:
    
    password policy identifier
  - getKeysProcessorPolicy
```
public int getKeysProcessorPolicy()
```
    Returns keys processing policy for current user.
    0 - No external keys processor allowed (key pair must be generated and stored on a device)
    1 - Key pair can be generated and stored either on a smartphone or external device (like a smart-card)
    2 - Some external keys processor must be used (key pair cannot be generated and stored on a smartphone)
    Application MUST check policy and store user's key with required method
    
    Returns:
    
    A number identifying keys processing policy
  - getAppExtra
```
public java.lang.String getAppExtra()
```
    Get additional data
    
    Returns:
    
    Any required additional data
  - isDenyStoreWithOSProtection
```
public boolean isDenyStoreWithOSProtection()
```
    Check if OS protection (like Google Fingerprint) for User's keys is forbidden
    If flag is set then Application MUST NOT allow to use TouchID/FaceID/Google Fingerprint to store User's keys
    
    Returns:
    
    if OS protection is forbidden
  - isScoringEnabled
```
public boolean isScoringEnabled()
```
    Flag indicates if the device scoring can be performed for the key
    
    Returns:
    
    true if scoring can be performed
  - isAutosignEnabled
```
public boolean isAutosignEnabled()
```
    Flag which indicates if the key can be used to sign transactions automatically
    
    Returns:
    
    true if option is enabled for the key
  - isRemoteUpdateEnabled
```
public boolean isRemoteUpdateEnabled()
```
    Flag which indicates at possibility of remote updates (primarily used for backups)
    
    Returns:
    
    true if remote update can be done
  - areOnlineCredentialsRequired
```
public boolean areOnlineCredentialsRequired()
```
    Flag which indicates that activation code and password are checked online when submitted
    
    Returns:
    
    True if online check is performed when activating user, setting and submitting password
  - getActivationCodeForRenewal
```
public java.lang.String getActivationCodeForRenewal()
```
    Calculates activation code for renewal. Can be called only if isReadyToSign() == true. Normally, the application does not consume this method. It is rather useful for libraries which implement PCKeysProcessor.
    
    Returns:
    
    Activation code or null.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PCUser

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PCUser

Method Detail

hasKeyPair

hasAutoSignKeyPair

reset

getExpirationDate

getUserId

getName

getSuggestedUserName

getSystemId

getSystemName

getExtAuthAvailableMethods

getCodeExpirationInterval

setCodeExpirationInterval

getPCExternalUrl

getStorageId

getApiVersion

getKeyIndex

isActivated

isReadyToSign

getPublicKey

getRegisteredPushToken

getExternalKeyAlias

isWithFingerPrint

isDenyRenewPubKey

isCollectEvents

isCollectDeviceInfo

isCollectSIMInfo

isCollectLocation

getPasswordPolicy

getKeysProcessorPolicy

getAppExtra

isDenyStoreWithOSProtection

isScoringEnabled

isAutosignEnabled

isRemoteUpdateEnabled

areOnlineCredentialsRequired

getActivationCodeForRenewal

toString