FTP
Общее описание
Блок FTP отвечает за передачу файлов с FTP/SFTP-серверами. Может загружать файлы на сервер или скачивать их, поддерживает рекурсивную работу с папками, фильтрацию по именам файлов и различные режимы подключения.
Блок FTP может использоваться в качестве:
-
блока-отправителя
-
блока-получателя.
Настройка блока
В данном разделе описаны параметры блока FTP, которые необходимо заполнить при его настройке.
Базовые параметры
| Название в UI | Название атрибута | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|
| Dynamic Endpoint | dynamicEndpoint | Доступен только для блоков-отправителей Позволяет включить встроенную функциональность динамического определения вызываемой конечной точки. При включении структура блока меняется: вместо to используется toD, а значение вызываемого ресурса может собираться из переменной (например, ${header.foo}). | False | Логическое значение |
| Host | host | Обязательный параметр Имя хоста FTP‑сервера. | Строка | |
| Connection | connection | Позволяет выбрать предсозданное подключение к серверу или создать новое с помощью визарда Connection Manager. | Список | |
| Description | description | Краткое описание блока. | Строка | |
| Port | port | Порт FTP‑сервера. | Целое число | |
| Directory Name | directoryName | Начальный каталог. | Строка | |
| Binary | binary | Указывает режим передачи файлов: BINARY или ASCII. По умолчанию используется ASCII. | False | Логическое значение |
| Charset | charset | Задает кодировку файла. Возможные значения:
Заданная кодировка может снизить производительность при конвертации больших сообщений. Если блок используется в качестве отправителя | Строка | |
| Disconnect | disconnect | Определяет, следует ли отключаться от удаленного FTP‑сервера сразу после использования. Отключение затрагивает только текущее подключение. Примечание: Для остановки потока нужно останавливать сам поток, а не использовать эту опцию. | False | Логическое значение |
| Done File Name | doneFileName | Для отправителя: после передачи оригинального файла создается пустой файл с указанным именем. Для получателя: обработка файлов начинается только после появления файла с указанным именем в директории. Поддерживается статическое и динамическое имя (синтаксис: ${file.name} и ${file.name.next} ). | Строка | |
| File Name | fileName | Задает выражение на языке File Language для динамического определения имени файла. Для блока‑получателя используется как фильтр имени файла. Имеет приоритет над системным заголовком CamelFileName. | Строка | |
| Passive Mode | passiveMode | Устанавливает пассивный режим соединения. | False | Логическое значение |
| Separator | separator | Задает разделитель пути к файлу в соответствии с ОС. Возможные значения:
| UNIX | Список |
| Transfer Logging Interval Seconds | transferLoggingIntervalSeconds | Настраивает интервал (в секундах) для логирования прогресса выполняемых операций загрузки и выгрузки. Используется для отслеживания прогресса, если операции занимают продолжительное время. | 5 | Целое число |
| Transfer Logging Level | transferLoggingLevel | Настраивает уровень логирования для записи прогресса операций загрузки и выгрузки. Возможные значения:
| DEBUG | Логическое значение |
| Transfer Logging Verbose | transferLoggingVerbose | Настраивает режим подробного (детального) логирования прогресса операций загрузки и выгрузки. | False | Логическое значение |
| Delete | delete | Доступен только для блоков-получателей Определяет, должен ли файл удаляться после успешной обработки. При значении true файл будет удален из системы сразу после того, как коннектор завершит его обработку без ошибок. | False | Логическое значение |
| Move Failed | moveFailed | Доступен только для блоков-получателей Определяет действие с сообщением при возникновении ошибки обработки. Указывает, в какую очередь или папку следует переместить сообщение, если его обработка завершилась сбоем. Позволяет организовать отдельную обработку проблемных сообщений. | Строка | |
| Noop | noop | Доступен только для блоков-получателей Режим обработки, при котором входящие сообщения игнорируются без выполнения каких‑либо действий и без генерации ошибок. | False | Логическое значение |
| Pre Move | preMove | Доступен только для блоков-получателей Действие или набор действий, выполняемых перед перемещением сообщения. | Строка | |
| Pre Sort | preSort | Доступен только для блоков-получателей Определяет правила сортировки сообщений перед их основной обработкой. Может учитывать временные метки, приоритеты, идентификаторы или другие атрибуты сообщений. | Строка | |
| Recursive | recursive | Доступен только для блоков-получателей Включает рекурсивную обработку вложенных структур данных. При активации компонент обрабатывает все уровни вложенности; при отключении — только верхний уровень. | False | Логическое значение |
| Resume Download | resumeDownload | Доступен только для блоков-получателей Определяет, следует ли возобновить загрузку данных с последней сохраненной точки (чекпоинта) при перезапуске коннектора. При включении (true) коннектор пытается продолжить чтение журналов изменений Oracle с позиции, на которой остановился до сбоя или остановки. | False | Логическое значение |
| Send Empty Message When Idle | sendEmptyMessageWhenIdle | Доступен только для блоков-получателей Определяет, следует ли отправлять служебное (пустое) сообщение, если в течение заданного времени не поступило новых данных. | False | Логическое значение |
| Stream Download | streamDownload | Доступен только для блоков-получателей Включает режим потоковой загрузки данных, при котором сообщения передаются и обрабатываются частями, а не целиком. | False | Логическое значение |
| Checksum File Algorithm | checksumFileAlgorithm | Доступен только для блоков-отправителей Если указано, алгоритм рассчитает контрольную сумму для записанного файла и сохранит результат в заголовке CamelFileChecksum. Возможные значения:
| Строка | |
| File Exist | fileExist | Доступен только для блоков-отправителей Определяет действие, если файл с таким же именем уже существует. Возможные значения:
| Override | Список |
| Flatten | flatten | Доступен только для блоков-отправителей Используется для «выравнивания» пути к файлу — удаления любых ведущих путей, чтобы осталось только имя файла. Это позволяет рекурсивно считывать файлы из подкаталогов, но при записи в другой каталог все файлы будут помещены в одну директорию. Если установить значение True на стороне продюсера, это гарантирует, что любое имя файла в заголовке CamelFileName будет очищено от ведущих путей. | False | Логическое значение |
| Jail Starting Directory | jailStartingDirectory | Доступен только для блоков-отправителей Используется для ограничения записи файлов только стартовой директорией и ее поддиректориями (режим «изоляции»). По умолчанию включен — это не позволяет записывать файлы в каталоги за пределами стартовой директории. Можно отключить, чтобы разрешить запись файлов в каталоги за пределами стартовой директории — например, в родительские или корневые папки. | True | Логическое значение |
| Move Existing | moveExisting | Доступен только для блоков-отправителей Параметр для вычисления имени файла при настройке fileExist=Move. Он позволяет динамически определять имя файла для перемещения, если уже существует файл с таким же именем. Чтобы переместить файлы в поддиректорию для резервного копирования, достаточно указать backup. Опция поддерживает следующие токены языка File Language. Возможные значения:
| Строка | |
| Temp File Name | tempFileName | Доступен только для блоков-отправителей Задает имя временного файла при записи данных. Выполняет ту же функцию, что и tempPrefix, но предоставляет более детальный контроль над именованием временных файлов благодаря использованию языка файлов (File Language). | Строка | |
| Temp Prefix | tempPrefix | Доступен только для блоков-отправителей Задает префикс для имени временного файла при записи данных. Простейший способ отметить файл как временный: система добавляет указанный префикс к оригинальному имени файла. В отличие от tempFileName не поддерживает сложные шаблоны на основе File Language — только статический текст в начале имени файла. | Строка | |
| Ant Exclude | antExclude | Доступен только для блоков-получателей Исключает данные с помощью Ant‑фильтра. При одновременном использовании antInclude и antExclude приоритет имеет antExclude. Можно указать несколько значений через запятую. | Строка | |
| Ant Filter Case Sensitive | antFilterCaseSensitive | Доступен только для блоков-получателей Если True, Ant‑фильтр чувствителен к регистру. | True | Логическое значение |
| Ant Include | antInclude | Доступен только для блоков-получателей Вставляет данные с помощью Ant‑фильтра. Множественные значения перечисляются через запятую. | Строка | |
| Eager Max Messages Per Poll | eagerMaxMessagesPerPoll | Доступен только для блоков-получателей Контролирует активность ограничения maxMessagesPerPoll. Возможные значения:
Сортировка требует больше памяти, так как все данные о файлах хранятся в памяти. | True | Логическое значение |
| Exclude | exclude | Доступен только для блоков-получателей Исключает файлы, если имя соответствует шаблону регулярных выражений (с учетом регистра). | Строка | |
| Exclude Ext | excludeExt | Доступен только для блоков-получателей Исключает файлы с указанным расширением (без учета регистра). Можно перечислить несколько расширений через запятую. Примечание: Расширение включает все части (например, для mydata.tar.gz расширение — tar.gz ). | Строка | |
| Filter | filter | Доступен только для блоков-получателей Подключаемый фильтр ( org.apache.camel.component.file.GenericFileFilter ). Пропускает файлы, если метод accept() возвращает False. | Строка | |
| Filter Directory | filterDirectory | Доступен только для блоков-получателей Фильтрует каталог на основе выражений языка Simple (например, по текущей дате: ${date:now:yyyyMMdd} ). | Строка | |
| Filter File | filterFile | Доступен только для блоков-получателей Фильтрует файлы на основе выражений языка Simple (например, по размеру: ${file:size} > 5000 ). | Строка | |
| Idempotent | idempotent | Доступен только для блоков-получателей Включает функциональность соблюдения идемпотентности для пропуска уже обработанных файлов. По умолчанию используется LRUCache на 1000 записей. Если значение параметра "Noop"=True, то считается, что настройки идемпотентности начинают соблюдаться вне зависимости от выставленного значения в параметре "Idempotent". | False | Логическое значение |
| Idempotent Eager | idempotentEager | Доступен только для блоков-получателей Определяет, добавлять ли имя файла в идемпотентный репозиторий сразу или после завершения обработки. | False | Логическое значение |
| Idempotent Key | idempotentKey | Доступен только для блоков-получателей Задает пользовательский идемпотентный ключ. По умолчанию — абсолютный путь к файлу. Можно использовать язык File Language (например, idempotentKey=${file:name}-${file:size} ). | Строка | |
| Idempotent Repository | idempotentRepository | Доступен только для блоков-получателей Подключаемый репозиторий ( org.apache.camel.spi.IdempotentRepository). Возможные значения:
| Строка | |
| Include | include | Доступен только для блоков-получателей Включает в обработку файлы, если имя соответствует шаблону регулярных выражений (с учетом регистра). | Строка | |
| Include Ext | includeExt | Доступен только для блоков-получателей Включает файлы с указанным расширением (без учета регистра). Примечание: Расширение включает все части (например, для mydata.tar.gz — tar.gz ). | Строка | |
| Max Depth | maxDepth | Доступен только для блоков-получателей Максимальная глубина вложенности при рекурсивной обработке каталога. | 2147483647 | Целое число |
| Max Messages Per Poll | maxMessagesPerPoll | Доступен только для блоков-получателей Максимальное количество сообщений для обработки за один опрос. Значение 0 или отрицательное отключает ограничение. | Целое число | |
| Min Depth | minDepth | Доступен только для блоков-получателей Минимальная глубина начала обработки при рекурсивной обработке. Возможные значения:
| Целое число | |
| Move | move | Выражение (например, на Simple Language) для динамического формирования имени файла при перемещении после обработки. | Строка | |
| Exclusive Read Lock Strategy | exclusiveReadLockStrategy | Подключаемая блокировка чтения (org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy). | Строка | |
| Read Lock | readLock | Доступен только для блоков-получателей Получатель обрабатывает файлы только при наличии исключительной блокировки на чтение. Возможные значения:
| none | Строка |
| Read Lock Check Interval | readLockCheckInterval | Доступен только для блоков-получателей Интервал в миллисекундах для блокировки чтения (если она поддерживается). Используется для ожидания между попытками получения блокировки чтения. | 1000 | Целое число |
| Read Lock Delete Orphan Lock Files | readLockDeleteOrphanLockFiles | Доступен только для блоков-получателей Применяется, когда Read Lock имеет значение markerFile. Определяет, нужно ли при запуске удалять оставшиеся файлы блокировки чтения (файлы‑маркеры), которые могли остаться в файловой системе после нештатного завершения работы (например, из‑за сбоя JVM). | True | Логическое значение |
| Read Lock Logging Level | readLockLoggingLevel | Доступен только для блоков-получателей Уровень логирования в случаях, когда не удалось получить блокировку на чтение. Возможные значения:
| DEBUG | Список |
| Read Lock Marker File | readLockMarkerFile | Доступен только для блоков-получателей Определяет, следует ли использовать файл‑маркер с типами блокировки changed, rename или exclusive. По умолчанию файл‑маркер также защищает от получения тех же файлов другими процессами. | True | Логическое значение |
| Read Lock Min Age | readLockMinAge | Доступен только для блоков-получателей Применяется только при Read Lock = changed. Позволяет указать минимальный возраст файла перед попыткой получения блокировки на чтение (в секундах). Например, readLockMinAge=300 означает, что файл должен существовать минимум 5 минут. | 0 | Целое число |
| Read Lock Min Length | readLockMinLength | Доступен только для блоков-получателей Применяется только при Read Lock = changed. Позволяет настроить минимальную длину файла (в байтах). | 1 | Целое число |
| Read Lock Remove On Commit | readLockRemoveOnCommit | Доступен только для блоков-получателей Применяется только при Read Lock = idempotent. Указывает, следует ли удалять запись имени файла из идемпотентного репозитория, если обработка завершилась успешно и изменения сохранены. | False | Логическое значение |
| Read Lock Remove On Rollback | readLockRemoveOnRollback | Доступен только для блоков-получателей Применяется только при Read Lock = idempotent. Указывает, следует ли удалять запись имени файла из идемпотентного репозитория, если обработка завершилась неудачно и произошел откат. | True | Логическое значение |
| Read Lock Timeout | readLockTimeout | Доступен только для блоков-получателей Опциональный тайм‑аут в миллисекундах для блокировки чтения (если поддерживается). Если блокировка не предоставлена и тайм‑аут истек, файл пропускается. При следующем запросе попытка обработки повторяется. Значение 0 или меньше означает «всегда ждать». | 10000 | Целое число |
| Backoff Error Threshold | backoffErrorThreshold | Доступен только для блоков-получателей Количество последовательно полученных ошибок обработки, после которого планировщик переходит в режим пропуска запусков. | Целое число | |
| Backoff Idle Threshold | backoffIdleThreshold | Доступен только для блоков-получателей Количество последовательных запросов, не приведших к созданию или обработке данных. | Целое число | |
| Backoff Multiplier | backoffMultiplier | Доступен только для блоков-получателей Количество пропусков срабатываний планировщика после достижения порогов Backoff Error Threshold или Backoff Idle Threshold. Применяется, если эти параметры заданы. | Целое число | |
| Delay | delay | Доступен только для блоков-получателей Промежуток времени в миллисекундах до следующего запроса. | 500 | Целое число |
| Greedy | greedy | Доступен только для блоков-получателей Если True, после срабатывания ScheduledPollConsumer (при создании/обработке данных) он запускается еще раз сразу. | False | Логическое значение |
| Initial Delay | initialDelay | Доступен только для блоков-получателей Промежуток времени в миллисекундах до первого запроса. | 1 000 | Целое число |
| Repeat Count | repeatCount | Доступен только для блоков-получателей Максимальное количество срабатываний планировщика. Значение 0 или отрицательное означает бесконечное выполнение без ограничений. | 0 | Целое число |
| Run Logging Level | runLoggingLevel | Доступен только для блоков-получателей Уровень логирования старта и финиша инициации потока. Возможные значения:
| TRACE | Список |
| Scheduled Executor Service | scheduledExecutorService | Доступен только для блоков-получателей Позволяет настроить пользовательский/общий пул потоков для получателя. По умолчанию у каждого получателя свой однопоточный пул. | Строка | |
| Scheduler | scheduler | Доступен только для блоков-получателей Определяет cron‑планировщик из компонентов camel‑spring или camel‑quartz. Для встроенного планировщика используйте spring или quartz. | none | Строка |
| Scheduler Properties | schedulerProperties | Доступен только для блоков-получателей Дополнительные свойства для пользовательского планировщика или планировщиков на базе Quartz и Spring. | Строка | |
| Start Scheduler | startScheduler | Доступен только для блоков-получателей Определяет, будет ли планировщик запускаться автоматически. | True | Логическое значение |
| Time Unit | timeUnit | Доступен только для блоков-получателей Единицы измерения времени для параметров Initial Delay и Delay. Возможные значения:
| Milliseconds | Список |
| Use Fixed Delay | useFixedDelay | Доступен только для блоков-получателей Определяет режим выполнения: фиксированная задержка или фиксированная частота. | True | Логическое значение |
| Shuffle | shuffle | Доступен только для блоков-получателей Определяет, будет ли список файлов перетасован (отсортирован в случайном порядке). | False | Логическое значение |
| Sort By | sortBy | Доступен только для блоков-получателей Встроенная сортировка с использованием языка File Language. Поддерживается вложенная сортировка (например, по имени файла и дате изменения). | Строка | |
| Sorter | sorter | Доступен только для блоков-получателей Подключаемый сортировщик (например, класс java.util.Comparator). | Строка |
Расширенные параметры
| Название в UI | Название атрибута | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|
| Fast Exists Check | fastExistsCheck | Если True, FTP использует файл списка для быстрой проверки существования файла. Если False — применяется старый способ (отображение каталога). Влияет на параметр Read Lock = changed, ускоряя проверку обновления информации о файле (полезно при большом количестве файлов на FTP‑сервере). | False | Логическое значение |
| Allow Null Body | allowNullBody | Доступен только для блоков-отправителей Разрешает обработку сообщений с пустым телом (null/пустая строка). Если False, сообщение с пустым payload будет отклонено или вызовет ошибку. Полезно для сигнальных сообщений или heartbeat‑механизмов. | False | Логическое значение |
| Bridge Error Handler | bridgeErrorHandler | Доступен только для блоков-получателей Определяет, должен ли коннектор передавать ошибки, возникающие при получении сообщений, в обработчик ошибок Camel (Error Handler). При активации позволяет интегрировать обработку ошибок с маршрутизацией Camel. | False | Логическое значение |
| Download | download | Доступен только для блоков-получателей Определяет, должен ли получатель скачивать файл с сервера. При true — файл скачивается, его содержимое помещается в тело сообщения Camel Exchange. При false — файл не скачивается, тело сообщения (message body) будет null. | False | Логическое значение |
| Exception Handler | exceptionHandler | Доступен только для блоков-получателей Позволяет указать пользовательский обработчик исключений (ExceptionHandler) для получателя . По умолчанию получатель обрабатывает исключения самостоятельно: они логируются на уровне WARN или ERROR и игнорируются. При указании кастомного обработчика можно реализовать индивидуальную логику реагирования на ошибки (логирование, повторные попытки, перезапуск и т. д.). | Строка | |
| Exchange Pattern | exchangePattern | Доступен только для блоков-получателей Задает шаблон взаимодействия между компонентами в интеграционном потоке. Определяет способ передачи сообщений и ожидания ответа. Возможные значения:
| Строка | |
| Handle Directory Parser Absolute Result | handleDirectoryParserAbsoluteResult | Доступен только для блоков-получателей Определяет, должен ли компонент FTP преобразовывать абсолютные пути, возвращаемые сервером, в относительные при обработке файлов и подпапок. Если true, компонент FTP автоматически преобразует абсолютный путь в относительный — это позволяет корректно обрабатывать файлы в заданной директории. Если параметр отключен (false), пути остаются без изменений, что может привести к ошибкам обработки, если система ожидает относительные пути. | False | Логическое значение |
| Ignore File Not Found Or Permission Error | ignoreFileNotFoundOrPermissionError | Доступен только для блоков-получателей Определяет, следует ли игнорировать ошибки отсутствия файла или недостаточных прав доступа при работе с файлами. По умолчанию (false) при возникновении таких ошибок коннектор выбрасывает исключение, прерывая выполнение. | False | Логическое значение |
| In Progress Repository | inProgressRepository | Доступен только для блоков-получателей Указывает конкретное место назначения архивных журналов для чтения. Если не задано, коннектор выбирает первый доступный локальный и валидный источник. | Строка | |
| Local Work Directory | localWorkDirectory | Доступен только для блоков-получателей Путь к локальной директории, используемой получателем для временного хранения содержимого удаленных файлов. Позволяет избежать загрузки всего содержимого в память при обработке больших файлов — данные записываются напрямую в локальные файлы. Рекомендуется использовать в сценариях работы с объемными удаленными файлами для снижения нагрузки на оперативную память. | Строка | |
| On Completion Exception Handler | onCompletionExceptionHandler | Доступен только для блоков-получателей Позволяет указать пользовательский обработчик исключений ( org.apache.camel.spi.ExceptionHandler) для обработки ошибок, возникающих в процессе завершения работы получателя (commit/rollback) при обработке файлов. По умолчанию используется встроенная реализация: исключение логируется на уровне WARN и игнорируется (процесс продолжается). | Строка | |
| Poll Strategy | pollStrategy | Доступен только для блоков-получателей Плагин org.apache.camel.PollingConsumerPollingStrategy позволяет настроить собственную реализацию для управления обработкой ошибок, которые возникают во время операции опроса до создания и маршрутизации обмена в Camel. | Строка | |
| Process Strategy | processStrategy | Доступен только для блоков-получателей Плагин org.apache.camel.component.file.GenericFileProcessStrategy позволяет реализовать собственную логику обработки файлов, включая настройку кастомных блокировок чтения или проверку специальных условий перед потреблением файла (например, наличие специального файла-маркера готовности). При использовании этой стратегии опция readLock не применяется. | Строка | |
| Use List | useList | Доступен только для блоков-получателей Определяет, разрешено ли использовать команду LIST при загрузке файла. При значении true коннектор использует LIST для получения метаданных файла (размер, временная метка, права доступа и т. д.). При false загрузка выполняется без LIST — метаданные недоступны. Используйте этот режим, если сервер запрещает команду LIST, но вы точно знаете имя файла для загрузки. | True | Логическое значение |
| Chmod | сhmod | Доступен только для блоков-отправителей Позволяет установить права доступа (chmod) для сохраняемого файла. Формат — трех- или четырехзначное число в восьмеричной системе, как в Unix‑системах. Пример: 640 — владелец может читать и записывать, группа может читать, остальные не имеют доступа | Строка | |
| Disconnect On Batch Complete | disconnectOnBatchComplete | Доступен только для блоков-отправителей Определяет, нужно ли отключаться от удаленного FTP‑сервера сразу после завершения пакетной загрузки (batch upload). При активации опции будет разорвано только текущее соединение с FTP‑сервером — другие возможные соединения не затрагиваются. Использование этой настройки может помочь освободить ресурсы сервера и клиента, но приведет к дополнительным затратам на повторное установление соединения при следующей операции. | False | Логическое значение |
| Eager Delete Target File | eagerDeleteTargetFile | Доступен только для блоков-отправителей Определяет, нужно ли принудительно удалять существующий целевой файл до выполнения операции записи. Возможные значения:
| True | Логическое значение |
| Keep Last Modified | keepLastModified | Доступен только для блоков-отправителей Определяет, нужно ли сохранять метку времени последнего изменения (timestamp) от исходного файла при записи целевого файла. Механизм работы: 1. Система ищет метку времени в заголовке FileConstants.FILE_LAST_MODIFIED. Заголовок может содержать значение типа java.util.Date или long (числовое представление timestamp); если метка времени существует и опция включена, она будет установлена для записываемого файла. | False | Логическое значение |
| Lazy Start Producer | lazyStartProducer | Доступен только для блоков-отправителей Определяет, должен ли отправитель стартовать в отложенном режиме (при получении первого сообщения). Отложенный запуск полезен, если запуск отправителя может завершиться неудачей и привести к сбою при старте потока. При отложенном запуске сбой можно обработать во время маршрутизации сообщений с помощью обработчиков ошибок. Примечание: При обработке первого сообщения создание и старт отправителя могут занять время и увеличить общее время обработки. | False | Логическое значение |
| Move Existing File Strategy | moveExistingFileStrategy | Доступен только для блоков-отправителей Стратегия перемещения существующего файла при fileExist=Move. Задает правило именования/пути для перемещаемого файла (с поддержкой токенов). Если не задана — применяется стандартная реализация (добавляет суффикс .bak, .old и т. д.). | Строка | |
| Send Noop | sendNoop | Доступен только для блоков-отправителей Отправляет команду NOOP для проверки активности FTP‑соединения перед загрузкой файла. При отсутствии ответа — выполняется автоматическое переподключение. | True | Логическое значение |
| Active Port Range | activePortRange | Задает диапазон портов на стороне клиента для активного режима FTP (формат: minPort-maxPort, включительно). Например: 10000-19999 | Строка | |
| Auto Create | autoCreate | Задает автоматическое создание отсутствующих каталогов в пути к файлу. Для получателя — создание начального каталога. Для отправителя — каталога для записи файлов. | True | Логическое значение |
| Browse Limit | browseLimit | Доступен только для блоков-отправителей Максимальное количество сообщений, хранимых в памяти для возможности их просмотра (browsing). При достижении лимита старые сообщения удаляются. Значение 0 — неограниченный объем хранения сообщений в памяти. | 100 | Целое число |
| Buffer Size | bufferSize | Размер буфера в байтах в режиме потоковой загрузки. | 131072 | Целое число |
| Connect Timeout | connectTimeout | Устанавливает тайм-аут подключения для ожидания установления соединения в миллисекундах, используемый как FTPClient, так и JSCH. | 10000 | Целое число |
| Ftp Client | ftpClient | Позволяет указать пользовательский экземпляр FTP‑клиента. Используется, когда стандартных настроек недостаточно и требуется особая логика соединения/передачи. | Строка | |
| Ftp Client Config | ftpClientConfig | Задает конфигурацию FTP‑клиента (FTPClientConfig). Особенно важно для серверов с нестандартной локализацией (например, не‑ASCII имена файлов). | Строка | |
| Ftp Client Config Parameters | ftpClientConfigParameters | Строковое представление параметров конфигурации FTP‑клиента. Позволяет задать настройки в формате «ключ=значение» без создания Java‑объекта. Примеры параметров: serverLanguageCode=rulenient=true | Строка | |
| Ftp Client Parameters | ftpClientParameters | Дополнительные низкоуровневые параметры FTP‑клиента, передаваемые напрямую в FTPClient. Может включать: настройки буферизации (setBufferSize); таймауты (setConnectTimeout); параметры передачи (setFileType). Формат: «ключ=значение». | Строка | |
| Maximum Reconnect Attempts | maximumReconnectAttempts | Указывает максимальное количество попыток повторного подключения при подключении к удаленному FTP-серверу. Значение параметра 0 отключает эту функциональность. | Строка | |
| Reconnect Delay | reconnectDelay | Задержка в миллисекундах до попытки повторного подключения. | 1000 | Целое число |
| Site Command | siteCommand | Параметр задает опциональные SITE‑команды, которые выполняются на FTP‑сервере после успешного входа в систему (логина). | Строка | |
| So Timeout | soTimeout | Время ожидания Socket Options для FTP/FTPS (в мс). Рекомендуется установить 300 000 мс для избежания зависания. В SFTP — тайм‑аут для сеанса JSCH. | 300000 | Целое число |
| Stepwise | stepwise | Определяет, изменять ли каталоги поэтапно при просмотре файловых структур (выгрузка/загрузка). Примечание: Нельзя использовать вместе с Stream Download. | True | Логическое значение |
| Throw Exception On Connect Failed | throwExceptionOnConnectFailed | Доступен только для блоков-получателей Определяет, выдавать ли исключение при ошибке подключения. По умолчанию исключение не выдается, регистрируется WARN. | False | Логическое значение |
| Timeout | timeout | Таймаут ожидания ответа (в миллисекундах). Используется только компонентом FTPClient | 30000 | Строка |
| Pattern | pattern | Доступен только для блоков-получателей Шаблон взаимодействия (Exchange Pattern) для обмена сообщениями. Определяет направление потока данных между его компонентами. Возможные значения:
| Список | |
| Disabled | disabled | Доступен только для блоков-получателей Определяет, будет ли блок отключен в потоке. В активированном потоке функциональность блока не будет отрабатываться. | False | Логическое значение |
Параметры безопасности
| Название в UI | Название атрибута | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|
| Password | password | Пароль для авторизации на сервере. | Строка | |
| Account | аccount | Учетная запись (аккаунт) для авторизации на сервере. | Строка | |
| Username | username | Имя пользователя для авторизации на сервере. | Строка |