SOAP
Общее описание
Данный блок реализует обмен сообщениями по протоколу SOAP (Simple Object Access Protocol).
Блок SOAP может использоваться в качестве:
-
блока отправителя
-
блока получателя.
Настройка блока
В данном разделе описаны параметры блока SOAP, которые необходимо заполнить при егг настройке.
Базовые параметры
| Название в UI | Название атрибута | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|
| Dynamic Endpoint | dynamicEndpoint | Доступен только для блоков-отправителей. Параметр позволяет включить встроенную функциональность динамического определения вызываемоой конечной точки. При включении параметра структура блока меняется таким образом, что в коде вместо определения to проставляется toD, а значение самого вызываемого ресурса может собираться из переменной, например | False | Логическое значение |
| Pattern | pattern | Доступен только для блоков-отправителей. Устанавливает стиль взаимодействия с присоединенной частью потока. Возможные значения:
| Список | |
| Bean Id | beanId | Используется для поиска существующей настроенной конечной точки CxfEndpoint. Следует использовать bean: в качестве префикса. | Строка | |
| Address | address | Публичный адрес сервиса. В том случае, если блок SOAP является инициатором потока, префикс адреса заполняется автоматически и не может быть изменен. Префикс адреса формируется следующим образом:
В скобках содержатся названия переменных, заполняемых во время настройки окружения. Вы можете дописать адрес сервера после предустановленного префикса, например: /ws/myWebservice | Строка | |
| Data Format | dataFormat | Типы данных сообщения. Возможные значения:
| 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. | Строка | |
| Wsdl URL | wsdlURL | Местоположение файла WSDL. Может быть указано в пути к классу, в файловой системе или размещено удаленно. | Строка |
Расширенные параметры
| Название в UI | Название атрибута | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|
| Bridge Error Handler | bridgeErrorHandler | Позволяет передавать возникшую ошибку из блока «наверх», т. е. на уровень потока, позволяя самостоятельно сконфигурировать собственные правила обработки ошибки через вспомогательные блоки. Примечание: это возможно только в том случае, если сторонний компонент позволяет системе получать оповещение о возникновении исключения. Некоторые компоненты обрабатывают это только внутренне, и поэтому применение Bridge Error Handler невозможно. По умолчанию блок будет использовать встроенный обработчик для обработки исключений, который залогирует возникшую ошибку и продолжит работу. | False | Логическое значение |
| Exception Handler | exceptionHandler | Задает пользовательский обработчик исключений. Примечание: По умолчанию обработке подлежат исключения, регистрируемые на уровне WARN и ERROR, которые затем игнорируются и не влияют на выполнение логики. | Строка | |
| 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 | Имя пользователя клиента. | Строка |