ru.cryptopro.mykey.sdk.v1

Class OperationsManager

java.lang.Object

_CallbackInvoker

ru.cryptopro.mykey.sdk.v1.OperationsManager

public final class OperationsManager
extends _CallbackInvoker

Класс для управления подписанием в со стороны SDK

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperationsManager.ApproveRequest Класс с запросом на подтверждение операции или подписание документа
static class	OperationsManager.ConfirmedDocument Описание подтвержденного документа
static class	OperationsManager.DeclinedDocument Описание отменённого документа
static class	OperationsManager.OperationType Тип операции
static class	OperationsManager.SignMode Режим подписания
static class	OperationsManager.SignParams Параметры подписания документа
static class	OperationsManager.SignResults Результаты подписи

Constructor Summary

Constructors

Constructor and Description
OperationsManager()

Method Summary

Modifier and Type	Method and Description
static void	confirmOperation(Activity parentActivity, User user, Operation operation, OperationsManager.SignMode signMode, boolean isSelectionEnabled, boolean skipSnippet, ApproveRequestNetworkCallback callback) Подтверждение операции.
static void	confirmOperation(Activity parentActivity, User user, Operation operation, OperationsManager.SignMode signMode, boolean isSelectionEnabled, boolean skipSnippet, boolean checkCertificate, ApproveRequestNetworkCallback callback) Подтверждение операции.
static void	confirmOperation(User user, Operation operation, OperationsManager.SignMode signMode, boolean isSelectionEnabled, boolean skipSnippet, ApproveRequestNetworkCallback callback) Подтверждение операции.
static void	confirmOperation(User user, Operation operation, OperationsManager.SignMode signMode, boolean isSelectionEnabled, boolean skipSnippet, boolean checkCertificate, ApproveRequestNetworkCallback callback) Подтверждение операции.
static void	confirmOperation(User user, OperationsManager.ApproveRequest approveRequest, NetworkCallback callback) Подтверждение операции путём отправки заранее подготовленного запроса на подтверждение. Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.
static void	getDocumentBinaryData(User user, java.lang.String docId, GetDocumentBinaryDataCallback callback) Скачивает или докачивает документ по его идентификатору и сохраняет в кэш приложения (использует метод getCacheDir() для объекта Context, переданного при инициализации sdk).
static void	getDocumentDescription(User user, java.lang.String documentId, DocumentNetworkCallback callback) Получение информации о документе
static void	getOperationsInfo(User user, long interval, java.lang.String operationId, OperationsInfoCallback callback) Получение информации об операциях.
static void	getOperationsList(User user, OperationsManager.OperationType operationType, java.lang.String operationId, OperationsNetworkCallback callback) Получение списка операций, требующих подтверждения
static void	getOperationsList(User user, java.lang.String clientId, OperationsNetworkCallback callback) Получение списка операций, требующих подтверждения
static void	signDocuments(Activity parentActivity, User user, java.util.ArrayList<java.lang.String> documentIds, OperationsManager.SignParams params, SignResultNetworkCallback callback) Подписание документов.
static void	signDocuments(User user, java.util.ArrayList<java.lang.String> documentIds, OperationsManager.SignParams params, SignResultNetworkCallback callback) Подписание документов.
static void	signDocuments(User user, OperationsManager.ApproveRequest approveRequest, SignResultNetworkCallback callback) Подписание документов путем отправки заранее подготовленного запроса на подпись. Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.
static void	signDocumentsOffline(Activity parentActivity, User user, java.util.ArrayList<java.lang.String> documentIds, OperationsManager.SignParams params, ApproveRequestNetworkCallback callback) Подписание документов без отправки запроса на сервер .
static void	signDocumentsOffline(User user, java.util.ArrayList<java.lang.String> documentIds, OperationsManager.SignParams params, ApproveRequestNetworkCallback callback) Подписание документов без отправки запроса на сервер .
static void	uploadDocument(User user, java.lang.String title, java.lang.String snippetTemplate, java.lang.String previewTemplate, byte[] content, DocumentIdNetworkCallback callback) Загрузка документа на сервер

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationsManager

public OperationsManager()

Method Detail

getOperationsList

public static void getOperationsList(User user,
                                     OperationsManager.OperationType operationType,
                                     java.lang.String operationId,
                                     OperationsNetworkCallback callback)

Получение списка операций, требующих подтверждения

Parameters:

user - Объект пользователя данного устройства

operationType - Тип операция для получения, если требуется фильтрация по типу

operationId - Идентификатор операции, если требуется получить конкретную операцию по её идентификатору

callback - Реализация OperationsNetworkCallback для обработки результатов. При успехе возвращает массив объектов Operation

getOperationsList

public static void getOperationsList(User user,
                                     java.lang.String clientId,
                                     OperationsNetworkCallback callback)

Получение списка операций, требующих подтверждения

Parameters:

user - Объект пользователя данного устройства

clientId - Фильтрация по идентификатору прикладной системы, создавшему операцию. Данный идентификатор используется в механизме с автоматической подписью и может быть получен методом Operation.AppSystemInfo.getClientId() для объекта, возвращаемого методом Operation.getAppSystemInfo()

callback - Реализация OperationsNetworkCallback для обработки результатов. При успехе возвращает массив объектов Operation

getOperationsInfo

public static void getOperationsInfo(User user,
                                     long interval,
                                     java.lang.String operationId,
                                     OperationsInfoCallback callback)

Получение информации об операциях. Конфигурация сервиса должна поддерживать API 1.1 для выполнения данного запроса.

Parameters:

user - Объект пользователя данного устройства

interval - Определяет интервал времени (в секундах) для поиска операций. Если параметр задан (не 0), то сервис вернёт все операции созданные в интервале времени (interval, now)

operationId - Идентификатор операции, если требуется получить информацию по конкретной операции

callback - Реализация OperationsInfoCallback для обработки результатов. При успехе возвращает массив объектов OperationInfo

confirmOperation

public static void confirmOperation(User user,
                                    OperationsManager.ApproveRequest approveRequest,
                                    NetworkCallback callback)

Подтверждение операции путём отправки заранее подготовленного запроса на подтверждение.
Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

user - Объект пользователя данного устройства

approveRequest - Запрос на подтверждение

callback - Реализация NetworkCallback для обработки результатов

confirmOperation

public static void confirmOperation(User user,
                                    Operation operation,
                                    OperationsManager.SignMode signMode,
                                    boolean isSelectionEnabled,
                                    boolean skipSnippet,
                                    ApproveRequestNetworkCallback callback)

Подтверждение операции. Показывает содержимое операции и кнопки для подтверждения или отклонения. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

user - Объект пользователя данного устройства

operation - Операция для подтверждения

signMode - режим подписи (при режиме Offline запрос на сервер не отправляется)

isSelectionEnabled - Установленный флаг позволяет выбирать документы для подтверждения/отклонения

skipSnippet - Установленный флаг позволяет сразу отобразить исходное представление документа в случае, если операция состоит только из одного документа

callback - Реализация ApproveRequestNetworkCallback для обработки результатов

confirmOperation

public static void confirmOperation(User user,
                                    Operation operation,
                                    OperationsManager.SignMode signMode,
                                    boolean isSelectionEnabled,
                                    boolean skipSnippet,
                                    boolean checkCertificate,
                                    ApproveRequestNetworkCallback callback)

Подтверждение операции. Показывает содержимое операции и кнопки для подтверждения или отклонения. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

user - Объект пользователя данного устройства

operation - Операция для подтверждения

signMode - режим подписи (при режиме Offline запрос на сервер не отправляется)

isSelectionEnabled - Установленный флаг позволяет выбирать документы для подтверждения/отклонения

skipSnippet - Установленный флаг позволяет сразу отобразить исходное представление документа в случае, если операция состоит только из одного документа.

checkCertificate - Установленный флаг запрещает подтверждение, но оставляет возможным отклонение операции на сертификате, у которого статус не Certificate.State.active, либо статус Certificate.State.out_of_order и прошёл срок действия сертификата Certificate.getNotAfter()

callback - Реализация ApproveRequestNetworkCallback для обработки результатов

confirmOperation

public static void confirmOperation(Activity parentActivity,
                                    User user,
                                    Operation operation,
                                    OperationsManager.SignMode signMode,
                                    boolean isSelectionEnabled,
                                    boolean skipSnippet,
                                    boolean checkCertificate,
                                    ApproveRequestNetworkCallback callback)

Подтверждение операции. Показывает содержимое операции и кнопки для подтверждения или отклонения. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

parentActivity - Экземпляр Activity приложения, с которого будет запущено Activity из SDK. При этом Activity из SDK добавляется в стек той же задачи, в которой запущена parentActivity. Если указать null, то Activity из SDK будет запущена отдельной задачей из контекста приложения, переданного при инициализации

user - Объект пользователя данного устройства

operation - Операция для подтверждения

signMode - режим подписи (при режиме Offline запрос на сервер не отправляется)

isSelectionEnabled - Установленный флаг позволяет выбирать документы для подтверждения/отклонения

skipSnippet - Установленный флаг позволяет сразу отобразить исходное представление документа в случае, если операция состоит только из одного документа.

checkCertificate - Установленный флаг запрещает подтверждение, но оставляет возможным отклонение операции на сертификате, у которого статус не Certificate.State.active, либо статус Certificate.State.out_of_order и прошёл срок действия сертификата Certificate.getNotAfter()

callback - Реализация ApproveRequestNetworkCallback для обработки результатов

confirmOperation

public static void confirmOperation(Activity parentActivity,
                                    User user,
                                    Operation operation,
                                    OperationsManager.SignMode signMode,
                                    boolean isSelectionEnabled,
                                    boolean skipSnippet,
                                    ApproveRequestNetworkCallback callback)

Подтверждение операции. Показывает содержимое операции и кнопки для подтверждения или отклонения. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

parentActivity - Экземпляр Activity приложения, с которого будет запущено Activity из SDK. При этом Activity из SDK добавляется в стек той же задачи, в которой запущена parentActivity. Если указать null, то Activity из SDK будет запущена отдельной задачей из контекста приложения, переданного при инициализации

user - Объект пользователя данного устройства

operation - Операция для подтверждения

signMode - режим подписи (при режиме Offline запрос на сервер не отправляется)

isSelectionEnabled - Установленный флаг позволяет выбирать документы для подтверждения/отклонения

skipSnippet - Установленный флаг позволяет сразу отобразить исходное представление документа в случае, если операция состоит только из одного документа.

callback - Реализация ApproveRequestNetworkCallback для обработки результатов

getDocumentDescription

public static void getDocumentDescription(User user,
                                          java.lang.String documentId,
                                          DocumentNetworkCallback callback)

Получение информации о документе

Parameters:

user - Объект пользователя данного устройства

documentId - Идентификатор документа в

callback - Реализация DocumentNetworkCallback для обработки результатов. При успехе возвращается информация о документе в виде объекта Operation.Document.

getDocumentBinaryData

public static void getDocumentBinaryData(User user,
                                         java.lang.String docId,
                                         GetDocumentBinaryDataCallback callback)

Скачивает или докачивает документ по его идентификатору и сохраняет в кэш приложения (использует метод getCacheDir() для объекта Context, переданного при инициализации sdk). Чтобы было продолжено скачивание должны выполняться условия:

• Сервер должен поддерживать возможность докачивания (версия 1.2)
• Предыдущая попытка скачивания документа завершилась сетевой ошибкой NetworkError.IS_ERROR_SERVER_NOT_AVAILABLE или NetworkError.ERROR_REACHED_TIMEOUT
• В кэше сдк должен быть недокаченный файл

Parameters:

user - Пользователь

docId - ID документа для скачивания

callback - Реализация GetDocumentBinaryDataCallback для обработки результатов

uploadDocument

public static void uploadDocument(User user,
                                  java.lang.String title,
                                  java.lang.String snippetTemplate,
                                  java.lang.String previewTemplate,
                                  byte[] content,
                                  DocumentIdNetworkCallback callback)

Загрузка документа на сервер

Parameters:

user - Объект пользователя

title - Название файла

snippetTemplate - Шаблон "плашки", HTML. Допустимо значение null

previewTemplate - Шаблон preview, HTML. Допустимо значение null

content - Содержимое файла

callback - Реализация DocumentIdNetworkCallback.success(String) для обработки результатов. При успехе, будет передан ID загруженного документа

signDocuments

public static void signDocuments(User user,
                                 OperationsManager.ApproveRequest approveRequest,
                                 SignResultNetworkCallback callback)

Подписание документов путем отправки заранее подготовленного запроса на подпись.
Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

user - Объект пользователя данного устройства

approveRequest - Запрос на подписание

callback - Реализация SignResultNetworkCallback для обработки результатов. При успехе возвращает массив результатов подписания, представленных объектами OperationsManager.SignResults

signDocuments

public static void signDocuments(User user,
                                 java.util.ArrayList<java.lang.String> documentIds,
                                 OperationsManager.SignParams params,
                                 SignResultNetworkCallback callback)

Подписание документов. Показывает экран с содержимым документов. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

user - Объект пользователя данного устройства

documentIds - Непустой список документов на подписание

params - Параметры подписания

callback - Реализация SignResultNetworkCallback для обработки результатов

signDocuments

public static void signDocuments(Activity parentActivity,
                                 User user,
                                 java.util.ArrayList<java.lang.String> documentIds,
                                 OperationsManager.SignParams params,
                                 SignResultNetworkCallback callback)

Подписание документов. Показывает экран с содержимым документов. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

parentActivity - Экземпляр Activity приложения, с которого будет запущено Activity из SDK. При этом Activity из SDK добавляется в стек той же задачи, в которой запущена parentActivity. Если указать null, то Activity из SDK будет запущена отдельной задачей из контекста приложения, переданного при инициализации

user - Объект пользователя данного устройства

documentIds - Непустой список документов на подписание

params - Параметры подписания

callback - Реализация SignResultNetworkCallback для обработки результатов

signDocumentsOffline

public static void signDocumentsOffline(User user,
                                        java.util.ArrayList<java.lang.String> documentIds,
                                        OperationsManager.SignParams params,
                                        ApproveRequestNetworkCallback callback)

Подписание документов без отправки запроса на сервер . Показывает экран с содержимым документов. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

user - Объект пользователя данного устройства

documentIds - Непустой список документов на подписание

params - Параметры подписания

callback - Реализация ApproveRequestNetworkCallback для обработки результатов

signDocumentsOffline

public static void signDocumentsOffline(Activity parentActivity,
                                        User user,
                                        java.util.ArrayList<java.lang.String> documentIds,
                                        OperationsManager.SignParams params,
                                        ApproveRequestNetworkCallback callback)

Подписание документов без отправки запроса на сервер . Показывает экран с содержимым документов. При необходимости ввода пароля показывает соответствующий экран.

Parameters:

parentActivity - Экземпляр Activity приложения, с которого будет запущено Activity из SDK. При этом Activity из SDK добавляется в стек той же задачи, в которой запущена parentActivity. Если указать null, то Activity из SDK будет запущена отдельной задачей из контекста приложения, переданного при инициализации

user - Объект пользователя данного устройства

documentIds - Непустой список документов на подписание

params - Параметры подписания

callback - Реализация ApproveRequestNetworkCallback для обработки результатов