PCKey (PayControl SDK for Android, Version 4.0)

java.lang.Object
- com.safetech.paycontrol.sdk.PCKey

All Implemented Interfaces:

java.io.Serializable
```
public abstract class PCKey
extends java.lang.Object
implements java.io.Serializable
```
Абстрактный класс для работы с ключом

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MIN_PASSWORD_LEN
Минимальная длина пароля

Fields
Modifier and Type	Field and Description
`static int`	`MIN_PASSWORD_LEN` Минимальная длина пароля

Constructor Summary

Constructors
Constructor and Description

PCKey()
Конструктор класса

Constructors
Constructor and Description
`PCKey()` Конструктор класса

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract int`	`clearKeyPair()` Удалить ключевую пару (очистить значения открытого и закрытого ключей)
`int`	`combineKey(java.lang.String keyPart)` Объединение со второй частью ключа
`void`	`exportRaw(PCExportKeyCallback callback)` Экспорт ключа в сыром формате, пригодном для переноса ключа в PC SDK 5.x.
`void`	`exportRawWithCertificate(PCExportKeyWithCertificateCallback callback)` Экспорт ключа в сыром формате для переноса в PC SDK 6.x. Также экспортирует самоподписанный сертификат для миграции ключей подписи в PC SDK 6.x. Перед вызовом метода должно выполняться условие `hasValidHandle()` == true.
`abstract int`	`freeHandle()` Освободить хэндлы ключей текущего объекта
`abstract int`	`generateKeyPair()` Генерация ключевой пары
`int`	`getCodeExpirationInterval(PayControl.PCCodeType code_type)` Получение интервала дискретизации времени По умолчанию 180 секунд
`java.lang.String`	`getExpirationDate()` Получение даты истечения срока действия ключевой информации
`long`	`getHandle_auth()` Получение Handle ключевой информации для выработки кода аутентификации
`long`	`getHandle_ecdsa()` Получение Handle ключевой информации для выработки подписи
`long`	`getHandle_hmac()` Получение Handle ключевой информации для выработки кода подтверждения
`java.lang.String`	`getInteractionExternalURL()` Получение URL PC Interaction Server
`java.lang.String`	`getKeyId()` Получение идентификатора ключевой информации в хранилище PayControl
`java.lang.String`	`getKeyName()` Получение имени ключевой информации
`java.lang.String`	`getOnlineConfirmURL()` Получение URL для подтверждения Online
`int`	`getPasswordPolicy()` Получение идентификатора парольной политики 0 - Разрешено сохранение ключа без ввода пароля пользователем (приложение формирует пароль без участия пользователя).
`byte[]`	`getPublicKey()` Получить закодированный открытый ключ подписи из состава ключевой пары
`java.lang.String`	`getRegisteredMFMSecurityToken()` Получение SecurityToken, зарегистрированного на PC IS при помощи метода doRegisterMFMSecurityToken
`java.lang.String`	`getRegisteredPushToken()` Получение push-токена устройства, зарегистрированного на PC IS при помощи метода doRegisterDevice
`java.lang.String`	`getSystemId()` Получение идентификатора прикладной системы
`PayControl.TypeSystem`	`getType()` Получение типа ключа: DSS или Regular
`java.lang.String`	`getUserId()` Получение идентификатора пользователя PayControl
`boolean`	`hasKeyPair()` Проверка, имеет ли ключ сформированную ключевую пару
`boolean`	`hasValidHandle()` Проверка на возможность использования Handle для формирования кода подтверждения
`boolean`	`hasValidSignHandle()` Проверка на возможность использования Handle для формирования подписи
`boolean`	`isCollectDeviceInfo()` Получение флага необходимости отправки информации об устройстве
`boolean`	`isCollectEvents()` Получение флага необходимости отправки информации о событиях при сетевых вызовах
`boolean`	`isCollectLocation()` Получение флага необходимости сбора информации о Местоположении (требует подтвердить предотавление разрешений приложению)
`boolean`	`isCollectSIMInfo()` Получение флага необходимости сбора информации о Телефоне (SIM-карте, операторе) (требует подтвердить предоставление разрешений приложению)
`int`	`isCompleted()` Проверка на полноту заполнения ключевой информации
`boolean`	`isDenyRenewPubKey()` Получение флага запрета перегенерации ключевой пары (открытого/закрытого ключа) Если данный флаг установлен, то сервер примет только первый открытый ключ пользователя.
`boolean`	`isDenyStoreWithOSProtection()` Получение флага запрета сохранения ключа, используя системный способ защиты доступа к нему (такой как отпечаток пальца) Если флаг установлен, приложение НЕ ДОЛЖНО позволят использовать TouchID/FaceID/Google Fingerprint для сохранения пароля к ключу
`boolean`	`isWithFingerPrint()` Получение флага необходимости использования отпечатка устройства (набора уникальных признаков аппарата)
`int`	`rename(java.lang.String newKeyName)` Обновление имени ключевой информации в хранилище
`void`	`setCodeExpirationInterval(PayControl.PCCodeType code_type, int interval)` Установка интервала дискретизации времени По умолчанию 180 секунд
`int`	`setInteractionURL(java.lang.String url)` Replaces the existing interaction URL for a desired one
`int`	`store(java.lang.String keyName)` Сохранение ключевой информации в хранилище без указания пароля Функция необходима для сохранения ранее импортированных ключей без предъявления текущего пароля Для последующего доступа к ключам необходим старый пароль Валидный handle не требуется
`int`	`store(java.lang.String keyName, java.lang.String password)` Сохранение ключевой информации в хранилище с указанием пароля Ключи сохраняются в зашифрованном виде на указанном пароле Требуется валидный handle ключа
`void`	`submitPassword(java.lang.String password, PCSimpleCallback callback)` Предъявление пароля для получения Handle ключевой информации.
`void`	`updatePassword(java.lang.String keyId, java.lang.String newPassword, PCSimpleCallback callback)` Изменение пароля для ключевой информации Требуется валидный handle
`void`	`updatePassword(java.lang.String keyId, java.lang.String oldPassword, java.lang.String newPassword, PCSimpleCallback callback)` Изменение пароля для ключевой информации Валидный handle не требуется

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

- Field Detail
  - MIN_PASSWORD_LEN
```
public static int MIN_PASSWORD_LEN
```
    Минимальная длина пароля
- Constructor Detail
  - PCKey
```
public PCKey()
```
    Конструктор класса
- Method Detail
  - generateKeyPair
```
public abstract int generateKeyPair()
```
    Генерация ключевой пары
    
    Returns:
    
    Код ошибки. PCError
  - clearKeyPair
```
public abstract int clearKeyPair()
```
    Удалить ключевую пару (очистить значения открытого и закрытого ключей)
    
    Returns:
    
    Код ошибки. PCError
  - hasKeyPair
```
public boolean hasKeyPair()
```
    Проверка, имеет ли ключ сформированную ключевую пару
    
    Returns:
    
    true, если ключевая пара присутствует; false в противном случае
  - freeHandle
```
public abstract int freeHandle()
```
    Освободить хэндлы ключей текущего объекта
    
    Returns:
    
    Код ошибки. PCError
  - getKeyId
```
public java.lang.String getKeyId()
```
    Получение идентификатора ключевой информации в хранилище PayControl
    
    Returns:
    
    Идентификатор ключевой информации в хранилище PayControl
  - getHandle_ecdsa
```
public long getHandle_ecdsa()
```
    Получение Handle ключевой информации для выработки подписи
    
    Returns:
    
    Handle ключевой информации для выработки подписи
  - getHandle_auth
```
public long getHandle_auth()
```
    Получение Handle ключевой информации для выработки кода аутентификации
    
    Returns:
    
    Handle ключевой информации для выработки кода аутентификации
  - getHandle_hmac
```
public long getHandle_hmac()
```
    Получение Handle ключевой информации для выработки кода подтверждения
    
    Returns:
    
    Handle ключевой информации для выработки кода подтверждения
  - getExpirationDate
```
public java.lang.String getExpirationDate()
```
    Получение даты истечения срока действия ключевой информации
    
    Returns:
    
    Дата истечения срока действия ключевой информации
  - getUserId
```
public java.lang.String getUserId()
```
    Получение идентификатора пользователя PayControl
    
    Returns:
    
    Идентификатор пользователя PayControl
  - getKeyName
```
public java.lang.String getKeyName()
```
    Получение имени ключевой информации
    
    Returns:
    
    Имя ключевой информации
  - getType
```
public PayControl.TypeSystem getType()
```
    Получение типа ключа: DSS или Regular
    
    Returns:
    
    Тип ключа: DSS или Regular
  - getSystemId
```
public java.lang.String getSystemId()
```
    Получение идентификатора прикладной системы
    
    Returns:
    
    Идентификатор прикладной системы
  - getOnlineConfirmURL
```
public java.lang.String getOnlineConfirmURL()
```
    Получение URL для подтверждения Online
    
    Returns:
    
    URL для подтверждения Online
  - getInteractionExternalURL
```
public java.lang.String getInteractionExternalURL()
```
    Получение URL PC Interaction Server
    
    Returns:
    
    URL PC Interaction Server
  - isCompleted
```
public int isCompleted()
```
    Проверка на полноту заполнения ключевой информации
    
    Returns:
    
    Код ошибки. Если код ошибки == PCIS_ERROR_OK, то ключ заполнен полностью. Если код ошибки == PC_ERROR_KEY_NOT_COMPLETED, то необходимо объединение со второй частью ключа PCError
  - getPublicKey
```
public byte[] getPublicKey()
```
    Получить закодированный открытый ключ подписи из состава ключевой пары
    
    Returns:
    
    Закодированный открытый ключ
  - combineKey
```
public int combineKey(java.lang.String keyPart)
```
    Объединение со второй частью ключа
    
    Parameters:
    
    keyPart - Недостающая часть ключа
    
    Returns:
    
    Код ошибки PCError
  - submitPassword
```
public void submitPassword(java.lang.String password,
                           PCSimpleCallback callback)
```
    Предъявление пароля для получения Handle ключевой информации.
    В случае успешного ввода пароля Handle становится валидным для использования при генерации кода подтверждения и выполнения других функций с ключами.
    
    Parameters:
    
    password - Пароль для ключевой информации
    
    callback - Callback выполнения функции. Возвращает успешность выполненного метода
  - exportRaw
```
public void exportRaw(PCExportKeyCallback callback)
```
    Экспорт ключа в сыром формате, пригодном для переноса ключа в PC SDK 5.x. Перед вызовом метода должно выполняться условие hasValidHandle() == true.
    
    Parameters:
    
    callback - Реализация PCExportKeyCallback для обработки результатов
  - exportRawWithCertificate
```
public void exportRawWithCertificate(PCExportKeyWithCertificateCallback callback)
```
    Экспорт ключа в сыром формате для переноса в PC SDK 6.x.
    Также экспортирует самоподписанный сертификат для миграции ключей подписи в PC SDK 6.x.
    Перед вызовом метода должно выполняться условие hasValidHandle() == true.
    
    Parameters:
    
    callback - Реализация PCExportKeyWithCertificateCallback для обработки результатов
  - hasValidHandle
```
public boolean hasValidHandle()
```
    Проверка на возможность использования Handle для формирования кода подтверждения
    
    Returns:
    
    Если true, то Handle имеет валидное значение
  - hasValidSignHandle
```
public boolean hasValidSignHandle()
```
    Проверка на возможность использования Handle для формирования подписи
    
    Returns:
    
    Если true, то Handle подписи имеет валидное значение
  - store
```
public int store(java.lang.String keyName,
                 java.lang.String password)
```
    Сохранение ключевой информации в хранилище с указанием пароля
    Ключи сохраняются в зашифрованном виде на указанном пароле
    Требуется валидный handle ключа
    
    Parameters:
    
    keyName - Имя ключевой информации
    
    password - Пароль для ключевой информации
    
    Returns:
    
    Код ошибки PCError
  - store
```
public int store(java.lang.String keyName)
```
    Сохранение ключевой информации в хранилище без указания пароля
    Функция необходима для сохранения ранее импортированных ключей
    без предъявления текущего пароля
    Для последующего доступа к ключам необходим старый пароль
    Валидный handle не требуется
    
    Parameters:
    
    keyName - Имя ключевой информации
    
    Returns:
    
    Код ошибки PCError
  - rename
```
public int rename(java.lang.String newKeyName)
```
    Обновление имени ключевой информации в хранилище
    
    Parameters:
    
    newKeyName - Новое имя ключевой информации
    
    Returns:
    
    Код ошибки PCError
  - updatePassword
```
public void updatePassword(java.lang.String keyId,
                           java.lang.String oldPassword,
                           java.lang.String newPassword,
                           PCSimpleCallback callback)
```
    Изменение пароля для ключевой информации
    Валидный handle не требуется
    
    Parameters:
    
    keyId - Идентификатор ключевой информации в хранилище PayControl
    
    oldPassword - Текущий пароль для ключевой информации
    
    newPassword - Новый пароль для ключевой информации
    
    callback - Callback выполнения функции. Возвращает успешность выполненного метода
  - updatePassword
```
public void updatePassword(java.lang.String keyId,
                           java.lang.String newPassword,
                           PCSimpleCallback callback)
```
    Изменение пароля для ключевой информации
    Требуется валидный handle
    
    Parameters:
    
    keyId - Идентификатор ключевой информации в хранилище PayControl
    
    newPassword - Новый пароль для ключевой информации
    
    callback - Callback выполнения функции. Возвращает успешность выполненного метода
  - getRegisteredPushToken
```
public java.lang.String getRegisteredPushToken()
```
    Получение push-токена устройства, зарегистрированного на PC IS при помощи метода doRegisterDevice
    
    Returns:
    
    Токен устройства, зарегистрированный на PC IS при помощи метода doRegisterDevice
  - getRegisteredMFMSecurityToken
```
public java.lang.String getRegisteredMFMSecurityToken()
```
    Получение SecurityToken, зарегистрированного на PC IS при помощи метода doRegisterMFMSecurityToken
    
    Returns:
    
    SecurityToken
  - getCodeExpirationInterval
```
public int getCodeExpirationInterval(PayControl.PCCodeType code_type)
```
    Получение интервала дискретизации времени
    По умолчанию 180 секунд
    
    Parameters:
    
    code_type - тип, для которого нужно получить интервал дискретизации времени
  - setCodeExpirationInterval
```
public void setCodeExpirationInterval(PayControl.PCCodeType code_type,
                                      int interval)
```
    Установка интервала дискретизации времени
    По умолчанию 180 секунд
    
    Parameters:
    
    code_type - тип, для которого изменяется интервал дискретизации времени
    
    interval - новый интервал дискретизации времени
  - setInteractionURL
```
public int setInteractionURL(java.lang.String url)
```
    Replaces the existing interaction URL for a desired one
    
    Parameters:
    
    url - New non-null non-empty URL
    
    Returns:
    
    Code of error or 0 in case of success
  - isWithFingerPrint
```
public boolean isWithFingerPrint()
```
    Получение флага необходимости использования отпечатка устройства (набора уникальных признаков аппарата)
    
    Returns:
    
    Флаг необходимости использования отпечатка устройства
  - isDenyRenewPubKey
```
public boolean isDenyRenewPubKey()
```
    Получение флага запрета перегенерации ключевой пары (открытого/закрытого ключа)
    Если данный флаг установлен, то сервер примет только первый открытый ключ пользователя.
    Последующие запросы на регистрацию открытого ключа будут возвращать ошибку
    
    Returns:
    
    Флаг запрета перегенерации ключа
  - isCollectEvents
```
public boolean isCollectEvents()
```
    Получение флага необходимости отправки информации о событиях при сетевых вызовах
    
    Returns:
    
    Флаг необходимости отправки информации о событиях
  - isCollectDeviceInfo
```
public boolean isCollectDeviceInfo()
```
    Получение флага необходимости отправки информации об устройстве
    
    Returns:
    
    Флаг необходимости отправки информации об устройстве
  - isCollectSIMInfo
```
public boolean isCollectSIMInfo()
```
    Получение флага необходимости сбора информации о Телефоне (SIM-карте, операторе) (требует подтвердить предоставление разрешений приложению)
    
    Returns:
    
    Флаг необходимости сбора информации о Телефоне (SIM-карте, операторе)
  - isCollectLocation
```
public boolean isCollectLocation()
```
    Получение флага необходимости сбора информации о Местоположении (требует подтвердить предотавление разрешений приложению)
    
    Returns:
    
    Флаг необходимости сбора информации о Местоположении
  - getPasswordPolicy
```
public int getPasswordPolicy()
```
    Получение идентификатора парольной политики
    0 - Разрешено сохранение ключа без ввода пароля пользователем (приложение формирует пароль без участия пользователя). Минимальная длина пароля - 6 символов
    1 - Минимальная длина пароля - 6 символов. Пароль должен запрашиваться у пользователя
    2 - Минимальная длина пароля - 8 символов. Обязательно использование как заглавных, так и строчных букв
    3 - Минимальная длина пароля - 8 символов. Обязательно использование заглавных, строчных букв и цифр
    
    Returns:
    
    Идентификатор парольной политики
  - isDenyStoreWithOSProtection
```
public boolean isDenyStoreWithOSProtection()
```
    Получение флага запрета сохранения ключа, используя системный способ защиты доступа к нему (такой как отпечаток пальца)
    Если флаг установлен, приложение НЕ ДОЛЖНО позволят использовать TouchID/FaceID/Google Fingerprint для сохранения пароля к ключу
    
    Returns:
    
    Флаг запрета сохранения ключевой информации, используя системный способ защиты доступа к нему

Class PCKey

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_PASSWORD_LEN

Constructor Detail

PCKey

Method Detail

generateKeyPair

clearKeyPair

hasKeyPair

freeHandle

getKeyId

getHandle_ecdsa

getHandle_auth

getHandle_hmac

getExpirationDate

getUserId

getKeyName

getType

getSystemId

getOnlineConfirmURL

getInteractionExternalURL

isCompleted

getPublicKey

combineKey

submitPassword

exportRaw

exportRawWithCertificate

hasValidHandle

hasValidSignHandle

store

store

rename

updatePassword

updatePassword

getRegisteredPushToken

getRegisteredMFMSecurityToken

getCodeExpirationInterval

setCodeExpirationInterval

setInteractionURL

isWithFingerPrint

isDenyRenewPubKey

isCollectEvents

isCollectDeviceInfo

isCollectSIMInfo

isCollectLocation

getPasswordPolicy

isDenyStoreWithOSProtection