PCKey (PayControl SDK Android)

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)` Объединение со второй частью ключа
`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
`byte[]`	`getPublicKey()` Получить закодированный открытый ключ подписи из состава ключевой пары
`java.lang.String`	`getRegisteredPushToken()` Получение токена устройства, зарегистрированного на 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 для формирования подписи
`int`	`isCompleted()` Проверка на полноту заполнения ключевой информации
`boolean`	`isWithFingerPrint()` Получение флага необходимости использования отпечатка устройства
`int`	`rename(java.lang.String newKeyName)` Обновление имени ключевой информации в хранилище
`void`	`setCodeExpirationInterval(PayControl.PCCodeType code_type, int interval)` Установка интервала дискретизации времени По умолчанию 180 секунд
`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:
    
    Идентификатор прикладной системы
  - isWithFingerPrint
```
public boolean isWithFingerPrint()
```
    Получение флага необходимости использования отпечатка устройства
    
    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 выполнения функции. Возвращает успешность выполненного метода
  - 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()
```
    Получение токена устройства, зарегистрированного на PC IS при помощи метода doRegisterDevice
    
    Returns:
    
    Токен устройства, зарегистрированный на PC IS при помощи метода doRegisterDevice
  - 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 - новый интервал дискретизации времени

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

isWithFingerPrint

getOnlineConfirmURL

getInteractionExternalURL

isCompleted

getPublicKey

combineKey

submitPassword

hasValidHandle

hasValidSignHandle

store

store

rename

updatePassword

updatePassword

getRegisteredPushToken

getCodeExpirationInterval

setCodeExpirationInterval