.. _blob_adapter_doc:

Общее описание
^^^^^^^^^^^^^^

**BLOB-адаптер**, программный модуль Витрины данных, предназначен для получения доступа из Витрины данных к BLOB-объектам 
ведомства. 

**BLOB-объект** - это специальный тип двоичных данных, предназначенный для хранения бинарных файлов: изображений, скан-копий 
документов, текстовых файлов и т.д. 

**BLOB-адаптер** предоставляет возможность настроить доступ к BLOB-объектам расположенным в **Хранилище BLOB-объектов**.

.. note:: Хранилище BLOB-объектов располагается на стороне ведомства и не является частью Витрины данных. 

BLOB-адаптер предназначен для следующих задач:

- настройка доступа в **Хранилище BLOB-объектов**;
- предоставление регламентированного доступа к BLOB-объектам;
- получение и отправка запросов на получение BLOB-объектов;
- чтение BLOB-объектов;
- сохранение BLOB-объектов на FTP-сервере (через СМЭВ3-адаптер).

Взаимодействие с BLOB-объектами возможно через запросы из **СМЭВ3** (через СМЭВ3-адаптер) или **Агента СМЭВ4**. 
Доступ к считыванию BLOB-объектов производится методом ``GET`` по протоколу **HTTP**/**HTTPS** (указывается в конфигурации, 
параметр ``host``) . 

Общая схема взаимодействия через BLOB-адаптер
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. _schema_blob:

.. figure:: /project_dtm/modules/blob-adapter/doc/uml/schema_blob.png
         :align: center
         :alt: Общая схема взаимодействия через BLOB-адаптер

         Общая схема взаимодействия через BLOB-адаптер

.. _blob_podd_adapter:

Взаимодействие через СМЭВ-адаптер
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Схема взаимодействия через СМЭВ-адаптер
#######################################

Общая схема получения BLOB-объектов через **СМЭВ-адаптер** выглядит следующим образом:

.. _schema_blob_podd:

.. figure:: /project_dtm/modules/blob-adapter/doc/uml/schema_blob_podd.png 
         :align: center
         :alt: Взаимодействие BLOB-адаптера через СМЭВ4-адаптер

         Взаимодействие BLOB-адаптера через СМЭВ4-адаптер

Процесс обработки запроса на получение BLOB-объекта (СМЭВ4-адаптер)
##################################################################

1. В **СМЭВ4** поступает запрос на получение данных из Витрины. 
2. **СМЭВ4** отправляет запрос в Витрину.
3. Витрина данных обрабатывает запрос и отправляет ответ. 
4. **СМЭВ4** считывает данные полученные от Витрины. В случае, если в теле 
   запроса содержится ссылка на **BLOB-объект** (например, изображение), отправляет запрос в 
   **BLOB-адаптер** на получение этого **BLOB-объекта**. BLOB-адаптер, считывает ссылку на **BLOB-объект** и обращается в Хранилище 
   **BLOB-объектов** на стороне ведомства. После получения **BLOB-объекта**, возвращает его в **СМЭВ4**.

.. _connect_blob_smev:

Взаимодействие через СМЭВ3-адаптер
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Схема взаимодействия через СМЭВ3-адаптер
########################################

.. _schema_blob_smev:

.. figure:: /project_dtm/modules/blob-adapter/doc/uml/schema_blob_smev.png 
         :align: center
         :alt: Взаимодействие BLOB-адаптера через СМЭВ4

         Взаимодействие BLOB-адаптера через СМЭВ4

Процесс обработки запроса на получение BLOB-объекта (через СМЭВ3-адаптер)
#########################################################################

1. Из внешней ИС в **СМЭВ4** поступает запрос на получение данных из Витрины. 
2. **СМЭВ3-адаптер** получает запрос и отправляет его в Витрину.
3. Витрина обращается к БД, подготавливает ответ на запрос. Если в запросе есть ссылка на **BLOB-объект**, **BLOB-адаптер** 
   обращается к **Хранилищу BLOB-объектов**, копирует **BLOB-объект**, выкладывает его на FTP-сервер СМЭВ4 и отправляет 
   ссылку на **BLOB-объект** в Витрину.
4. После того как **BLOB-объект** загружен на FTP-сервер **СМЭВ4**, Витрина отправляет ответ на запрос в **СМЭВ4**, в котором 
   содержится ссылка на **BLOB-объект** (сохраненный на FTP-сервере).
5. После получения ответа внешняя ИС может обратиться по ссылке и скачать **BLOB-объект** с FTP-сервера СМЭВ4.


Требования к серверу BLOB-адаптера
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Cледующие файлы не должны контролироваться системой управления конфигурации (при ее наличии), поскольку они должны быть 
   доступны процессу установки для создания и модификации:

- ``/etc/hosts``
- ``/etc/selinux/config``
- ``/etc/sysctl.conf``
- файлы директории ``/usr/lib/systemd/system/``
- ``/etc/sysconfig/iptables\*``
- ``/etc/firewalld/\*``
- ``/etc/docker/\*``

1. Снаружи сервер должен быть доступен по следующим портам:

-  22 (SSH).

Требования к Хранилищу BLOB-объектов
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Хранилище BLOB-объектов** должно поддерживать регламентированный витриной интерфейс доступа к BLOB-объектам по запросу. 

Для корректной работы с Хранилищем BLOB-объектов, необходимо выполнить следующие условия:

- Предоставить доступ:
  
  -  к таблицам с метаданными по документам, хранилища ведомства;
  -  к ссылкам на BLOB-объекты (изображения, архивы, pdf-файлы и т.д.) в хранилище ведомства, соответствующие метаданным.
  
- Предоставить связь между ссылками и метаданными, если они разнесены по разным хранилищам.

.. note:: Все обновления ссылок на документы происходят только через ETL, т.е. от Поставщика данных (ведомства) к Витрине. Обновление самих BLOB через витрину, с последующей проливкой в ведомства, не предусмотрено.

Требования к предоставляемому интерфейсу Хранилища BLOB-объектов (API-интерфейс)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**API-интерфейс** реализованный соответственно данной спецификации должен предоставляться Хранилищем BLOB-объектов для возможности 
успешного взаимодействия с Витриной.

**API-интерфейс** Хранилища BLOB-объектов должен использовать метод ``GET``, который поддерживается Витриной для получения 
тела BLOB-объекта из Хранилища BLOB-объектов.

С помощью **API-интерфейса** отправляется запрос на получение BLOB-объектов.

Считывание BLOB-объекта производится по протоколу HTTP (допустимо HTTPS, указывается в конфигурации файла ``application.yml``, 
параметр ``host`` (см. раздел :ref:`blob_adapter_config` в документе «Руководство администратора ПО «Витрина данных НСУД»)).