Дерево страниц
Skip to end of metadata
Go to start of metadata

Сервис для работы с мониторами процессов, их создания, получения, обновления, удаления.

ru.intertrust.cmj.rest.tunable.object.processes.service.MonitorProcessingServiceImpl

extends: -

properties

name

return value

description

get

MonitorProcessingServiceПолучения сервиса из JS-обработчика

getData

TunableObjectREST.Resource

Возвращает ресурс, необходимый клиенту для использования на текущем шаге процесса

Параметры:

  • monitorId - String - UNID монитора процесса

deleteMonitor

Boolean

Удаляет монитор из хранилища

Параметры:

  • monitorId - String - UNID монитора процесса

getMonitor

IProcessMonitorВозвращает монитор процесса

getAll

List<IProcessMonitor>Возвращает мониторы всех процессов в системе

getAllByPerson

List<IProcessMonitor>

Возвращает мониторы для всех запущенных процессов указанного пользователя

Параметры:

getAllByClientId

List<IProcessMonitor>

Возвращает все мониторы процессов по идентификатору активной вкладки браузера

Параметры:

  • clientId - String - идентификатор сессии web-клиента. Привязан к вкладке браузера

getParams

Map<String, String>

Возвращает параметры процесса

Параметры:

  • monitorId - String - UNID монитора процесса

methods

name

return value

description

updateProgress


Обновление прогресса операции, выполняющейся на сервере и отправка её на клиент по WebSocket

Параметры:

  • monitorId - String - UNID монитора процесса
  • total - Integer - сколько необходимо для завершения операции, в %
  • done - Integer - сколько пройдено, в %

updateByHandler


Запись в монитор разультатов работы обработчика

Параметры:

  • monitorId - String - UNID монитора процесса
  • command - IProcessMonitor.Command - команда для выполения веб-клиентом
  • currentStageTitle - String - заголовок текущего состояния процесса для отображения
  • data  - TunableObjectREST.Resource - ресурс, необходимый для следующего шаге процесса
  • params - Map<String,String> - параметры процесса, необходимые на следующих шагах проесса

updateStatus


Устанавливает статус в монитор с сохранением в базу

Параметры:

setStatus


Установка опредленного статуса процесса

Параметры:

setServerStatus


Установка опредленного статуса серверной обработки процесса

Параметры:

notifyClients


Отправка представления монитора всем клиентам по WebSocket с целью информирования о текущем состоянии процесса

Параметры:

  • monitorId - String - UNID монитора процесса

sendToClient


Отправка представления монитора на клиент по WebSocket с целью выполнения действий на клиенте

Параметры:

  • monitorId - String - UNID монитора процесса

sendToClientForSelectNewActiveSession


Отправка предсталения монитора всем клиентам для выбора клиента, который будет стартовать автоматическую операцию. Выбор клиента происходит по следующей логике:

  • первому попавшемуся клиенту отправляется монитор с разрешением на выполнение клиентской операции без привлечения внимания пользовтеля. При этом SessionId этого клиента записывается в монитор.
  • всем остальным клиентам монитор отправляется без такого разрашения. При этом, если клиент с сохраненным SessionId отключится, то берется следующий первый попавшийся клиент.

Параметры:

  • monitor -  IProcessMonitor - монитор процесса
  • person - SOPersonSystem - инициатор процесса
  • needSendToNotActiveSessions - Boolean - true, если необходимо ли рассылать монитор всем клиентам

setActiveSessionAndSentAutoStartCommand


Установка активной websocket-сессии и отправка клиенту по этой сессии команды для автозапуска операции на клиенте

Параметры:

  • monitorId - String - UNID монитора процесса
  • person - SOPersonSystem - инициатор процесса
  • activeWSSessionId - String - id webSocket-сессии для которой надо выдать разрешение для авторзапуска клиентской операции
  • activeHttpSessionId - String - id http-сессии для которой надо выдать разрешение для авторзапуска клиентской операции
  • activeClientId - String - id клиента который подключился, однозначно идентифицирует вкладку браузера.

startClientOperation

Boolean

Выдача разрешения клиенту на обработку процесса, если процесс еще не занят другим клиентом. При этом статус меняется с WAIT_DATA_FROM_USER на CLIENT_PROCESSING

Параметры:

  • monitorId - String - UNID монитора процесса
  • clientId - String - идентификатор клиента

releaseClientOperation


Освобождение монитора клиентом, если пользователь отказался продолжать процесс прямо сейчас, но не превал её. При этом статус меняется с CLIENT_PROCESSING на WAIT_DATA_FROM_USER

Параметры:

  • monitorId - String - UNID монитора процесса
  • needNotify - Boolean -  

writeErrorDialog


Запись ошибки, блокирующей продолжение процесса. Формирование завершащего диалога для показа ошибки

Параметры:

  • monitorId - String - UNID монитора процесса
  • errorText - String - текст ошибки
  • stacktrace - String - стек-трейс ошибки

 markFinished


Помечает процесс заверешённым

Параметры:

  • monitorId - String - UNID монитора процесса

markAborted


Помечает процесс прерванным. Нужно для запуска отката изменений

Параметры:

  • monitorId - String - UNID монитора процесса

markDeleted


Помечает процесс удалённым. такой монитор не возвращается клиенту, и игнорирует попытки что-либо с ним сделать по инициативе клиента.

Параметры:

  • monitorId - String - UNID монитора процесса
Статус

ГОТОВО

Комментарий

Методы, свойства, внутренние классы