HTTP Sender
Общее описание
HTTP Sender – это блок интеграционного потока, который позволяет отправлять запросы на указанный ресурс по HTTP.
Блок HTTP Sender может использоваться только в качестве:
- блока-отправителя.
Настройка блока
В данном разделе описаны параметры блока, которые необходимо заполнить при его настройке.
Базовые параметры
| Название в UI | Название атрибута | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|
| Dynamic Endpoint | dynamicEndpoint | Доступен только для блоков-отправителей. Параметр позволяет включить встроенную функциональность динамического определения вызываемоой конечной точки. При включении параметра структура блока меняется таким образом, что в коде вместо определения to проставляется toD, а значение самого вызываемого ресурса может собираться из переменной, например | False | Логическое значение |
| Pattern | pattern | Доступен только для блоков-отправителей. Устанавливает стиль взаимодействия с присоединенной частью потока. Возможные значения:
| Список | |
| Http Uri | httpUri | Обязательный параметр URL-адрес конечной точки HTTP для вызова | Строка | |
| Disable Stream Cache | disableStreamCache | Определяет, будут ли данные ответа кешироваться блоком в память. По умолчанию, кеширование включено, позволяя повторно обращаться к данным, если это необходимо. Если значение True, то кеширование будет отключено, снижая нагрузку на память и положительно влияя на скорость обработки данных, но позволяя считать ответ только один раз | False | Логическое значение |
| Bridge Endpoint | bridgeEndpoint | Если параметр установлен в значение True, блок будет использовать ровно URI, который указан в параметре Http Uri, игнорируя технические заголовки. Вы также можете установить для параметра throwExceptionOnFailure значение False, чтобы блок отправлял все ответы об ошибках | True | Логическое значение |
| Connection Close | connectionClose | Указывает, нужно ли добавлять заголовок Connection Close в HTTP-запрос | False | Логическое значение |
| Http Method | httpMethod | Используемый метод HTTP. Заголовок HttpMethod не может переопределить этот параметр, если он задан. Если метод не задан в UI или через заголовок, то автоматически подставляется значение метода POST. Возможные значения:
| POST | Список |
| Skip Request Headers | skipRequestHeaders | Определяет следует ли пропускать сопоставление всех заголовков внутреннего движка с заголовками HTTP-запросов. Если в HTTP-запросе не нужно указывать данные из заголовков внутреннего движка, это позволит избежать накладных расходов на синтаксический анализ и выделение большого количества объектов для сборщика мусора JVM | False | Логическое значение |
| Skip Response Headers | skipResponseHeaders | Определяет следует ли пропускать сопоставление всех заголовков HTTP-ответа с заголовками внутреннего движка. Если данные из HTTP-заголовков не нужны, это позволит избежать затрат ресурсов на синтаксический анализ и выделение большого количества объектов для сборщика мусора JVM | False | Логическое значение |
| Throw Exception On Failure | throwExceptionOnFailure | Возможность отключить генерацию ошибки HttpOperationFailedException в случае получения неверных ответов от удаленного сервера. Это позволяет получать все ответы независимо от кода состояния HTTP | True | Логическое значение |
| Proxy Auth Domain | proxyAuthDomain | Домен для использования прокси-аутентификации с использованием NTML | Строка | |
| Proxy Auth Host | proxyAuthHost | Узел аутентификации через прокси-сервер | Строка | |
| Proxy Auth Method | proxyAuthMethod | Какой метод аутентификации прокси использовать (NTLM не рекомендуется). Возможные значения:
| Список | |
| Proxy Auth Nt Host | proxyAuthNtHost | Домен прокси-аутентификации (имя рабочей станции) для использования с NTML. | Строка | |
| Proxy Auth Password | proxyAuthPassword | Пароль для аутентификации через прокси-сервер. | Строка | |
| Proxy Auth Port | proxyAuthPort | Порт аутентификации прокси-сервера. | Целое число | |
| Proxy Auth Scheme | proxyAuthScheme | Схема протокола аутентификации прокси-сервера. Возможные значения:
| Список | |
| Proxy Auth Username | proxyAuthUsername | Имя пользователя для аутентификации через прокси. | Строка | |
| Proxy Host | proxyHost | Имя хоста прокси-сервера для использования. | Строка | |
| Proxy Port | proxyPort | Используемый прокси-порт | Целое число |
Расширенные параметры
| Название в UI | Название атрибута | Описание | По умолчанию | Тип |
|---|---|---|---|---|
| Header Filter Strategy | рeaderFilterStrategy | Определяет пользовательскую стратегию для фильтрации заголовков в сообщениях | Строка | |
| Clear Expired Cookies | сlearExpiredCookies | Определяет следует ли удалять файлы cookie с истекшим сроком действия перед отправкой HTTP-запроса. Это гарантирует, что хранилище файлов cookie не будет увеличиваться за счет добавления новых файлов cookie, которые удаляются по истечении срока их действия. Если в компоненте отключено управление файлами cookie, эта опция также будет отключена | True | Логическое значение |
| Cookie Handler | сookieHandler | Обработчик файлов cookie для поддержания HTTP-сессии | Строка | |
| Cookie Store | сookieStore | Пользовательский CookieStore. По умолчанию используется BasicCookieStore, который хранит файлы cookie только в памяти. Обратите внимание: если bridgeEndpoint = True, то хранилище файлов cookie принудительно становится хранилищем без возможности оперировать данными (no-operable), так как файлы cookie не должны сохраняться, поскольку мы просто обеспечиваем связь (например, действуем как прокси). Если задан cookieHandler, то хранилище файлов cookie также принудительно становится хранилищем хранилищем без возможности оперировать данными (no-operable), так как обработка файлов cookie выполняется cookieHandler | Список | |
| Copy Headers | сopyHeaders | Если этот параметр установлен в значение True, то заголовки обмена IN будут скопированы в заголовки обмена OUT в соответствии со стратегией копирования. Если установить значение False, то будут включены только заголовки из HTTP-ответа (без распространения заголовков обмена IN) | True | Логическое значение |
| Custom Host Header | сustomHostHeader | Пользовательский заголовок хоста для отправителя. Если не указано в запросе, будет проигнорировано. Если указано, переопределит заголовок хоста, полученный из URL. | Строка | |
| Delete With Body | deleteWithBody | Определяет должен ли HTTP метод DELETE включать тело сообщения или нет. По умолчанию HTTP метод DELETE не включает тело HTTP. Однако в некоторых редких случаях пользователям может потребоваться возможность включать тело сообщения | False | Логическое значение |
| Follow Redirects | аollowRedirects | Определяет должен ли HTTP-запрос следовать перенаправлениям. По умолчанию HTTP-запрос не следует перенаправлениям | False | Логическое значение |
| Get With Body | пetWithBody | Определяет должен ли HTTP метод GET включать тело сообщения или нет. По умолчанию HTTP метод GET не включает тело HTTP. Однако в редких случаях пользователям может потребоваться возможность включать тело сообщения | False | Логическое значение |
| Ignore Response Body | ignoreResponseBody | Если этот параметр установлен, http-прокси не будет считывать тело ответа и кэшировать входной поток | False | Логическое значение |
| Lazy Start Producer | lazyStartProducer | Определяет должен ли отправитель стартовать в отложенном режиме, т.е. при получении первого сообщения. Для выявления ошибок и отладки при активации потока, выставьте значение в False. Если поток используется редко или необходима его быстрая активация, то выставьте значение в True. Учтите, что обработка первого сообщения в этом случае будет замедлена. | False | Логическое значение |
| Ok Status Code Range | okStatusCodeRange | Коды состояния, которые считаются успешным ответом. Значения указываются диапазоном включительно. Можно указать несколько диапазонов, разделив их запятыми, например 200-204, 209, 301-304. Каждый диапазон должен состоять из одного числа или из диапазона от до, указанного через дефис | 200-299 | Строка |
| Preserve Host Header | preserveHostHeader | Если параметр установлен в значение True, блок HttpProducer установит обрабатываемое значение хоста в заголовок Host. Это полезно в приложениях с обратным прокси-сервером, где нужно, чтобы заголовок Host, получаемый нижестоящим сервером, отражал URL-адрес, по которому обращается вышестоящий клиент. Это позволяет приложениям, использующим заголовок Host, генерировать точные URL-адреса для проксируемого сервиса | False | Логическое значение |
| User Agent | userAgent | Пользовательское название HTTP заголовка для User-Agent | Строка | |
| Client Builder | clientBuilder | Позволяет указать готовый экземпляр HTTP клиента, который содержит все необходимые параметры | Строка | |
| Client Connection Manager | clientConnectionManager | Пользовательский HttpClientConnectionManager для управления подключениями | Строка | |
| Connections Per Route | connectionsPerRoute | Максимальное количество подключений на маршруте | 20 | Целое число |
| Http Client | httpClient | Пользовательский HttpClient для использования отправителем | Строка | |
| Http Client Configurer | httpClientConfigurer | Позволяет указать пользовательский конфигуратор для HTTP клиента | Строка | |
| Http Client Options | httpClientOptions | Настройка HttpClient с помощью ключей и значений из ассоциативного массива (Map) | Строка | |
| Http Connection Options | httpConnectionOptions | Настройка соединения и сокета с помощью ключей и значений из ассоциативного массива (Map) | Строка | |
| Http Context | httpContext | Пользовательский экземпляр HttpContext | Строка | |
| Max Total Connections | maxTotalConnections | Максимальное количество подключений | 200 | Целое число |
| Use System Properties | useSystemProperties | Определяет будут ли использоваться системные свойства в качестве резервной конфигурации для настройки HTTP-клиента | False | Логическое значение |