Менеджер соединений

Менеджер соединений предназначен для упрощения настройки блоков с использованием предварительно созданных наборов значений параметров, отвечающих за интеграцию с внешними ресурсами, такими как базы данных, REST сервисы, файловые хранилища и т.д.

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

Блоки, для которых доступны выбор соединения или создание нового, имеют на панели свойств блока параметр Connection. Ниже в таблице приведен список таких блоков.

• SQL

• JDBC

• CXF

• AWS S3

• HTTP Sender

• HTTPS Sender

• AMQP

• ActiveMQ v5

• ActiveMQ v6

• JMS

• Spring RabbitMQ

• Kafka

• SFTP

• FTP

• SMB

• SMTPS

• SMTP

• Debezium PostgreSQL

• Debezium Oracle

• Debezium SQL Server

Настройка соединения

Чтобы выбрать или сконфигурировать соединение, откройте панель свойств блока. Ранее добавленные соединения будут доступны в выпадающем списке в параметре Connection.

Для того, чтобы выбрать или добавить соединение, выполните следующие шаги:

1. Откройте панель свойств блока.

2. На открывшейся панели щелкните мышью по параметру-списку Connection.

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

Preview

Список соединений на панели свойств блока

3. Если среди соединений есть нужное, выберите его.

4. Если вам нужно новое соединение, то на развернувшейся форме нажмите Создать.

На экране откроется специализированный визард, состоящий из трех шагов настройки нового соединения.

Выбор системы

Любое соединение создается с привязкой к родительской системе.

Если вы хотите выбрать систему из уже созданных, воспользуйтесь формой поиска системы по имени, чтобы создать для нее соединение.

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

Параметры системы приведены в таблице ниже.

Параметр	Тип данных	Описание
Тип системы	Список	Обязательный параметр. Тип системы, в зависимости от блока, для которого она была добавлена: Database Application Messages Kafka Messages Files EMail SOAP AWS S3 Debezium
Доступность в доменах	Редактируемый список	Обязательный параметр. Список доменов, для которых данная система доступна.
Опубликовать для всех	Логическое значение	Параметр задает доступность системы для всех доменов в ESB. Если флажок установлен, то поле Доступность в доменах становится неактивным.
Название	Текст	Обязательный параметр. Название системы, введенное при ее создании.
Описание	Текст	Описание системы, введенное при ее создании.
Метки	Редактируемый список	Список меток системы.
Владелец	Текст	Контактные данные владельца системы.
Хост	Текст	Обязательный параметр. Адрес хоста системы. Недоступен для систем с типом: Kafka Messages, SOAP.
Порт	Текст	Обязательный параметр.
Брокеры через запятую (host:port)	Текст	Параметр применим только для систем Kafka Messages. Выбранные брокеры для Kafka.
Адрес	Текст	Параметр применим только для систем SOAP. Адрес до сервиса.
Регион	Текст	Параметр применим только для систем AWS S3. Регион подключения.

Создание системы

После нажатия на кнопку Создать на первом шаге визарда на экране отобразится окно Создание системы. Параметры, которые отображаются в форме системы выбранного типа, аналогичны параметрам в форме выбора существующей системы, см. Выбор системы.

Заполните параметры и нажмите Далее.

Создание соединения

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

Заполните параметры, описанные в таблице ниже и нажмите Завершить.

Параметр	Тип данных	Описание
Тип соединения	Список	Обязательный параметр. В зависимости от выбранного типа системы загружается шаблон формы ввода со списком параметров для этого типа.
Доступность в доменах	Редактируемый список	Обязательный параметр. Список доменов, для которых данное соединение доступно. Список наследуется от системы. Список имеет встроенную функцию поиска доменов. Все домены, выданные в списке сортируются в алфавитном порядке от "А" до "Я" сверху-вниз. Можно удалять домены из списка или добавлять прежде удаленные домены. Полный список ограничен теми доменами, которые были выбраны на системе ранее.
Название		Обязательный параметр. Название создаваемого соединения. Название должно быть уникальным в рамках системы.
Описание	Текст	Описание создаваемого соединения.
Метки	Редактируемый список	Список меток системы.
Владелец	Текст	Контактные данные владельца системы.
Тип авторизации	Список	Обязательный параметр. Поддерживаемый тип авторизации, согласно выбранному типу системы.
Тип базы данных	Список	Параметр применим только для типа соединения SQL. Обязательный параметр. База данных для подключения. В зависимости от выбранного типа будет использоваться свой JDBC драйвер во время активации. PostgreSQL MySQL Oracle IBM DB Maria DB SQL Light Clickhouse MS SQL Server Terradata Firebird
База данных	Текст	Параметр применим только для типа соединения SQL. Обязательный параметр. Название базы данных.
URI	Текст	Параметр применим только для типа соединения HTTP. Путь до вызываемого ресурса. Является префиксом в параметру, заполняемому на блоке. Суммарная строка вызова будет состоять из: [connection:protocol]://[system:host][system:port][connection:uri][block:uri]
Протокол	Список	Параметр применим только для типа соединения HTTP. Обязательный параметр. Протокол для доступа в систему: HTTP HTTPS
Допустимые типы контента	Редактируемый список	Параметр применим только для типа соединения HTTP. Заполняемый лист для типов контента.
Допустимые методы	Редактируемый список	Параметр применим только для типа соединения HTTP. Список методов, дозволенных к использованию. OPTIONS GET HEAD POST PUT PATCH DELETE TRACE CONNECT После выбора соединения с заполненным списком методов, соответствующее поле на блоке позволяет выбрать только эти методы.
Имя Bucket или Arn для подключения	Текст	Параметр применим только для типа соединения AWS S3. Обязательный параметр. Имя Bucket или Arn, к которому подключается блок.
Имя базы данных	Текст	Параметр применим только для типа соединения Debezium. Обязательный параметр. Имя базы данных к которому происходит соединение.
Уникальное имя Debezium соединения	Текст	Параметр применим только для типа соединения Debezium. Обязательный параметр. Уникальное имя Debezium соединения, проверяется на уникальность при сохранении свойств блока.
Уникальный префикс топика	Текст	Параметр применим только для типа соединения Debezium. Обязательный параметр. Уникальный префикс топика, к которому происходит соединение. Проверяется на уникальность при сохранении свойств блока.

После завершения выбора/создания системы и настройки соединения убедитесь в том, что созданное соединение доступно в списке соединений в параметре Connection.

Параметры методов аутентификации

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

Тип авторизации Basic

Поле	Тип	Описание
Пользователь	Текстовое поле	Имя пользователя для авторизации. Значение маскируется после ввода и доступно для чтения только если нажата иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.
Пароль	Текстовое поле	Пароль пользователя для авторизации. Значение маскируется после ввода и доступно для чтения только если нажата иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.

Тип авторизации Вход через аккаунт

Поле	Тип	Описание
Аккаунт	Текстовое поле	Имя аккаунта для входа. Примечание: Является секретом. Значение сохраняется в Vault.
Пользователь	Текстовое поле	Имя пользователя для авторизации. Значение маскируется после ввода и доступно для чтения только если нажата иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.
Пароль	Текстовое поле	Пароль пользователя для авторизации. Значение маскируется после ввода и доступно для чтения только если нажата иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.

Тип авторизации Вход с указанием домена

Поле	Тип	Описание
Домен	Текстовое поле	Имя домена для входа. Примечание: Является секретом. Значение сохраняется в Vault.
Пользователь	Текстовое поле	Имя пользователя для авторизации. Значение маскируется после ввода и доступно для чтения только если нажата иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.
Пароль	Текстовое поле	Пароль пользователя для авторизации. Значение маскируется после ввода и доступно для чтения только если нажата иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.

Тип авторизации OAuth2.0

Поле	Тип	Описание
Oauth2 Client Id	Текстовое поле	Идентификатор клиента для OAuth2.0. Значение маскируется после ввода и доступно для чтения только если нажата иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.
Oauth2 Client Secret	Текстовое поле	Имя секрета для OAuth2.0. Значение маскируется после ввода и доступно для чтения только если кликнута иконка глаза. Примечание: Является секретом. Значение сохраняется в Vault.
Oauth2 Token Endpoint	Текстовое поле	Адрес сервера получения токена.
Oauth2 Scope	Текстовое поле	Область доступа/действия для OAuth2.0

Тип авторизации Публичный ключ

Поле	Тип	Описание
Допустимые шифры	Список	Названия JCraft JSCH шифров через запятую.
Допустимые протоколы обмена ключей	Список	Протоколы обмена ключей через запятую.
Приватный ключ (Bytes)	Текстовое поле	Принимает приватный ключ в виде строки.
Проверочная фраза для проверки ключей	Текстовое поле	Парольная фраза для расшифровки файла приватного ключа, если он защищен паролем. Если ключ не зашифрован, этот параметр не нужен.

Тип авторизации SASL_PLAINTEXT

Поле	Тип	Описание
SASL механизм	Текстовое поле	Механизм аутентификации в рамках SASL. Значение по умолчанию: GSSAPI
SASL Jaas конфигурация	Текстовое поле	Строка конфигурации, содержащая логин и пароль для механизмов PLAIN или SCRAM. Задается в специальном формате JAAS. Пример: org.apache.kafka.common.security.plain.PlainLoginModule required username="admin" password="admin";

Тип авторизации SASL_SSL

Поле	Тип	Описание
SASL механизм	Текстовое поле	Механизм аутентификации в рамках SASL. Значение по умолчанию: GSSAP
SASL Jaas конфигурация	Текстовое поле	Строка конфигурации, содержащая логин и пароль для механизмов PLAIN или SCRAM. Задается в специальном формате JAAS. Пример: org.apache.kafka.common.security.plain.PlainLoginModule required username="admin" password="admin";
Путь до Truststore	Текстовое поле	Путь к файлу Truststore, который содержит CA-сертификаты или сертификаты самих брокеров, которым клиент доверяет.
Тип Truststore	Текстовое поле	Формат файла Truststore. Значение по умолчанию: JKS
Пароль Truststore	Текстовое поле	Пароль для доступа к Truststore.
Алгоритм Trust менеджера	Текстовое поле	Алгоритм, используемый TrustManager для проверки сертификатов. Значение по умолчанию: PKIX
Путь до Keystore	Текстовое поле	Путь к файлу Keystore, который содержит личный сертификат и приватный ключ клиента.
Тип Keystore	Текстовое поле	Формат файла Keystore. Значение по умолчанию: JKS
Пароль Keystore	Текстовое поле	Пароль для доступа к Keystore.
Пароль от приватного ключа	Текстовое поле	Пароль к приватному ключу внутри Keystore.
Набор поддерживаемых шифров через запятую	Текстовое поле	Список разрешенных шифров для соединения. Используется для отключения слабых или уязвимых шифров.
Имя объекта с SSL параметрами	Текстовое поле	Имя унифицированного объекта-контейнера, который инкапсулирует в себе всю конфигурацию SSL-контекста.
SSL протоколы через запятую	Текстовое поле	Список протоколов, разрешенных для использования.
Алгоритм для валидации хоста сервера	Текстовое поле	Алгоритм проверки имени хоста Значение по умолчанию: HTTPS
Алгоритм Key менеджера	Текстовое поле	Алгоритм, используемый KeyManager.
SSL протокол	Лист	Версия протокола SSL/TLS.
SSL провайдер	Текстовое поле	Какой провайдер SSL-библиотеки использовать.

Тип авторизации SSL для AWS S3

Данный тип авторизации применяется при настройке соединения посредством блока AWS S3.

Поле	Тип	Описание	Имя
Ключ доступа	Текстовое поле	Access ключ для подключения к AWS S3.	accessKey
Ключ секрета	Текстовое поле	Secret ключ для подключения к AWS S3.	secretKey

Тип авторизации SSL для Kafka

Данный тип авторизации применяется при настройке соединения посредством блока Kafka.

Поле	Тип	Описание	Имя
Путь до Truststore	Текстовое поле	Путь к файлу Truststore, который содержит CA-сертификаты или сертификаты самих брокеров, которым клиент доверяет.	sslTruststoreLocation
Тип Truststore	Текстовое поле	Формат файла Truststore. Значение по умолчанию: JKS	sslTruststoreType
Пароль Truststore	Текстовое поле	Пароль для доступа к Truststore.	sslTruststorePassword
Алгоритм Trust менеджера	Текстовое поле	Алгоритм, используемый TrustManager для проверки сертификатов. Значение по умолчанию: PKIX	sslTrustmanagerAlgorithm
Путь до Keystore	Текстовое поле	Путь к файлу Keystore, который содержит личный сертификат и приватный ключ клиента.	sslKeystoreLocation
Тип Keystore	Текстовое поле	Формат файла Keystore. Значение по умолчанию: JKS	sslKeystoreType
Пароль Keystore	Текстовое поле	Пароль для доступа к Keystore.	sslKeystorePassword
Пароль от приватного ключа	Текстовое поле	Пароль к приватному ключу внутри Keystore.	sslKeyPassword
Набор поддерживаемых шифров через запятую	Текстовое поле	Список разрешенных шифров для соединения. Используется для отключения слабых или уязвимых шифров.	sslCipherSuites
Имя объекта с SSL параметрами	Текстовое поле	Имя унифицированного объекта-контейнера, который инкапсулирует в себе всю конфигурацию SSL-контекста.	sslContextParameters
SSL протоколы через запятую	Текстовое поле	Список протоколов, разрешенных для использования.	sslEnabledProtocols
Алгоритм для валидации хоста сервера	Текстовое поле	Алгоритм проверки имени хоста Значение по умолчанию: HTTPS	sslEndpointAlgorithm
Алгоритм Key менеджера	Текстовое поле	Алгоритм, используемый KeyManager.	sslKeymanagerAlgorithm
SSL протокол	Лист	Версия протокола SSL/TLS.	sslProtocol
SSL провайдер	Текстовое поле	Провайдер SSL-библиотеки, который нужно использовать.	sslProvider

Тип авторизации SSL для Debezium PostgreSQL

Данный тип авторизации применяется при настройке соединения посредством блока Debezium PostgreSQL.

Поле	Тип	Описание	Имя
Пользователь	Текстовое поле	Пользователь для аутентификации.	databaseUser
Пароль	Текстовое поле	Пароль для аутентификации.	databasePassword
Полный путь до SSL сертификата	Текстовое поле	Полный путь до файла, который содержит SSL сертификат.	databaseSslcert
Имя класса создающий SSL сокеты	Текстовое поле	Полное имя класса, который исполняет логику работы с SSL сокетами.	databaseSslfactory
Полный путь до SSL ключа	Текстовое поле	Полный путь до файла, который содержит приватный SSL ключ.	databaseSslkey
Пароль от приватного ключа	Текстовое поле	Пароль для доступа к SSL ключу.	databaseSslpassword
Полный путь до корневого SSL сертификата	Текстовое поле	Полный путь до файла, который содержит корневой SSL сертификат.	databaseSslrootcert
SSL мод	Текстовое поле	Режим SSL, согласно: PostgreSQL: Documentation: 18: 32.19. SSL Support	databaseSslmode