Перейти к основному содержимому

СообщениеИнтеграции

Стд::ИнтеграционнаяШина::СообщениеИнтеграции Доступность: Сервер

Сообщение, передаваемое процессом интеграции.

Сравнение ссылочное

Иерархия типа​

Базовые типы: Объект

Дочерние типы: IntegrationProcessName.Сообщение

Конструкторы​

СообщениеИнтеграции​

Доступность: Сервер

СообщениеИнтеграции(
Параметры: ЧитаемоеСоответствие<Строка, Объект?>,
Тело: ПотокЧтения? = Неопределено)
Создает сообщение с параметрами Параметры и телом из потока Тело. Имя параметра должно состоять из латинских букв, цифр, символов $ или _, должно начинаться с буквы.

Исключения​

ИсключениеПроверкиТипа - если тип значения параметра не поддерживается. Поддерживаемые типы:

  • Неопределено
  • Строка
  • Число
  • Булево
  • Длительность
  • Момент
  • Байты
  • ЧитаемыйМассив<Объект?>, все элементы должны быть поддерживаемого типа
  • ЧитаемоеСоответствие<Строка, Объект?>, все значения должны быть поддерживаемого типа ИсключениеИнтеграционнойШины - если имя параметра - пустая строка или содержит недопустимые символы.

Примеры​

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

метод ОтправитьСообщение(Запрос: HttpСервисЗапрос)
    знч ЯвляетсяАрхивом = Запрос.Заголовки.ПолучитьПервый("content-type") == "application/zip"
    знч Сообщение = новый СообщениеИнтеграции({"IsArchive":ЯвляетсяАрхивом}, Запрос.Тело)
    СетьМагазинов.ОтправитьСообщениеВУзлы(Сообщение, СетьМагазинов.Схема.Узлы.ОтПартнеров)
;

Свойства​

Url​

Доступность: Сервер ТолькоЧтение

Url: Строка?

Url запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Uri".

АбсолютныйПутьФайла​

Доступность: Сервер ТолькоЧтение

АбсолютныйПутьФайла: Строка?

Абсолютный путь к файлу, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileAbsolutePath".

ЗапросHttp​

Доступность: Сервер ТолькоЧтение

ЗапросHttp: Строка?

Query в url запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Query".

Ид​

Доступность: Сервер ТолькоЧтение

Ид: Строка

Идентификатор сообщения.

ИменаВсехПараметров​

Доступность: Сервер ТолькоЧтение

ИменаВсехПараметров: ЧитаемыйМассив<Строка>

Имена всех параметров, которые есть в сообщении.

ИмяФайла​

Доступность: Сервер ТолькоЧтение

ИмяФайла: Строка?

Имя файла, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileName".

КаталогФайла​

Доступность: Сервер ТолькоЧтение

КаталогФайла: Строка?

Абсолютный путь к каталогу файла, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileParent".

КлючKafka​

Доступность: Сервер ТолькоЧтение

КлючKafka: Объект?

Ключ входящего сообщения Kafka. Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Key".

КлючМаршрутизацииRabbitMq​

Доступность: Сервер ТолькоЧтение

КлючМаршрутизацииRabbitMq: Строка?

Ключ маршрутизации для RabbitMq. Отличное от Неопределено значение, если сообщение получено от узлов типа RabbitMqИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "RabbitMq.RoutingKey".

КодОтветаHttp​

Доступность: Сервер ТолькоЧтение

КодОтветаHttp: Число?

Код ответа, который web-сервер выдал в ответ на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.ResponseCode".

КодировкаHttp​

Доступность: Сервер ТолькоЧтение

КодировкаHttp: Строка?

Кодировка, в которой web-сервер выдал ответ на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.CharacterEncoding".

КодыПолучателей​

Доступность: Сервер ТолькоЧтение

КодыПолучателей: ЧитаемыйМассив<Строка>

Массив, содержащий значения кодов справочника участников, которым должно быть доставлено сообщение. Определяет, в каналы для каких получателей будет доставлено сообщение. Может быть установлено отправителем сообщения и изменено при помощи метода УстановитьКодыПолучателей.

МетодHttp​

Доступность: Сервер ТолькоЧтение

МетодHttp: Строка?

Метод запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Method".

ОтметкаВремениОтправкиKafka​

Доступность: Сервер ТолькоЧтение

ОтметкаВремениОтправкиKafka: Число?

Отметка времени отправки сообщения Kafka в формате Unix Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Timestamp".

ОтносительныйПутьФайла​

Доступность: Сервер ТолькоЧтение

ОтносительныйПутьФайла: Строка?

Путь файла, из которого сформировано сообщение, относительно директории, заданной в свойстве Каталог узла источника. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileRelativePath".

Параметры​

Доступность: Сервер ТолькоЧтение

Параметры: ЧитаемоеСоответствие<Строка, Объект?>

Все пары "имя-значение" параметров, которые есть в сообщении.

ПутьHttp​

Доступность: Сервер ТолькоЧтение

ПутьHttp: Строка?

Путь в url запроса. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.Path".

РазделKafka​

Доступность: Сервер ТолькоЧтение

РазделKafka: Число?

Раздел топика Kafka, из которого получено входящее сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Partition".

РазмерФайла​

Доступность: Сервер ТолькоЧтение

РазмерФайла: РазмерБайтов?

Размер файла, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileSize".

СмещениеKafka​

Доступность: Сервер ТолькоЧтение

СмещениеKafka: Число?

Номер смещения входящего сообщения Kafka Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Offset".

ТекстОтветаHttp​

Доступность: Сервер ТолькоЧтение

ТекстОтветаHttp: Строка?

Текст ответа, который web-сервер выдал в ответ на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http.
Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.ResponseText".

ТекстОшибкиБд​

Доступность: Сервер ТолькоЧтение

ТекстОшибкиБд: Строка?

Текст ошибки обращения к базе данных из обработчика ОбработкаСообщения узла типа Sql. Значение Неопределено, если при выполнении обработчика не было ошибки обращения к базе данных или если сообщение получено от узла другого типа.
Эквивалентно вызову метода ПолучитьПараметр с параметром "DbErrorText".

ТипСодержимогоHttp​

Доступность: Сервер ТолькоЧтение

ТипСодержимогоHttp: Строка?

Тип содержимого ответа, который web-сервер выдал на запрос в узле типа Http. Отличное от Неопределено значение, если сообщение получено от узлов типа Http. Эквивалентно вызову метода ПолучитьПараметр с параметром "Http.ContentType".

ТопикKafka​

Доступность: Сервер ТолькоЧтение

ТопикKafka: Строка?

Топик Kafka, из которого получено входящее сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа KafkaИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "Kafka.Topic".

ФайлИзменен​

Доступность: Сервер ТолькоЧтение

ФайлИзменен: Момент?

Момент модификации файла, из которого сформировано сообщение. Отличное от Неопределено значение, если сообщение получено от узлов типа ФайлИсточник или FtpИсточник. Эквивалентно вызову метода ПолучитьПараметр с параметром "File.FileModified".

Методы​

Копировать​

Доступность: Сервер

Копировать(): СообщениеИнтеграции
Создает копию исходного СообщенияИнтеграции с новым идентификатором и возвращает его. Копия содержит все свойства, тело и параметры исходного сообщения.

Примеры​

Пример обработчика для узла типа Транслятор процесса интеграции с именем ОпросСайтов, в котором выполняется копирование исходного сообщения и добавление параметра с идентификатором исходного сообщения.

метод КопироватьСообщение(Контекст: КонтекстВызоваИнтеграции, Сообщение: ОпросСайтов.Сообщение): СообщениеИнтеграции
    // создание копии сообщения с новым идентификатором с сохранением идентификатора исходного сообщения
    пер НовоеСообщение = Сообщение.Копировать().УстановитьПараметр("ИдКорреляции", Сообщение.Ид)   
   
    возврат НовоеСообщение
;

ПолучитьПараметр​

Доступность: Сервер

ПолучитьПараметр(Имя: Строка): Объект?
Возвращает значение параметра сообщения по имени Имя.

Исключения​

ИсключениеНедопустимыйАргумент - если сообщение не содержит параметр с указанным именем.

ПолучитьПараметрИлиУмолчание​

Доступность: Сервер

ПолучитьПараметрИлиУмолчание(
Имя: Строка,
Умолчание: Объект?
): Объект?
Возвращает значение параметра сообщения по имени Имя или значение Умолчание, если сообщение не содержит параметр с указанным именем.

Примеры​

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

метод ПроверкаУпаковки(Контекст: КонтекстВызоваИнтеграции, Сообщение: СетьМагазинов.Сообщение): Коллекция<УзелСхемыИнтеграции>
    если Сообщение.ПолучитьПараметрИлиУмолчание("IsArchive", Неопределено) как Булево
        возврат [Схема.Узлы.ВходящиеОтПартнеров]
    ;
    возврат [Схема.Узлы.УпаковкаДляОфиса]
;

ПолучитьТелоКакПоток​

Доступность: Сервер

ПолучитьТелоКакПоток(): ПотокЧтения
Возвращает поток для чтения тела сообщения.

СодержитПараметр​

Доступность: Сервер

СодержитПараметр(Имя: Строка): Булево
Возвращает Истина, если сообщение содержит параметр с именем Имя, иначе Ложь.

УдалитьПараметр​

Доступность: Сервер

УдалитьПараметр(Имя: Строка): СообщениеИнтеграции
Удаляет параметр сообщения с именем Имя. Возвращает новое сообщение.

УстановитьКодыПолучателей​

Доступность: Сервер

УстановитьКодыПолучателей(Значение: ЧитаемыйМассив<Строка>): СообщениеИнтеграции
Устанавливает значение Значение свойства КодыПолучателей. Возвращает новое сообщение.

УстановитьПараметр​

Доступность: Сервер

УстановитьПараметр(
Имя: Строка,
Значение: Объект?
): СообщениеИнтеграции
Устанавливает значение Значение параметра сообщения с именем Имя. Имя параметра должно состоять из латинских букв, цифр, символов $ или _, должно начинаться с буквы.

Исключения​

ИсключениеПроверкиТипа - если тип значения Значение не поддерживается. Поддерживаемые типы:

  • Неопределено
  • Строка
  • Число
  • Булево
  • Длительность
  • Момент
  • Байты
  • ЧитаемыйМассив<Объект?>, все элементы должны быть поддерживаемого типа
  • ЧитаемоеСоответствие<Строка, Объект?>, все значения должны быть поддерживаемого типа ИсключениеИнтеграционнойШины - если имя параметра - пустая строка или содержит недопустимые символы.

УстановитьТелоИзПотока​

Доступность: Сервер

УстановитьТелоИзПотока(Поток: ПотокЧтения): СообщениеИнтеграции
Устанавливает тело сообщения из потока Поток. Возвращает новое сообщение.

Список унаследованных методов​

Объект​

ВСтроку, ПолучитьТип, Представление

Последнее обновление