KeyInfo (CKey SDK for Android | API Reference for version 1.x)

java.lang.Object
- ru.stcrypt.ckey.sdk.v1.KeyInfo

All Implemented Interfaces:

java.io.Serializable
```
public final class KeyInfo
extends java.lang.Object
implements java.io.Serializable
```
Класс для представления информации о ключевой паре, используемой при локальном подписании документов

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`KeyInfo(java.lang.String userId)` Создаёт ключевую пару с настройками по умолчанию
`KeyInfo(java.lang.String userId, java.lang.String provName, int provType, java.lang.String containerName)` Создаёт ключевую пару с заданными настройками.
`KeyInfo(java.lang.String userId, java.lang.String provName, int provType, java.lang.String containerName, boolean isExportable)` Создаёт ключевую пару с заданными настройками.
`KeyInfo(java.lang.String userId, java.lang.String provName, int provType, java.lang.String containerName, boolean isExportable, KeysSourceIdentifier keysSourceIdentifier)` Создаёт ключевую пару с заданными настройками.
`KeyInfo(User user, java.lang.String containerName, KeysSourceIdentifier keysSourceIdentifier)` Создаёт ключевую пару с заданными настройками.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`static KeyInfo`	`fromJson(JSONObject json)` Извлечение данных о ключевой паре из JSON-объекта
`java.lang.String`	`getCertificateId()` ID сертификата подписи
`java.lang.String`	`getContainerName()` Имя контейнера, в котором хранится ключевая пара
`KeysSourceIdentifier`	`getKeysSourceIdentifier()` Источник хранилища ключей
`java.lang.String`	`getProvName()` Название провайдера, использованного при создании ключевой пары
`int`	`getProvType()` Тип провайдера, применённого при создании ключевой пары
`java.lang.String`	`getRequestId()` ID запроса на сертификат подписи
`java.lang.String`	`getUserId()` Идентификатор пользователя, для которого создавалась ключевая пара
`int`	`hashCode()`
`boolean`	`isCertificateInstalled()` Установлен ли сертификат подписи
`boolean`	`isExportable()` Флаг, определяющий, можно ли экспортировать копию ключей на сервер
`JSONObject`	`toJson()` Преобразование данных о ключевой паре в JSON-объект
`java.lang.String`	`toString()`

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

- Constructor Detail
  - KeyInfo
```
public KeyInfo(java.lang.String userId)
```
    Создаёт ключевую пару с настройками по умолчанию
    
    Parameters:
    
    userId - Идентификатор пользователя, возвращаемый методом User.getUserId().
  - KeyInfo
```
public KeyInfo(java.lang.String userId,
               java.lang.String provName,
               int provType,
               java.lang.String containerName)
```
    Создаёт ключевую пару с заданными настройками. Вместо этого конструктора рекомендуется использовать конструктор с настройками по умолчанию KeyInfo(String).
    
    Parameters:
    
    userId - Идентификатор пользователя, возвращаемый методом User.getUserId()
    
    provName - Имя провайдера, на данный момент необходимо указывать null
    
    provType - Тип провайдера. Поддерживаемые значения - 80 и 81, на данный момент необходимо указывать 80
    
    containerName - Желаемое название контейнера, по умолчанию подставляется UUID.randomUUID().toString()
  - KeyInfo
```
public KeyInfo(java.lang.String userId,
               java.lang.String provName,
               int provType,
               java.lang.String containerName,
               boolean isExportable)
```
    Создаёт ключевую пару с заданными настройками. Вместо этого конструктора рекомендуется использовать конструктор с настройками по умолчанию KeyInfo(String).
    
    Parameters:
    
    userId - Идентификатор пользователя, возвращаемый методом User.getUserId()
    
    provName - Имя провайдера, на данный момент необходимо указывать null
    
    provType - Тип провайдера. Поддерживаемые значения - 80 и 81, на данный момент необходимо указывать 80
    
    containerName - Желаемое название контейнера, по умолчанию подставляется UUID.randomUUID().toString()
    
    isExportable - Флаг, определяющий, можно ли впоследствии экспортировать копию ключей на сервер
  - KeyInfo
```
public KeyInfo(java.lang.String userId,
               java.lang.String provName,
               int provType,
               java.lang.String containerName,
               boolean isExportable,
               KeysSourceIdentifier keysSourceIdentifier)
```
    Создаёт ключевую пару с заданными настройками. Вместо этого конструктора рекомендуется использовать конструктор с настройками по умолчанию KeyInfo(String).
    
    Parameters:
    
    userId - Идентификатор пользователя, возвращаемый методом User.getUserId()
    
    provName - Имя провайдера, на данный момент необходимо указывать null
    
    provType - Тип провайдера. Поддерживаемые значения - 80 и 81, на данный момент необходимо указывать 80
    
    containerName - Желаемое название контейнера, по умолчанию подставляется UUID.randomUUID().toString()
    
    isExportable - Флаг, определяющий, можно ли впоследствии экспортировать копию ключей на сервер
    
    keysSourceIdentifier - Идентификатор источника ключей
  - KeyInfo
```
public KeyInfo(User user,
               java.lang.String containerName,
               KeysSourceIdentifier keysSourceIdentifier)
```
    Создаёт ключевую пару с заданными настройками. Вместо этого конструктора рекомендуется использовать конструктор с настройками по умолчанию KeyInfo(String).
    
    Parameters:
    
    user - Пользователь, для которого создается KeyInfo
    
    containerName - Желаемое название контейнера, по умолчанию подставляется UUID.randomUUID().toString()
    
    keysSourceIdentifier - Идентификатор источника ключей
- Method Detail
  - getUserId
```
public java.lang.String getUserId()
```
    Идентификатор пользователя, для которого создавалась ключевая пара
    
    Returns:
    
    Идентификатор пользователя
  - getProvName
```
public java.lang.String getProvName()
```
    Название провайдера, использованного при создании ключевой пары
    
    Returns:
    
    Обычно, null
  - getProvType
```
public int getProvType()
```
    Тип провайдера, применённого при создании ключевой пары
    
    Returns:
    
    По умолчанию, 80
  - getContainerName
```
public java.lang.String getContainerName()
```
    Имя контейнера, в котором хранится ключевая пара
    
    Returns:
    
    Имя контейнера
  - isExportable
```
public boolean isExportable()
```
    Флаг, определяющий, можно ли экспортировать копию ключей на сервер
    
    Returns:
    
    true, когда возможен экспорт резервной копии ключа на сервер
  - getRequestId
```
public java.lang.String getRequestId()
```
    ID запроса на сертификат подписи
    
    Returns:
    
    ID запроса или null, если запрос ещё не создан
  - getCertificateId
```
public java.lang.String getCertificateId()
```
    ID сертификата подписи
    
    Returns:
    
    ID сертификата или null
  - isCertificateInstalled
```
public boolean isCertificateInstalled()
```
    Установлен ли сертификат подписи
  - getKeysSourceIdentifier
```
public KeysSourceIdentifier getKeysSourceIdentifier()
```
    Источник хранилища ключей
    
    Returns:
    
    Возвращает объект KeysSourceIdentifier с информацией об источнике хранилища ключей
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toJson
```
public JSONObject toJson()
```
    Преобразование данных о ключевой паре в JSON-объект
    
    Returns:
    
    JSON-репрезентация данных
  - fromJson
```
public static KeyInfo fromJson(JSONObject json)
```
    Извлечение данных о ключевой паре из JSON-объекта
    
    Parameters:
    
    json - JSON-объект с данными
    
    Returns:
    
    Объект KeyInfo или null при невозможности десериализации
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class KeyInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyInfo

KeyInfo

KeyInfo

KeyInfo

KeyInfo

Method Detail

getUserId

getProvName

getProvType

getContainerName

isExportable

getRequestId

getCertificateId

isCertificateInstalled

getKeysSourceIdentifier

equals

hashCode

toJson

fromJson

toString