Процессоры
Процессор - обработчик, который обрабатывает сообщение произвольным образом.
Подробнее - https://camel.apache.org/manual/processor.html
Контракты процессоров описаны по ecos-camel-core 1.17.1 на Apache Camel 4.14.8. Учитывайте различия поставок и версий библиотеки при подключении к своему приложению.
Процессор подключается к маршруту объявлением бина и шагом process:
- beans:
- name: myProcessor
type: ru.citeck.ecos.camel.processor.data.ReverseArrayProcessor
- route:
from:
uri: direct:reverse
steps:
- process:
ref: myProcessor
Формат данных для преобразований
Процессоры MappingProcessor, JsonPatchOperationsProcessor, StringValuesOperationsProcessor, MapAssocRefsProcessor, AuthorityNameToRefProcessor, MutateInnerRecordsProcessor, PrepareToMutateProcessor, FindOrCreateRecordProcessor работают с объектом DataValue, массивом DataValue либо коллекцией объектов. Элементы коллекции преобразуются в DataValue; обработчик получает копию каждого элемента. Одиночные Map, ObjectData и строка JSON без предварительного преобразования остаются без изменений. null также проходит без изменений.
Заголовки конфигурации, прочитанные этими процессорами, удаляются после обработки сообщения. Имена и назначение заголовков приведены в соответствующих разделах.
Ограничения привязки свойств из yaml
Не всякое свойство можно задать вложенной структурой yaml. Ограничения и принятые обходные пути:
Что нужно задать |
Как это делается |
|---|---|
Список значений |
Строкой через запятую:
rejectedFirstBytes: "<,{".Вложенная последовательность yaml не привязывается — загрузка маршрута завершается ошибкой Unsupported type: SEQUENCE.
|
Список, элементы которого сами содержат запятую (например, регулярные выражения) |
Строкой через точку с запятой: |
Упорядоченный набор пар «имя — значение» |
Строкой пар:
fields: "a=header.A,b=header.B".Вложенная карта привязывается плоскими ключами
fields.<имя> и сортируется по имени, поэтому объявленный порядок молча теряется. Для процессоров, где порядок важен (подпись формы), это критично. |
Карта, порядок ключей которой не важен |
Вложенной картой yaml, как у |
CsvToListOfDataProcessor
Данный процессор предназначен для чтения CSV-данных и преобразования их в список объектов DataValue:
Первая строка файла - заголовки, последующие - данные, соответствующие заголовкам
Параметры:
Key |
Value |
|---|---|
delimiter |
Разделитель. По умолчанию запятая |
Пример:
- beans:
- name: "csvToListOfDataProcessor"
type: ru.citeck.ecos.camel.processor.reader.CsvToListOfDataProcessor
properties:
delimiter: ";"
- route:
from:
uri: "file-from-camel-dsl:randomName"
steps:
- process:
ref: csvToListOfDataProcessor
- split:
simple: "${body}"
steps:
- to: ecos-records-mutate:?sourceId=emodel/camel-example-employee
ExcelToListOfDataProcessor
Данный процессор предназначен для чтения данных из формата Excel (XLSX) и преобразования их в список объектов DataValue:
Параметры:
Key |
Value |
|---|---|
sheetName |
Название листа Excel. По умолчанию используется первый лист |
tableStartCellReference |
Ссылка на начальную ячейку таблицы (откуда начинается строка с заголовками). По умолчанию «A1» |
lastDataRowNumber |
Верхняя граница чтения в нумерации Excel (начиная с 1). По умолчанию -1 — последняя строка листа. Полностью пустая строка в выбранных колонках завершает чтение раньше этой границы |
customAttNames |
Ассоциативный массив пользовательских имен атрибутов, где ключ - буква столбца (например, «A»), а значение - желаемое имя атрибута. |
Пример:
- beans:
- name: "excelProcessor"
type: ru.citeck.ecos.camel.processor.reader.ExcelToListOfDataProcessor
properties:
sheetName: SomeRandomSheetName
tableStartCellReference: C11
customAttNames:
C: employeeSalary
F: employeeManager
- route:
from:
uri: "file-from-camel-dsl:randomName"
steps:
- process:
ref: excelProcessor
- split:
simple: "${body}"
steps:
- to: "ecos-records-mutate:?sourceId=emodel/camel-example-employee"
Примечание
Чтение завершается на первой существующей строке, в которой все выбранные ячейки дают пустую строку: данные ниже нее не попадут в результат. Отсутствующие строки листа при этом пропускаются. Проверьте структуру таблицы перед импортом.
AssocRefByAttributeProcessor
Данный процессор принимает объект DataValue и на основании переданных заголовков (обязательных) находит EntityRef необходимой ассоциации и проставляет это значение в DataValue:
Параметры заголовков («setHeader» должен быть под именем «AssocRefByAttributeConfig»):
Key |
Value |
|---|---|
sourceId |
ID источника данных где будем искать ассоциацию |
findByAttribute |
Системное имя атрибута, по которому будем искать ассоциацию |
attributeKey |
Название ключа атрибута в переданном DataValue |
onMiss |
Необязательный режим: NULL (по умолчанию, также при пустом значении) либо ERROR. Регистр не важен |
В режиме NULL выполняется queryOne; если запись не найдена, атрибут получает null. В режиме ERROR пустое исходное значение возвращает null без запроса, отсутствие записи вызывает RecordKeyResolutionException с причиной NOT_FOUND, а несколько совпадений — с причиной AMBIGUOUS. Явная проверка неоднозначности выполняется только в режиме ERROR. Прочитанный заголовок AssocRefByAttributeConfig удаляется.
Пример:
- beans:
- name: "csvToListOfDataProcessor"
type: ru.citeck.ecos.camel.processor.reader.CsvToListOfDataProcessor
- name: "assocRefByAttributeProcessor"
type: ru.citeck.ecos.camel.processor.data.AssocRefByAttributeProcessor
- route:
from:
uri: "file-from-camel-dsl:randomName"
steps:
- process:
ref: csvToListOfDataProcessor
- setHeader:
name: AssocRefByAttributeConfig
constant:
sourceId: "emodel/camel-example-position"
findByAttribute: "name"
attributeKey: "position"
- process:
ref: assocRefByAttributeProcessor
- split:
simple: "${body}"
steps:
- to: "ecos-records-mutate:?sourceId=emodel/camel-example-employee"
CopyJournalSettingsProcessor
Данный процессор преобразует данные о шаблонах журнала, помогая тем самым перекопировать шаблоны от 1 журнала к другому.
Для его использования необходимо добавить его, с соответствующей конфигурацией, в свой конфигурационный yml файл:
- beans:
- name: copyJournalSettings
type: ru.citeck.ecos.camel.processor.data.CopyJournalSettingsProcessor
properties:
journalSettingMappingConfigs:
- journalId: test-journal
journalOldId: test-old-journal
mapping:
attFieldName: attOldFieldName
- journalId: signerType
journalOldId: old-signerType
mapping:
stTitle: old:stType
stDescription: old:stDescription
Где:
name - Имя процессора, которое мы будем использовать в роутах Camel DSL
type - Класс, на основе которого создается процессор (Неизменяемый параметр)
properties - Конфигурация нашего класса. Нам необходимо заполнить переменную journalSettingMappingConfigs, которая является списком настроек для копирования шаблонов для журналов. Переменные настроек:
journalId - Id журнала в котором мы хотим создавать шаблоны
journalOldId - Id журнала из которого мы будем забирать шаблоны и переносить их в новый журнал
mapping - маппинг сопоставления колонок между старым журналом и новым. В качестве ключа указывается Id колонки из журнала в который мигрируем, а в качестве значения - из которого мигрируем
Далее мы просто используем данный процессор в своем Camel DSL роуте.
Пример полноценного роута с данным процессором:
---
- beans:
- name: copyJournalSettings
type: ru.citeck.ecos.camel.processor.data.CopyJournalSettingsProcessor
properties:
journalSettingMappingConfigs:
- journalId: test-journal
journalOldId: test-old-journal
mapping:
attFieldName: attOldFieldName
- journalId: signerType
journalOldId: old-signerType
mapping:
stTitle: old:stType
stDescription: old:stDescription
# copy-journal-settings
- route:
from:
uri: ecos-records-sync-consumer:copy-journal-settings
parameters:
delay: 60000
sourceId: uiserv/journal-settings
predicate:
t: and
v:
- t: not
v:
t: ends
a: id
v: -mgr
- t: in
a: journalId
v:
- old-signerType
attributes:
id: ?localId
name: name?json
authority: authority
journalId: journalId
settings: settings
steps:
- split:
simple: "${body}"
steps:
- process:
ref: copyJournalSettings
- to:
uri: ecos-records-mutate:?sourceId=uiserv/journal-settings
Примечания:
В предикате поиска мы указываем 2 предиката: 1-ый проверяет, что id**шаблона не заканчивается на *-mgr*, поскольку данный суффикс будут иметь перекопированные шаблоны и их не нужно обрабатывать. **2-ой указывает список журналов из которых мы хотим брать шаблоны для перекопирования (По идее тут должны быть журналы их конфигурации процессора, которые записаны в параметры journalOldId).
attributes остаются без изменения, поскольку данные поля обрабатываются в процессоре и переносятся в новый журнал.
В шаге роута используется split чтобы обрабатывать каждый шаблон по отдельности.
CreateEcosHistoryDocumentMirrorProcessor
Класс
ru.citeck.ecos.camel.processor.data.CreateEcosHistoryDocumentMirrorProcessor
Вход/Выход
Поддерживается общий формат данных для преобразований: одиночный DataValue, массив DataValue либо коллекция объектов. Обрабатывается копия каждого элемента; для Collection возвращается список, для массива DataValue — новый массив DataValue.
Одиночные Java Map, ObjectData и строка JSON без предварительного преобразования остаются без обработки. Чтобы обработать одну такую запись, сначала преобразуйте ее в DataValue.
Описание
Создает связь между двумя записями DocumentRef и DocumentMirrorRef в БД ecos-history чтобы при загрузке истории для записи DocumentMirrorRef так же подтягивалась история записи DocumentRef.
При обработке сами записи истории не меняются и можно безопасно вызывать этот процессор для одной и той же записи многократно.
Процессор используется при миграции сущностей из одного хранилища в другое.
Свойства
Name |
Тип |
Описание |
|---|---|---|
documentMirrorSourceId |
String |
см. хидеры → CreateEcosHistoryDocumentMirrorMirrorSourceId |
documentMirrorRefIdPrefix |
String |
см. хидеры → CreateEcosHistoryDocumentMirrorDocumentMirrorRefIdPrefix |
documentRefIdPrefix |
String |
см. хидеры → CreateEcosHistoryDocumentMirrorDocumentRefIdPrefix |
Хидеры
Name |
Тип |
По умолчанию |
Описание |
|---|---|---|---|
CreateEcosHistoryDocumentMirrorConfig |
Объект: documentMirrorRefIdPrefix: String = "",
documentRefIdPrefix: String = "",
documentMirrorSourceId: String = "",
documentRef: String = "",
documentMirrorRef: String = ""
|
{} |
Общий объект конфигурации для всех настроек, которые описаны ниже.
Имеет меньший приоритет по сравнению с соответствующими хидерами ниже.
|
CreateEcosHistoryDocumentMirrorDocumentRef |
String |
Берется атрибут «id» из value и к нему добавляется префикс, который задан в
documentRefIdPrefix (CreateEcosHistoryDocumentMirrorDocumentRefIdPrefix)
|
Документ, из которого мы хотим передавать историю |
CreateEcosHistoryDocumentMirrorDocumentRefIdPrefix |
String |
«» |
Используется для формирования полного рефа в documentRef на базе атрибута «id» в обрабатываемом значении. |
CreateEcosHistoryDocumentMirrorDocumentMirrorRef |
String |
Берется атрибут «id» из value и к нему добавляется префикс, который задан в
documentMirrorRefIdPrefix (CreateEcosHistoryDocumentMirrorDocumentMirrorRefIdPrefix)
Если префикс не задан или атрибут id отсутствует, то берется documentRef и у него меняется sourceId на
documentMirrorSourceId (CreateEcosHistoryDocumentMirrorMirrorSourceId)
|
Документ, которому мы хотим передавать историю |
CreateEcosHistoryDocumentMirrorDocumentMirrorRefIdPrefix |
String |
«» |
Используется для формирования полного рефа в documentMirrorRef на базе атрибута «id» в обрабатываемом значении. |
CreateEcosHistoryDocumentMirrorMirrorSourceId |
String |
«» |
Используется для формирования полного рефа в documentMirrorRef на базе значения documentRef с заменой sourceId на указанное здесь значение. |
Пример Camel YAML DSL конфига
---
- beans:
- name: createHistoryDocumentMirror
type: ru.citeck.ecos.camel.processor.data.CreateEcosHistoryDocumentMirrorProcessor
- route:
from:
uri: ecos-records-sync-consumer:alf-route-template-code
parameters:
sourceId: alfresco/
predicate:
t: eq
a: _type
v: route-template-code
addAuditAttributes: true
attributes:
id: ?localId
steps:
- setHeader:
name: CreateEcosHistoryDocumentMirrorConfig
constant:
documentRefIdPrefix: 'alfresco/@workspace://SpacesStore/'
documentMirrorRefIdPrefix: 'emodel/route-template-code@'
- process:
ref: createHistoryDocumentMirror
GetRecordAttsProcessor
Класс: ru.citeck.ecos.camel.processor.GetRecordAttsProcessor
Загружает заданный набор атрибутов одной или нескольких записей. Загрузка выполняется от имени системы; список ссылок читается одним пакетным вызовом Records API.
Свойство |
Тип |
Обязательность |
Описание |
|---|---|---|---|
attributes |
Map<String, String> |
Да |
Вложенная карта «псевдоним — схема атрибута». Порядок ключей значения не имеет |
Вход: тело — ссылка на запись (EntityRef или строка), коллекция ссылок либо массив DataValue с текстовыми ссылками. Некорректная или пустая ссылка вызывает ошибку; для списка в ошибке указывается индекс элемента.
Выход: для одной ссылки — ObjectData с атрибутами, для списка — список ObjectData в исходном порядке. Пустой список дает пустой результат. Чтобы отличать отсутствующую запись, включите в attributes атрибут _notExists?bool.
Заголовки: собственных заголовков нет.
- beans:
- name: getAtts
type: ru.citeck.ecos.camel.processor.GetRecordAttsProcessor
properties:
attributes:
name: _name
created: _created
- route:
from:
uri: direct:read-record-atts
steps:
- process:
ref: getAtts
EcosContentReadProcessor
Класс: ru.citeck.ecos.camel.processor.reader.EcosContentReadProcessor
Читает содержимое записи и кладет его в тело сообщения, чтобы передать дальше по маршруту. Чтение выполняется от имени системы.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
contentAttribute |
String |
_content |
Атрибут записи, из которого читается содержимое |
outputType |
BYTE_ARRAY | STRING | BASE64 |
BYTE_ARRAY |
В каком виде содержимое попадет в тело: массив байт, текст или строка base64.
Значение разбирается с учетом регистра, неизвестное значение отклоняется при загрузке маршрута
|
Вход: тело — ссылка на запись.
Ошибки на сообщении: пустое тело, некорректная ссылка или отсутствующее содержимое.
Выход: тело заменяется содержимым в выбранном формате. Заголовки: собственных заголовков нет.
- beans:
- name: readContent
type: ru.citeck.ecos.camel.processor.reader.EcosContentReadProcessor
properties:
contentAttribute: _content
outputType: STRING
- route:
from:
uri: direct:readContent
steps:
- process:
ref: readContent
ListOfDataToCsvProcessor
Класс: ru.citeck.ecos.camel.processor.writer.ListOfDataToCsvProcessor
Собирает CSV из списка записей — обратная операция к CsvToListOfDataProcessor. Типичный вход — результат ecos-records-query или ecos-records-sync-consumer.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
columns |
String |
Колонки строкой через запятую:
key либо key:Заголовок.Если не задано, колонки берутся из ключей первой записи
|
|
delimiter |
String |
, |
Разделитель, ровно один символ |
withHeader |
Boolean |
true |
Записывать ли строку заголовков |
recordSeparator |
String |
\r\n |
Разделитель строк |
quoteMode |
MINIMAL | ALL | NON_NUMERIC | NONE |
MINIMAL |
Режим экранирования кавычками |
escape |
String |
Символ экранирования, ровно один символ.
При
quoteMode: NONE и незаданном значении используется \\ |
Вход: тело — коллекция записей. Строка, не являющаяся объектом, отклоняется с указанием ее номера.
Выход: тело заменяется строкой CSV.
Заголовки: собственных заголовков нет.
- beans:
- name: writeCsv
type: ru.citeck.ecos.camel.processor.writer.ListOfDataToCsvProcessor
properties:
columns: "id:ID,name:Название"
delimiter: ";"
withHeader: true
- route:
from:
uri: direct:writeCsv
steps:
- process:
ref: writeCsv
MappingProcessor
Класс: ru.citeck.ecos.camel.processor.data.MappingProcessor
Переименовывает ключи атрибутов и подменяет их значения — например, чтобы привести данные внешней системы к именам и значениям, принятым в ECOS.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
keysMapping |
Map<String, String> |
{} |
Карта «старый ключ — новый ключ». Значение переносится, старый ключ удаляется |
valuesMapping |
Map<String, Map> |
{} |
Карта «атрибут — карта соответствия значений».
Ключ
* — значение по умолчанию для всех значений, не перечисленных явно |
Вход и выход: формат данных для преобразований. Заголовки: собственных заголовков нет.
- beans:
- name: mapping
type: ru.citeck.ecos.camel.processor.data.MappingProcessor
properties:
keysMapping:
ID: id
NAME: _name
valuesMapping:
status:
NEW: draft
"*": unknown
- route:
from:
uri: direct:map-record
steps:
- process:
ref: mapping
JsonPatchOperationsProcessor
Класс: ru.citeck.ecos.camel.processor.data.JsonPatchOperationsProcessor
Применяет к каждому элементу тела последовательность операций правки JSON, позволяя менять структуру данных настройкой, а не скриптом.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
operations |
List |
[] |
Последовательность операций. У каждой обязательно поле
op:add — path, value, необязательный idx;remove — path;rename-key — path, oldKey, newKey;set — path, value, необязательный key.Неизвестное значение
op отклоняется при загрузке маршрута |
Заголовок на входе: JsonPatchOperations — дополнительные операции того же вида для одного сообщения; применяются после настроенных, после чтения заголовок удаляется из сообщения.
Вход и выход: формат данных для преобразований.
В примере вызывающая сторона передает список операций в заголовке JsonPatchOperations.
- beans:
- name: patchData
type: ru.citeck.ecos.camel.processor.data.JsonPatchOperationsProcessor
- route:
from:
uri: direct:patchData
steps:
- process:
ref: patchData
Пример значения заголовка (список объектов):
- op: set
path: status
value: draft
StringValuesOperationsProcessor
Класс: ru.citeck.ecos.camel.processor.data.StringValuesOperationsProcessor
Применяет цепочку строковых преобразований ко всем текстовым значениям в теле сообщения.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
operations |
List |
[] |
Последовательность операций, у каждой поле
op: replace и replaceFirst (substring либо substringRegex и replacement), trim, uppercase, lowercase, substringBefore, substringAfter, substringAfterLast (delimiter, необязательный missingDelimiterValue).Неизвестное значение
op отклоняется при загрузке маршрута |
matchRegex |
String |
Обрабатываются только значения, целиком совпадающие с этим выражением. Если не задано, обрабатываются все |
|
maxDepth |
Int |
2 |
Глубина обхода вложенных объектов и массивов |
excludePaths |
List<String> |
[] |
Пути атрибутов через точку, которые пропускаются вместе с вложенными |
includePaths |
List<String> |
[] |
Если список не пуст, обрабатываются только эти пути и вложенные в них |
Заголовок на входе: StringValuesOperations — дополнительные операции для одного сообщения; после чтения заголовок удаляется.
Вход и выход: формат данных для преобразований.
В примере вызывающая сторона передает список операций в заголовке StringValuesOperations.
- beans:
- name: normalizeStrings
type: ru.citeck.ecos.camel.processor.data.StringValuesOperationsProcessor
- route:
from:
uri: direct:normalizeStrings
steps:
- process:
ref: normalizeStrings
Пример значения заголовка (список объектов):
- op: trim
- op: uppercase
MapAssocRefsProcessor
Класс: ru.citeck.ecos.camel.processor.data.MapAssocRefsProcessor
Переписывает значения ассоциаций в ссылки на записи другого источника данных. Значения, для которых соответствия не нашлось, остаются как есть — ошибки не возникает.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
ecosTypeToSourceIdMapping |
Map<String, String> |
{} |
Карта «локальный идентификатор типа — целевой sourceId». Применяется, когда значение является объектом-ссылкой |
sourceIdByKeyMapping |
Map<String, String> |
{} |
Карта «имя атрибута — целевой sourceId». Применяется, когда значение является строкой с локальным идентификатором |
ecosTypeAttribute |
String |
_type |
Поле объекта-ссылки, в котором лежит тип |
assocRefAttribute |
String |
?localId |
Поле объекта-ссылки, в котором лежит локальный идентификатор |
Вход и выход: формат данных для преобразований. Заголовки: собственных заголовков нет.
- beans:
- name: mapAssociations
type: ru.citeck.ecos.camel.processor.data.MapAssocRefsProcessor
properties:
ecosTypeToSourceIdMapping:
department: emodel/department
sourceIdByKeyMapping:
department: emodel/department
- route:
from:
uri: direct:mapAssociations
steps:
- process:
ref: mapAssociations
MutateInnerRecordsProcessor
Класс: ru.citeck.ecos.camel.processor.data.MutateInnerRecordsProcessor
Сохраняет вложенные записи, встроенные в тело под указанными атрибутами, и заменяет их ссылками на сохраненные записи. Применяется, когда вместе с основной записью приходят связанные с ней дочерние.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
sourceId |
String |
Источник данных, в котором сохраняются вложенные записи.
Значение можно переопределить заголовком
MutateInnerRecordsSourceId. Если оно не задано ни свойством, ни заголовком, обработка сообщения завершается ошибкой |
|
assocAtts |
String либо List<String> |
[] |
Атрибуты тела, в которых лежат вложенные записи. Строкой через запятую или списком |
Заголовки на входе: MutateInnerRecordsAssocAtts — дополнительные атрибуты; MutateInnerRecordsSourceId — источник данных для одного сообщения.
Прочитанные заголовки удаляются. Вход и выход: формат данных для преобразований; вложенный объект заменяется одной ссылкой, массив объектов — массивом ссылок.
- beans:
- name: saveChildren
type: ru.citeck.ecos.camel.processor.data.MutateInnerRecordsProcessor
properties:
sourceId: emodel/import-item
assocAtts: "items"
- route:
from:
uri: direct:saveChildren
steps:
- process:
ref: saveChildren
ReverseArrayProcessor
Класс: ru.citeck.ecos.camel.processor.data.ReverseArrayProcessor
Меняет порядок элементов списка или массива в теле сообщения на обратный — например, чтобы перевернуть порядок результатов запроса. Свойств нет. Тело другого вида остается без изменений, ошибки не возникает.
Заголовки: собственных заголовков нет. Поддерживаются коллекции List, массивы Java и массивы DataValue.
- beans:
- name: reverseRecords
type: ru.citeck.ecos.camel.processor.data.ReverseArrayProcessor
- route:
from:
uri: direct:reverseRecords
steps:
- process:
ref: reverseRecords
PrepareToMutateProcessor
Класс: ru.citeck.ecos.camel.importdata.processor.PrepareToMutateProcessor
Дополняет набор атрибутов записи перед сохранением: проставляет рабочее пространство и, если тип является делом (case), выставляет состояние draft. Настраивается не свойствами, а заголовком сообщения.
Заголовок на входе: PrepareToMutateProcessorConfig — объект с полями typeId (обязателен) и workspace (необязателен).
Ошибки на сообщении: пустой typeId; отсутствие в теле хотя бы одного ключа, похожего на идентификатор атрибута.
Свойства: отсутствуют. Прочитанный заголовок удаляется. Вход и выход: формат данных для преобразований.
- beans:
- name: prepareRecord
type: ru.citeck.ecos.camel.importdata.processor.PrepareToMutateProcessor
- route:
from:
uri: direct:prepare-record
steps:
- setHeader:
name: PrepareToMutateProcessorConfig
constant:
typeId: emodel/type@import-item
workspace: demo
- process:
ref: prepareRecord
HmacSignatureProcessor
Класс: ru.citeck.ecos.camel.processor.HmacSignatureProcessor
Вычисляет подпись по упорядоченному набору значений и записывает ее в заголовок или в поле тела — чтобы маршрут мог подписывать исходящие запросы настройкой, а не скриптом.
Значения задаются ссылками: const.<литерал>, header.<имя>, variable.<имя>, body.<поле>, а также secret.username, secret.password, secret.token.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
components |
List<String> |
Обязательно. Упорядоченный список ссылок на значения. Для YAML используйте фабрику
#class:java.util.List#of(...), как в примере ниже |
|
algorithm |
sha256 | hmac-sha256 |
sha256 |
Алгоритм подписи, регистр не важен |
keyComponent |
String |
Ссылка на значение ключа. Обязательна при |
|
secretId |
String |
Идентификатор секрета. Обязателен, если хотя бы одна ссылка начинается с |
|
signatureHeader |
String |
Заголовок, в который записывается подпись |
|
signatureBodyField |
String |
Поле тела, в которое записывается подпись |
Должно быть задано ровно одно из signatureHeader и signatureBodyField. Подпись записывается строкой шестнадцатеричных символов в нижнем регистре.
Пример: ecos-camel-examples/hmac-signature.
Вход: обмен со значениями, указанными в components и keyComponent. Для записи в signatureBodyField тело должно быть JSON-объектом: DataValue, Map или строкой JSON. Секрет читается от имени системы.
Заголовки: входные header.* не удаляются; на выходе заполняется signatureHeader, если выбран этот способ записи. При записи в заголовок тело сохраняется.
- beans:
- name: signRequest
type: ru.citeck.ecos.camel.processor.HmacSignatureProcessor
properties:
algorithm: sha256
secretId: mango-api
components: "#class:java.util.List#of('secret.username','body.json','secret.password')"
signatureBodyField: sign
- route:
from:
uri: direct:signRequest
steps:
- process:
ref: signRequest
Полный маршрут: каталог примеров.
MaskedExceptionDescriberProcessor
Класс: ru.citeck.ecos.camel.processor.MaskedExceptionDescriberProcessor
Предназначен для обработчика ошибок маршрута. Описывает перехваченное исключение в переменные обмена, маскируя учетные данные, чтобы они не попали в журнал. Процессор никогда не бросает исключений: при отсутствии исключения он записывает значения по умолчанию, а не ломает обработчик ошибок.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
maskFields |
String |
Имена полей строкой через запятую. Скрывается значение поля в трех формах:
поле=значение, "поле": "значение" и {поле=значение}, а также в заголовке авторизации |
|
maskPatterns |
String |
Регулярные выражения строкой через точку с запятой (не через запятую: запятая встречается внутри выражений).
Скрывается содержимое групп захвата, текст вокруг сохраняется; выражение без групп скрывается целиком
|
|
variablePrefix |
String |
Префикс имен переменных на выходе |
Переменные на выходе (без префикса; с префиксом mango имя становится mangoExceptionType и так далее):
Переменная |
Значение |
|---|---|
exceptionType |
Имя класса исключения, либо |
maskedErrorMessage |
Сообщение исключения после маскировки, либо |
maskedStackTrace |
Стек вызовов после маскировки |
isHttpException |
Признак того, что в цепочке причин найден отказ http |
httpStatusCode |
Код ответа. Записывается только для отказа http |
responseBody |
Тело ответа после маскировки. Записывается только для отказа http |
Пример: ecos-camel-examples/masked-exception-describer.
Вход: исключение из свойства обмена Exchange.EXCEPTION_CAUGHT. Тело и заголовки сообщения не изменяются; собственных заголовков нет. Процессор вызывается в обработчике ошибок.
- beans:
- name: describeError
type: ru.citeck.ecos.camel.processor.MaskedExceptionDescriberProcessor
properties:
maskFields: "password,token,api_key"
maskPatterns: "/rest/([0-9]+)/"
variablePrefix: provider
Шаг в обработчике ошибок: process: {ref: describeError}. Полный пример доступен для скачивания.
BinaryBodyGuardProcessor
Класс: ru.citeck.ecos.camel.processor.BinaryBodyGuardProcessor
Проверяет, что полученное тело действительно является двоичным файлом, а не страницей ошибки в html или json, отданной с кодом 200. Результат записывается в переменные обмена, исключение не бросается — маршрут сам выбирает ветку по вердикту.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
maxSize |
Long |
0 |
Предел размера тела в байтах, 0 — без ограничения.
Если тело сообщает свой размер заранее (заголовок
Content-Length, длина StreamCache), превышение определяется до чтения тела в память |
rejectedContentTypes |
String |
text/,/json,+json,/xml,+xml,/html,+html |
Подстроки
Content-Type, при которых тело отклоняется, строкой через запятую.Пустая строка отключает проверку
|
rejectedFirstBytes |
String |
<,{ |
Символы, с которых не может начинаться двоичный файл, строкой через запятую. Ведущие пробелы и BOM пропускаются.
Пустая строка отключает проверку
|
variablePrefix |
String |
body |
Префикс имен переменных на выходе |
Переменные на выходе (при префиксе по умолчанию): bodyAccepted — признак того, что тело принято; bodyRejectReason — причина отказа, пустая строка при успехе; bodySize — размер тела, всегда Long.
Тело на выходе: тело, которое читается один раз (InputStream, Reader, StreamCache), заменяется прочитанными байтами, чтобы следующий шаг маршрута получил данные, а не опустошенный поток. Отклоненное тело тоже остается байтами, чтобы маршрут смог записать в журнал страницу ошибки.
Пример: ecos-camel-examples/binary-body-guard.
Заголовки на входе: Content-Type и Content-Length используются для проверки и не удаляются. На вход подается скачанное тело; при отказе маршрут должен обработать bodyAccepted: false.
- beans:
- name: guardFile
type: ru.citeck.ecos.camel.processor.BinaryBodyGuardProcessor
properties:
maxSize: 10485760
rejectedContentTypes: "text/,/json,+json,/xml,+xml,/html,+html"
rejectedFirstBytes: "<,{"
- route:
from:
uri: direct:guardFile
steps:
- process:
ref: guardFile
Полный пример с ветвлением: каталог примеров.
FormUrlEncodedBodyProcessor
Класс: ru.citeck.ecos.camel.processor.FormUrlEncodedBodyProcessor
Собирает тело application/x-www-form-urlencoded из именованных значений обмена в заданном порядке и выставляет соответствующий заголовок Content-Type.
Свойство |
Тип |
Значение по умолчанию |
Описание |
|---|---|---|---|
fields |
String |
Обязательно. Пары
<имя>=<ссылка> строкой через запятую, в порядке отправки.Ссылки:
const.<литерал>, header.<имя>, variable.<имя>, body.<поле>.Ссылки
secret.* запрещены — значение передается заголовком из {{ecos-secret:...}} |
Предупреждение
Свойство fields задается именно строкой. Вложенная карта привязывается плоскими ключами fields.<имя>, которые сортируются по имени, поэтому объявленный порядок полей молча теряется — а провайдер, подписывающий форму, ожидает документированный порядок.
Выход: тело заменяется строкой вида имя=значение&имя2=значение2 в кодировке UTF-8; заголовок Content-Type выставляется в application/x-www-form-urlencoded. Значения всех полей вычисляются до замены тела, поэтому несколько ссылок body.* читают исходное тело.
Пример: ecos-camel-examples/form-urlencoded-body.
Заголовки на входе: только выбранные ссылки header.*; они не удаляются. На выходе устанавливается Content-Type.
- beans:
- name: makeForm
type: ru.citeck.ecos.camel.processor.FormUrlEncodedBodyProcessor
properties:
fields: "request_id=header.RequestId,json=body.json,sign=body.sign"
- route:
from:
uri: direct:makeForm
steps:
- process:
ref: makeForm
Полный пример с подписью: каталог примеров.
FindOrCreateRecordProcessor
Класс: ru.citeck.ecos.camel.processor.data.FindOrCreateRecordProcessor
Ищет связанную запись по ключам и при необходимости создает ее. Позволяет сопоставлять справочники внешней системы с записями ECOS. Поиск и сохранение выполняются от имени системы.
Свойство |
Тип |
По умолчанию |
Описание |
|---|---|---|---|
sourceId |
String |
— |
Обязательно. Источник данных для поиска и создания записей |
keys |
String |
— |
Обязательно. Альтернативные ключи в порядке приоритета, разделенные |
onMiss |
ERROR | NULL | CREATE |
ERROR |
Если запись не найдена: ошибка, пустая ссылка либо создание записи. Регистр значения не важен |
stampAtts |
String |
пусто |
Пары |
createAtts |
String |
пусто |
Пары атрибутов для новой записи. Атрибуты ключей автоматически не добавляются: перечислите их здесь, если созданная запись должна находиться повторно |
targetAttribute |
String |
пусто |
Атрибут исходного объекта, куда записывается ссылка. Если не задан, процессор только обеспечивает наличие записи |
cacheMaxSize |
Int |
100000 |
Предел числа закешированных ключей. |
Вход и выход: формат данных для преобразований. Ссылки на значения: const.<литерал>, header.<имя>, variable.<имя>, body.<поле>. body.* читается из текущего элемента списка. Заголовки: специальных заголовков конфигурации нет; выбранные header.* читаются без удаления.
Ключи проверяются по очереди: первое однозначное совпадение завершает поиск. Два совпадения по одному ключу вызывают ошибку, даже если следующий ключ уникален. Ключ с пустым значением пропускается; если пусты все ключи, возвращается пустая ссылка независимо от onMiss. Нормализацию строк следует выполнить до этого шага.
Ошибки данных: RecordKeyResolutionException с причиной NOT_FOUND, AMBIGUOUS или STAMP_CONFLICT. Флаги мутации с префиксом __ передаются при сохранении, не сравниваются с атрибутами и сами по себе не вызывают сохранение.
Кеш хранится в экземпляре процессора до перезапуска контекста. Результаты транзакции попадают в него после фиксации; промахи не кешируются. Изменения записей вне этого процессора могут не отражаться в уже закешированных ключах; для таких сценариев используйте cacheMaxSize: 0. Блокировка записи действует внутри одного экземпляра процессора.
- beans:
- name: currencyTwin
type: ru.citeck.ecos.camel.processor.data.FindOrCreateRecordProcessor
properties:
sourceId: emodel/currency
keys: "externalRef=body.id;code=body.code"
onMiss: CREATE
stampAtts: "externalRef=body.id,__disableEvents=const.true"
createAtts: "id=body.code,code=body.code,name=body.name"
targetAttribute: currencyRef
- route:
from:
uri: direct:currencyTwin
steps:
- process:
ref: currencyTwin
Полный пример импорта справочника и связывания платежей: каталог примеров.