SOAP
Общее описание
Данный блок реализует обмен сообщениями по протоколу SOAP (Simple Object Access Protocol).
Блок SOAP может использоваться в качестве:
-
блока отправителя
-
блока получателя.
Настройка блока
В данном разделе описаны параметры блока SOAP, которые необходимо заполнить при настройке и примеры заполнения значений этих параметров.
Базовые параметры блока SOAP
| Название в UI | Название атрибута | Обязательный | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|---|
| Bean Id | Bean Id | Используется для поиска существующей настроенной конечной точки CxfEndpoint. Следует использовать bean: в качестве префикса. | Строка | ||
| Address | Address | Публичный адрес сервиса. В том случае, если блок SOAP является инициатором потока, префикс адреса заполняется автоматически и не может быть изменен. Префикс адреса формируется следующим образом: http://0.0.0.0:\{ESB_CORE_CXF_PORT\}\{ROUTES_API_PREFIX_CXF\} В скобках содержатся названия переменных, заполняемых во время настройки окружения. Вы можете дописать адрес сервера после предустановленного префикса, например: /ws/myWebservice | Строка | ||
| Data Format | Data Format | Типа данных сообщения. Возможные значения:
| POJO | Список | |
| Wrapped Style | Wrapped Style | Стиль WSDL, который описывает, как параметры представляются в теле SOAP. Если значение равно False, то будет выбран стиль «document/literal (unwrapped)», при котором весь контент тела SOAP определён в схеме. Если значение равно True, будет выбран стиль «document/literal (wrapped)», при котором запрос оборачивается в элемент, совпадающий с наименованием вызываемого метода, а ответ оборачивается в элемент, имя которого заканчивается на «Response». | False | Логическое значение | |
| Cookie Handler | Cookie Handler | Задает обработчик файлов cookie для HTTP-сессии. | Строка | ||
| Default Operation Name | Default Operation Name | Задает имя операции, которое блок CxfProducer будет использовать по умолчанию для вызова удаленного сервиса. Этот параметр предназначен для блока, когда тот добавлен в качестве отправителя. | Строка | ||
| Default Operation Namespace | Default Operation Namespace | Задает пространство имен, которое блок CxfProducer будет использовать по умолчанию для вызова удаленного сервиса. | Строка | ||
| Hostname Verifier | Hostname Verifier | Верификатор имени хоста. Используйте обозначение # для ссылки на верификатор имени хоста из реестра. | Строка | ||
| Ssl Context Parameters | Ssl Context Parameters | Ссылка на существующий контекст с SSL настройками. | Строка | ||
| Wrapped | Wrapped | Определяет тип операции, который будет запущен блоком. | False | Логическое значение | |
| Logging Feature Enabled | Logging Feature Enabled | Включает функцию ведения журнала CXF. | False | Логическое значение | |
| Logging Size Limit | Logging Size Limit | Задает максимальное количество байтов, которое логгер будет выводить при включенной функции ведения журнала. При отсутствии ограничений значение -1. | 49152 | Целочисленное значение. | |
| Skip Fault Logging | Skip Fault Logging | Определяет, будет ли встроенный класс-перехватчик пропускать регистрацию обнаруженной ошибки | False | Логическое значение | |
| Binding Id | Binding Id | Задает уникальный идентификатор связи для модели сервиса, предназначенной для использования. | Строка | ||
| Port Name | Port Name | Имя конечной точки, реализуемой сервисом, соответствует wsdl:portname. Вводится в формате ns:PORT_NAME, где ns - это префикс для namespace | Строка | ||
| Published Endpoint Url | Published Endpoint Url | Этот параметр может переопределять адрес конечной точки, указанной в WSDL для интеграции с внешними точками доступа. WSDL будет доступен через указанный адрес сервиса с суффиксом «?wsdl» | Строка | ||
| Service Class | Service Class | Имя класса SEI (Service Endpoint Interface), который может иметь аннотацию JSR181. | Строка | ||
| Service Name | Service Name | Имя сервиса, соответствует wsdl:servicename. | Строка | ||
| Wsdl URL | Wsdl URL | Местоположение файла WSDL. Может быть указано в пути к классу, в файловой системе или размещено удаленно. | Строка |
Расширенные параметры блока SOAP
| Название в UI | Название | Обязательный | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|---|
| Bridge Error Handler | Bridge Error Handler | Позволяет передавать возникшую ошибку из блока «наверх», т. е. на уровень потока, позволяя самостоятельно сконфигурировать собственные правила обработки ошибки через вспомогательные блоки. Примечание: это возможно только в том случае, если сторонний компонент позволяет системе получать оповещение о возникновении исключения. Некоторые компоненты обрабатывают это только внутренне, и поэтому применение Bridge Error Handler невозможно. По умолчанию блок будет использовать встроенный обработчик для обработки исключений, который залогирует возникшую ошибку и продолжит работу. | False | Логическое значение | |
| Exception Handler | Exception Handler | Задает пользовательский обработчик исключений. Примечание: По умолчанию обработке подлежат исключения, регистрируемые на уровне WARN и ERROR, которые затем игнорируются и не влияют на выполнение логики. | Строка | ||
| Lazy Start Producer | Lazy Start Producer | Определяет должен ли отправитель стартовать в отложенном режиме (при получении первого сообщения). Отложенный запуск можно использовать в ситуациях, когда запуск отправителя может завершиться неудачей и привести к сбою при запуске маршрута. Если отложить запуск, то сбой при запуске можно будет обработать во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации. Обратите внимание, что при обработке первого сообщения создание и старт отправителя могут занять некоторое время и увеличить общее время обработки. | False | Логическое значение | |
| Synchronous | Synchronous | Определяет, следует ли использовать только синхронную обработку. | False | Логическое значение | |
| Allow Streaming | Allow Streaming | Определяет, будет ли блок CXF при запуске в режиме PAYLOAD преобразовывать входящие сообщения в элементы DOM или сохранять полезную нагрузку | False | Логическое значение | |
| Bus | Bus | Задает шину CXF с пользовательской конфигурацией. | Строка | ||
| Continuation Timeout | Continuation Timeout | Задает таймаут CXF, который может использоваться по умолчанию, когда сервер CXF использует Jetty или сервлет в качестве транспорта | 30000 | Длинное целое число | |
| Cxf Binding | Cxf Binding | Задает пользовательскую связь (binding), для контроля взаимодействия между разными типами сообщениями внутреннего движка. | Строка | ||
| Cxf Configurer | Cxf Configurer | Позволяет настроить конечную точку CXF программным способом и указать имя пользовательского конфигуратора | Строка | ||
| Default Bus | Default Bus | Блок будет использовать дефолтную шину | False | Логическое значение | |
| Header Filter Strategy | Header Filter Strategy | Задает пользовательскую стратегию для фильтрации заголовка во входящих и исходящих сообщениях | Строка | ||
| Merge Protocol Headers | Merge Protocol Headers | Определяет следует ли объединять заголовки протоколов | False | Логическое значение | |
| Mtom Enabled | Mtom Enabled | Включает MTOM (вложения). Параметром можно пользоваться в режиме POJO или PAYLOAD. | False | Логическое значение | |
| Properties | Properties | Позволяет задать дополнительные параметры CXF, используя пары ключ/значение. Например, чтобы включить трассировку стека в SOAP faults, следует задать properties.faultStackTraceEnabled=true. | Строка | ||
| Schema Validation Enabled | Schema Validation Enabled | Включает валидацию схемы для запроса и ответа. Включенный параметр снижает производительность. | True | Логическое значение | |
| Skip Payload Message Part Check | Skip Payload Message Part Check | Определяет, следует ли отключать валидацию сообщений SOAP. | False | Логическое значение |
Параметры безопасности блока SOAP
| Название в UI | Название | Обязательный | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|---|
| Password | Password | Пароль клиента CXF. | Строка | ||
| Username | Username | Имя пользователя клиента CXF. | Строка |