SOAP

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

Данный блок реализует обмен сообщениями по протоколу SOAP (Simple Object Access Protocol).

Блок SOAP может использоваться в качестве:

• блока-отправителя

• блока-получателя.

Настройка блока

В данном разделе описаны параметры блока SOAP, которые необходимо заполнить при его настройке.

Базовые параметры

Название в UI	Название атрибута	Описание	Значение по умолчанию	Тип данных
Загрузить схему или темплейт		В данном поле вы можете выбрать или загрузить схему или шаблон, выбрав его из списка загруженных файлов или в файловом навигаторе.		Файл
Dynamic Endpoint	dynamicEndpoint	Доступен только для блоков-отправителей Параметр позволяет включить встроенную функциональность динамического определения вызываемой конечной точки. При включении параметра структура блока меняется таким образом, что в коде вместо определения to проставляется toD, а значение самого вызываемого ресурса может собираться из переменной, например ${header.foo}.	False	Логическое значение
Connection	connection	Этот параметр позволяет выбрать предсозданное подключение к БД или создать новое с помощью визарда Connection Manager.		Список
Pattern	pattern	Доступен только для блоков-отправителей Устанавливает стиль взаимодействия с присоединенной частью потока. Возможные значения: InOnly – отправить без подтверждения приемки. При выборе в отправленном yaml и в режиме просмотра кода будет виден параметр pattern на том же уровне, что и uri. InОut – ждать подтверждения после отправки.		Список
Disabled	disabled	Доступен только для блоков-отправителей Определяет будет ли блок отключен в потоке. В активированном потоке функциональность блока не будет отрабатываться.	False	Логическое значение
Description	description	Краткое описание блока		Строка
Address	address	Публичный адрес сервиса. В том случае, если блок SOAP является получателем, префикс адреса заполняется автоматически и не может быть изменен. Префикс адреса формируется следующим образом: https://0.0.0.0:{ESB_CORE_CXF_TRIGGER_PORT}{ROUTES_API_PREFIX_CXF} В скобках содержатся названия переменных, заполняемых во время настройки окружения. Возможные значения: 0.0.0.0 – прослушивание всех сетевых интерфейсов {ESB_CORE_CXF_TRIGGER_PORT} – порт CXF‑компонента {ROUTES_API_PREFIX_CXF} – префикс URL Вы можете дописать адрес сервера после предустановленного префикса, например: <em>/ws/myWebservice</em>		Строка
Data Format	dataFormat	Типы данных сообщения. Возможные значения: POJO PAYLOAD RAW CXF-MESSAGE	POJO	Список
Wrapped Style	wrappedStyle	Стиль WSDL, который описывает, как параметры представляются в теле SOAP. Если значение равно False, то будет выбран стиль «document/literal (unwrapped)», при котором весь контент тела SOAP определён в схеме. Если значение равно True, будет выбран стиль «document/literal (wrapped)», при котором запрос оборачивается в элемент, совпадающий с наименованием вызываемого метода, а ответ оборачивается в элемент, имя которого заканчивается на «Response».	False	Логическое значение
Cookie Handler	cookieHandler	Задает обработчик файлов cookie для HTTP-сессии.		Строка
Default Operation Name	defaultOperationName	Доступен только для блоков-отправителей Задает имя операции, которое блок CxfProducer будет использовать по умолчанию для вызова удаленного сервиса.		Строка
Default Operation Namespace	defaultOperationNamespace	Доступен только для блоков-отправителей Задает пространство имен, которое блок CxfProducer будет использовать по умолчанию для вызова удаленного сервиса.		Строка
Hostname Verifier	hostnameVerifier	Доступен только для блоков-отправителей Верификатор имени хоста. Используйте обозначение # для ссылки на верификатор имени хоста из реестра.		Строка
Ssl Context Parameters	sslContextParameters	Доступен только для блоков-отправителей Ссылка на существующий контекст с SSL настройками.		Строка
Wrapped	wrapped	Доступен только для блоков-отправителей Определяет тип операции, который будет запущен блоком.	False	Логическое значение
Logging Feature Enabled	loggingFeature	Включает функцию ведения журнала CXF.	False	Логическое значение
Logging Size Limit	loggingSizeLimit	Задает максимальное количество байтов, которое логгер будет выводить при включенной функции ведения журнала. При отсутствии ограничений значение -1.	49152	Целочисленное значение.
Skip Fault Logging	skipFaultLogging	Определяет, будет ли встроенный класс-перехватчик пропускать регистрацию обнаруженной ошибки	False	Логическое значение
Binding Id	bindingId	Задает уникальный идентификатор связи для модели сервиса, предназначенной для использования.		Строка
Port Name	portName	Имя конечной точки, реализуемой сервисом, соответствует wsdl:portname. Вводится в формате ns:PORT_NAME, где ns - это префикс для namespace		Строка
Published Endpoint Url	publishedEndpointUrl	Этот параметр может переопределять адрес конечной точки, указанной в WSDL для интеграции с внешними точками доступа. WSDL будет доступен через указанный адрес сервиса с суффиксом «?wsdl»		Строка
Service Class	serviceClass	Имя класса SEI (Service Endpoint Interface), который может иметь аннотацию JSR181.		Строка
Service Name	serviceName	Имя сервиса, соответствует wsdl:servicename.		Строка

Расширенные параметры

Название в UI	Название атрибута	Описание	Значение по умолчанию	Тип данных
Bridge Error Handler	bridgeErrorHandler	Доступен только для блоков-получателей Позволяет передавать возникшую ошибку из блока «наверх», т. е. на уровень потока, позволяя самостоятельно сконфигурировать собственные правила обработки ошибки через вспомогательные блоки. Примечание: Это возможно только в том случае, если сторонний компонент позволяет системе получать оповещение о возникновении исключения. Некоторые компоненты обрабатывают это только внутренне, и поэтому применение Bridge Error Handler невозможно. По умолчанию блок будет использовать встроенный обработчик для обработки исключений, который залогирует возникшую ошибку и продолжит работу.	False	Логическое значение
Exception Handler	exceptionHandler	Доступен только для блоков-получателей Задает пользовательский обработчик исключений. Примечание: По умолчанию обработке подлежат исключения, регистрируемые на уровне WARN и ERROR, которые затем игнорируются и не влияют на выполнение логики.		Строка
Exchange Pattern	exchangePattern	Доступен только для блоков-получателей Устанавливает шаблон обмена во время начала обработки сообщения блоком-инициатором. Возможные значения: InOnly InOut		Список
Lazy Start Producer	lazyStartProducer	Определяет должен ли отправитель стартовать в отложенном режиме (при получении первого сообщения). Отложенный запуск можно использовать в ситуациях, когда запуск отправителя может завершиться неудачей и привести к сбою при запуске маршрута. Если отложить запуск, то сбой при запуске можно будет обработать во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации. Обратите внимание, что при обработке первого сообщения создание и старт отправителя могут занять некоторое время и увеличить общее время обработки.	False	Логическое значение
Synchronous	synchronous	Определяет, следует ли использовать только синхронную обработку.	False	Логическое значение
Allow Streaming	allowStreaming	Определяет, будет ли блок CXF при запуске в режиме PAYLOAD преобразовывать входящие сообщения в элементы DOM или сохранять полезную нагрузку	False	Логическое значение
Bus	bus	Задает шину CXF с пользовательской конфигурацией.		Строка
Continuation Timeout	continuationTimeout	Задает таймаут CXF, который может использоваться по умолчанию, когда сервер CXF использует Jetty или сервлет в качестве транспорта	30000	Длинное целое число
Cxf Binding	cxfBinding	Задает пользовательскую связь (binding), для контроля взаимодействия между разными типами сообщениями внутреннего движка.		Строка
Cxf Configurer	cxfConfigurer	Позволяет настроить конечную точку CXF программным способом и указать имя пользовательского конфигуратора		Строка
Default Bus	defaultBus	Блок будет использовать дефолтную шину	False	Логическое значение
Header Filter Strategy	headerFilterStrategy	Задает пользовательскую стратегию для фильтрации заголовка во входящих и исходящих сообщениях		Строка
Merge Protocol Headers	mergeProtocolHeaders	Определяет следует ли объединять заголовки протоколов	False	Логическое значение
Mtom Enabled	mtomEnabled	Включает MTOM (вложения). Параметром можно пользоваться в режиме POJO или PAYLOAD.	False	Логическое значение
Properties	properties	Позволяет задать дополнительные параметры CXF, используя пары ключ/значение. Например, чтобы включить трассировку стека в SOAP faults, следует задать properties.faultStackTraceEnabled=true.		Строка
Schema Validation Enabled	schemaValidationEnabled	Включает валидацию схемы для запроса и ответа. Включенный параметр снижает производительность.	True	Логическое значение
Skip Payload Message Part Check	skipPayloadMessagePartCheck	Определяет, следует ли отключать валидацию сообщений SOAP.	False	Логическое значение

Параметры безопасности

Название в UI	Название атрибута	Описание	Значение по умолчанию	Тип данных
Password Id	password	Пароль клиента.		Строка
Username	username	Имя пользователя клиента.		Строка