Перейти к основному содержимому
Руководство администратора
How To статьи
Установка и настройка
Компоненты
Руководство пользователя
Начало работы

SFTP

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

Блок SFTP обеспечивает доступ к удаленным файловым системам по протоколу SFTP.

Блок SFTP может работать в двух режимах, которые определяются его положением в потоке. Если блок выступает в роли инициатора, он предназначен только для считывания файлов. Если же он используется как блок-отправитель, его функция ограничивается созданием новых файлов и их записью в указанную директорию.

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

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

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

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

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

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

Название в UIНазвание атрибутаОписаниеЗначение по умолчаниюТип данных
Dynamic EndpointdynamicEndpointДоступен только для блоков-отправителей
Позволяет включить встроенную функциональность динамического определения вызываемой конечной точки. При включении структура блока меняется: вместо to используется toD, а значение вызываемого ресурса может собираться из переменной (например, ${header.foo}).
FalseЛогическое значение
HosthostОбязательный параметр
Имя хоста FTP‑сервера.
Строка
ConnectionconnectionПозволяет выбрать предсозданное подключение к серверу или создать новое с помощью визарда Connection Manager.Список
DescriptiondescriptionКраткое описание блока.Строка
PortportПорт FTP‑сервера.Целое число
Directory NamedirectoryNameНачальный каталог.Строка
BinarybinaryУказывает режим передачи файлов: BINARY или ASCII. По умолчанию используется ASCII.FalseЛогическое значение
CharsetcharsetЗадает кодировку файла.
Возможные значения:
  • для получателя — загружать файлы в определенной кодировке.
  • для отправителя — указать кодировку, в которой будет записан файл при его создании или отправке.
Примечание:
Заданная кодировка может снизить производительность при конвертации больших сообщений. Если блок используется в качестве отправителя
Строка
DisconnectdisconnectОпределяет, следует ли отключаться от удаленного FTP‑сервера сразу после использования. Отключение затрагивает только текущее подключение. Примечание:
Для остановки потока нужно останавливать сам поток, а не использовать эту опцию.
FalseЛогическое значение
Done File NamedoneFileNameДля отправителя: после передачи оригинального файла создается пустой файл с указанным именем. Для получателя: обработка файлов начинается только после появления файла с указанным именем в директории. Поддерживается статическое и динамическое имя (синтаксис: ${file.name} и ${file.name.next} ).Строка
File NamefileNameЗадает выражение на языке File Language для динамического определения имени файла. Для блока‑получателя используется как фильтр имени файла. Имеет приоритет над системным заголовком CamelFileName.Строка
Jsch Logging LeveljschLoggingLevelЗадает уровень логирования для JSCH.
Возможные значения:
  • DEBUG
  • INFO
  • WARN
  • ERROR
WARNСписок
Passive ModepassiveModeУстанавливает пассивный режим соединения.FalseЛогическое значение
SeparatorseparatorЗадает разделитель пути к файлу в соответствии с ОС.
Возможные значения:
  • UNIX
  • Windows
  • Auto
UNIXСписок
DeletedeleteДоступен только для блоков-получателей
Определяет, должен ли файл удаляться после успешной обработки. При значении true файл будет удален из системы сразу после того, как коннектор завершит его обработку без ошибок.
FalseЛогическое значение
Move FailedmoveFailedДоступен только для блоков-получателей
Определяет действие с сообщением при возникновении ошибки обработки. Указывает, в какую очередь или папку следует переместить сообщение, если его обработка завершилась сбоем. Позволяет организовать отдельную обработку проблемных сообщений.
Строка
NoopnoopДоступен только для блоков-получателей
Режим обработки, при котором входящие сообщения игнорируются без выполнения каких‑либо действий и без генерации ошибок.
FalseЛогическое значение
Pre MovepreMoveДоступен только для блоков-получателей
Действие или набор действий, выполняемых перед перемещением сообщения.
Строка
Pre SortpreSortДоступен только для блоков-получателей
Определяет правила сортировки сообщений перед их основной обработкой. Может учитывать временные метки, приоритеты, идентификаторы или другие атрибуты сообщений.
Строка
RecursiverecursiveДоступен только для блоков-получателей
Включает рекурсивную обработку вложенных структур данных. При активации компонент обрабатывает все уровни вложенности; при отключении — только верхний уровень.
FalseЛогическое значение
Send Empty Message When IdlesendEmptyMessageWhenIdleДоступен только для блоков-получателей
Определяет, следует ли отправлять служебное (пустое) сообщение, если в течение заданного времени не поступило новых данных.
FalseЛогическое значение
Stream DownloadstreamDownloadДоступен только для блоков-получателей
Определяет метод загрузки, который будет применяться, когда не используется локальный рабочий каталог. Если установлено значение параметра True, то внешние файлы передаются в обработку по мере их чтения. Если установлено значение False, то внешние файлы загружаются в память перед отправкой в обработку.
Примечание:
Если эта опция включена, то нужно установить параметру Stepwise значение False, так как оба параметра не могут быть включены одновременно.
FalseЛогическое значение
Ant ExcludeantExcludeИсключает данные с помощью Ant‑фильтра. При одновременном использовании antInclude и antExclude приоритет имеет antExclude. Можно указать несколько значений через запятую.Строка
Ant Filter Case SensitiveantFilterCaseSensitiveЕсли True, Ant‑фильтр чувствителен к регистру.TrueЛогическое значение
Ant IncludeantIncludeВставляет данные с помощью Ant‑фильтра. Множественные значения перечисляются через запятую.Строка
Eager Max Messages Per PolleagerMaxMessagesPerPollКонтролирует активность ограничения maxMessagesPerPoll.
Возможные значения:
  • True: ограничение проверяется во время обработки файлов.
  • False: сначала проверяются все файлы, затем выполняется сортировка.
Примечание:
Сортировка требует больше памяти, так как все данные о файлах хранятся в памяти.
TrueЛогическое значение
ExcludeexcludeИсключает файлы, если имя соответствует шаблону регулярных выражений (с учетом регистра).Строка
Exclude ExtexcludeExtИсключает файлы с указанным расширением (без учета регистра). Можно перечислить несколько расширений через запятую.
Примечание:
Расширение включает все части (например, для mydata.tar.gz расширение — tar.gz ).
Строка
FilterfilterПодключаемый фильтр ( org.apache.camel.component.file.GenericFileFilter ). Пропускает файлы, если метод accept() возвращает False.Строка
Filter DirectoryfilterDirectoryФильтрует каталог на основе выражений языка Simple (например, по текущей дате: ${date:now:yyyyMMdd} ).Строка
Filter FilefilterFileФильтрует файлы на основе выражений языка Simple (например, по размеру: ${file:size} > 5000 ).Строка
IdempotentidempotentВключает функциональность соблюдения идемпотентности для пропуска уже обработанных файлов. По умолчанию используется LRUCache на 1000 записей. Если значение параметра "Noop"=True, то считается, что настройки идемпотентности начинают соблюдаться вне зависимости от выставленного значения в параметре "Idempotent".FalseЛогическое значение
Idempotent EageridempotentEagerОпределяет, добавлять ли имя файла в идемпотентный репозиторий сразу или после завершения обработки.FalseЛогическое значение
Idempotent KeyidempotentKeyЗадает пользовательский идемпотентный ключ. По умолчанию — абсолютный путь к файлу. Можно использовать язык File Language (например, idempotentKey=${file:name}-${file:size} ).Строка
Idempotent RepositoryidempotentRepositoryПодключаемый репозиторий (org.apache.camel.spi.IdempotentRepository).Строка
IncludeincludeВключает в обработку файлы, если имя соответствует шаблону регулярных выражений (с учетом регистра).Строка
Include ExtincludeExtВключает файлы с указанным расширением (без учета регистра).
Примечание:
Расширение включает все части (например, для mydata.tar.gz — tar.gz ).
Строка
Max DepthmaxDepthМаксимальная глубина вложенности при рекурсивной обработке каталога.2147483647Целое число
Max Messages Per PollmaxMessagesPerPollМаксимальное количество сообщений для обработки за один опрос. Значение 0 или отрицательное отключает ограничение.Целое число
Min DepthminDepthМинимальная глубина начала обработки при рекурсивной обработке.
Возможные значения:
  • minDepth=1: базовый каталог.
  • minDepth=2: первый подкаталог.
Целое число
MovemoveВыражение (например, на Simple Language) для динамического формирования имени файла при перемещении после обработки.Строка
Exclusive Read Lock StrategyexclusiveReadLockStrategyПодключаемая блокировка чтения (org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy).Строка
Read LockreadLockПолучатель обрабатывает файлы только при наличии исключительной блокировки на чтение.
Возможные значения:
  • none
  • markerFile
  • fileLock
  • rename
  • changed
  • idempotent
  • idempotent-changed
  • idempotent-rename.
noneСтрока
Read Lock Check IntervalreadLockCheckIntervalИнтервал в миллисекундах для блокировки чтения (если она поддерживается). Используется для ожидания между попытками получения блокировки чтения.1000Целое число
Read Lock Delete Orphan Lock FilesreadLockDeleteOrphanLockFilesПрименяется, когда Read Lock имеет значение markerFile. Определяет, нужно ли при запуске удалять оставшиеся файлы блокировки чтения (файлы‑маркеры), которые могли остаться в файловой системе после нештатного завершения работы (например, из‑за сбоя JVM).TrueЛогическое значение
Read Lock Idempotent Release AsyncreadLockIdempotentReleaseAsyncОпределяет, должна ли задача отложенного высвобождения быть синхронной или асинхронной.FalseЛогическое значение
Read Lock Idempotent Release Async Pool SizereadLockIdempotentReleaseAsyncPoolSizeКоличество потоков в запланированном пуле потоков при запуске задач асинхронного высвобождения.Целое число
Read Lock Idempotent Release DelayreadLockIdempotentReleaseDelayВремя в миллисекундах, на которое следует отложить запуск задачи по высвобождению.Целое число
Read Lock Idempotent Release Executor ServicereadLockIdempotentReleaseExecutorServiceЗадаёт пользовательский и общий пул потоков для задач асинхронного выпуска.Строка
Read Lock Logging LevelreadLockLoggingLevelУровень логирования в случаях, когда не удалось получить блокировку на чтение. Допустимые значения: TRACE, DEBUG, INFO, WARN, ERROR, OFF.DEBUGСписок (перечисление)
Read Lock Marker FilereadLockMarkerFileОпределяет, следует ли использовать файл‑маркер с типами блокировки changed, rename или exclusive. По умолчанию файл‑маркер также используется для защиты от получения тех же файлов другими процессами.TrueЛогическое значение
Read Lock Min AgereadLockMinAgeПрименяется, только если значение Read Lock установлено в changed. Позволяет указать минимальный возраст файла (в секундах) перед попыткой получения блокировки на чтение. Например, readLockMinAge=300 означает, что файл должен существовать минимум 5 минут.0Целое число
Read Lock Min LengthreadLockMinLengthПрименяется, только если значение Read Lock установлено в changed. Позволяет настроить минимальную длину файла (в байтах), при которой возможна блокировка на чтение.1Целое число
Read Lock Remove On CommitreadLockRemoveOnCommitПрименяется, только если значение Read Lock установлено в idempotent. Определяет, следует ли удалять запись имени файла из идемпотентного репозитория, если обработка файла завершилась успешно и изменения сохранены.FalseЛогическое значение
Read Lock Remove On RollbackreadLockRemoveOnRollbackПрименяется, только если значение Read Lock установлено в idempotent. Определяет, следует ли удалять запись имени файла из идемпотентного репозитория, если обработка файла завершилась неудачно и произошёл откат.TrueЛогическое значение
Read Lock TimeoutreadLockTimeoutОпциональный тайм‑аут в миллисекундах для блокировки чтения (если тайм‑аут поддерживается типом блокировки). Если блокировка не предоставлена и тайм‑аут истёк, файл будет пропущен — при следующем запросе попытка обработки повторится. Значение ≤ 0 означает «ждать всегда».10000Целое число
Backoff Error ThresholdbackoffErrorThresholdКоличество последовательно полученных ошибок обработки, после которого планировщик переходит в режим пропуска запусков.Целое число
Backoff Idle ThresholdbackoffIdleThresholdКоличество последовательных запросов, которые не привели к созданию или обработке данных (пустые опросы).Целое число
Backoff MultiplierbackoffMultiplierМножитель, определяющий, сколько следующих срабатываний планировщика будет пропущено, если достигнуты пороги Backoff Error Threshold или Backoff Idle Threshold. Используется совместно с этими параметрами.Целое число
DelaydelayПромежуток времени в миллисекундах до следующего запроса (интервал между опросами).500Целое число
GreedygreedyЕсли True, то после того, как ScheduledPollConsumer сработал и привёл к созданию или обработке данных, он сразу выполнит ещё один опрос (без ожидания интервала delay).FalseЛогическое значение
Initial DelayinitialDelayПромежуток времени в миллисекундах до первого запроса (задержка перед стартом опроса).1000Целое число
Repeat CountrepeatCountМаксимальное количество срабатываний планировщика. Нулевое или отрицательное значение означает неограниченное количество срабатываний (постоянный опрос).0Целое число
Run Logging LevelrunLoggingLevelНастройка уровня логирования старта и финиша инициации потока. Допустимые значения: TRACE, DEBUG, INFO, WARN, ERROR, OFF.TRACEСписок (перечисление)
Scheduled Executor ServicescheduledExecutorServiceПозволяет настроить пользовательский/общий пул потоков для получателя. По умолчанию у каждого получателя свой однопоточный пул.Строка
SchedulerschedulerОпределяет cron‑планировщик из компонентов camel‑spring или camel‑quartz. Для встроенного планировщика используйте spring или quartz.noneСтрока
Scheduler PropertiesschedulerPropertiesДополнительные свойства для пользовательского планировщика или планировщиков на базе Quartz и Spring.Строка
Start SchedulerstartSchedulerОпределяет, будет ли планировщик запускаться автоматически.TrueЛогическое значение
Time UnittimeUnitЕдиницы измерения времени для параметров Initial Delay и Delay.
Возможные значения:
  • Nanoseconds
  • Microseconds
  • Milliseconds
  • Seconds
  • Minutes
  • Hours
  • Days.
MillisecondsСписок
Use Fixed DelayuseFixedDelayОпределяет режим выполнения: фиксированная задержка или фиксированная частота.TrueЛогическое значение
ShuffleshuffleОпределяет, будет ли список файлов перетасован (отсортирован в случайном порядке).FalseЛогическое значение
Sort BysortByВстроенная сортировка с использованием языка File Language. Поддерживается вложенная сортировка (например, по имени файла и дате изменения).Строка
SortersorterПодключаемый сортировщик (например, класс java.util.Comparator).Строка

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

Название в UIНазвание атрибутаОписаниеЗначение по умолчаниюТип данных
Fast Exists CheckfastExistsCheckЕсли для этого параметра установлено значение true, FTP будет напрямую использовать файл списка, чтобы проверить, существует ли файл. Поскольку некоторые FTP-серверы могут не поддерживать прямое отображение файла, то, если параметр имеет значение False, FTP будет использовать старый способ отображения каталога и проверки существования файла. Этот параметр также влияет на параметр Read Lock в значении changed, чтобы контролировать, выполняет ли он быструю проверку на обновление информации о файле или нет. Это может быть использовано для ускорения процесса, если на FTP-сервере много файлов.FalseЛогическое значение
Bridge Error HandlerbridgeErrorHandler

Доступен только для блоков-получателей

Позволяет передавать возникшую ошибку из блока «наверх», т. е. на уровень потока, позволяя самостоятельно сконфигурировать собственные правила обработки ошибки через вспомогательные блоки.
Примечание:
Это возможно только в том случае, если сторонний компонент позволяет системе получать оповещение о возникновении исключения. Некоторые компоненты обрабатывают это только внутренне, и поэтому применение параметра невозможно. По умолчанию блок будет использовать встроенный обработчик исключений

FalseЛогическое значение
Downloaddownload

Доступен только для блоков-получателей

Определяет должен ли FTP получатель выгружать файл.

FalseЛогическое значение
Exception HandlerexceptionHandler

Доступен только для блоков-получателей

Задает пользовательский обработчик исключений
Примечание:
Если опция Bridge Error Handler включена, то опция Exception Handler не используется. По умолчанию пользователь будет обрабатывать исключения, которые будут регистрироваться на уровне WARN или ERROR и игнорироваться/

Строка
Exchange PatternexchangePattern

Доступен только для блоков-получателей

Устанавливает стиль взаимодействия с присоединенной частью потока.
Возможные значения:

  • InOnly — блок SFTP стартует поток и не ждет подтверждения от самого потока.
  • InOut — блок SFTP стартует поток и ожидает получения ответа от потока, когда тот закончит выполнять свою логику. Пока ответ не будет получен — следующее срабатывание блока не произойдет
Список
Ignore File Not Found Or Permission ErrorignoreFileNotFoundOrPermissionError

Доступен только для блоков-получателей

Определяет следует ли игнорировать не найденный файл (который не существует или не может быть прочитан из-за ошибки доступа) при попытке просмотреть список файлов в каталогах или при загрузке. По умолчанию, когда каталог или файл не существует или нет прав доступа, генерируется исключение. Установка значения true для этого параметра позволяет игнорировать не найденные файлы.

FalseЛогическое значение
In Progress RepositoryinProgressRepository

Доступен только для блоков-получателей

Подключаемый промежуточный репозиторий org.apache.camel.spi.idempotentRepository. Текущий репозиторий используется для учета текущих используемых файлов. По умолчанию используется хранилище в памяти.

Строка
Local Work DirectorylocalWorkDirectory

Доступен только для блоков-получателей

Локальный рабочий каталог, который может использоваться для хранения содержимого удаленного файла непосредственно в локальных файлах, чтобы избежать загрузки содержимого в память. Это может быть полезно, если вы используете очень большой удаленный файл и, таким образом, можете сэкономить память.

Строка
On Completion Exception HandleronCompletionExceptionHandler

Доступен только для блоков-получателей

Пользовательский обработчик org.apache.camel.spi.ExceptionHandler для обработки любых генерируемых исключений, возникающих в процессе завершения работы с файлом. Реализация по умолчанию регистрирует любое исключение на уровне WARN и игнорирует.

Строка
Poll StrategypollStrategy

Доступен только для блоков-получателей

Подключаемый файл org.apache.camel.PollingConsumerPollingStrategy, позволяющий использовать пользовательскую реализацию для управления обработкой ошибок, которые возникают во время запроса до запуска потока.

Строка
Process StrategyprocessStrategy

Доступен только для блоков-получателей

Подключаемый файл org.apache.camel.component.file.GenericFileProcessStrategy, позволяющий реализовать пользовательский параметр блокировки чтения Read Lock или аналогичный. Если этот параметр установлен, то опция блокировки чтения Read Lock не применяется.

Строка
Use ListuseList

Доступен только для блоков-получателей
Определяет, разрешено ли использовать команду LIST при загрузке файла. При значении true коннектор использует LIST для получения метаданных файла (размер, временная метка, права доступа и т. д.). При false загрузка выполняется без LIST — метаданные недоступны. Используйте этот режим, если сервер запрещает команду LIST, но вы точно знаете имя файла для загрузки.

TrueЛогическое значение
Idempotent RepositoryidempotentRepository

Подключаемый репозиторий (org.apache.camel.spi.IdempotentRepository).
Возможные значения:

  • Пустая строка — идемпотентное хранилище не используется, фильтрация дубликатов отключена.
  • jdbcClusterIdempotentRepository— класс для реализации идемпотентности через хранение идентификаторов в БД. Обеспечивает устойчивость к дубликатам при повторных вызовах.

Строка
IncludeincludeИспользуется для включения файлов, если имя файла соответствует шаблону регулярных выражений (при сопоставлении учитывается регистр символов).Строка
Include ExtincludeExt

Используется для включения файлов, соответствующих расширению файла (без учета регистра).
Примечание:
При использовании этой опции конкретный загружаемый файл не содержит метаданных, таких как размер файла, временная метка, права доступа и т.д., поскольку эту информацию можно получить только при использовании команды LIST.

TrueЛогическое значение
Chmodchmod

Доступен только для блоков‑отправителей
Позволяет установить права доступа (chmod) для сохраняемого файла. Формат — трёх- или четырёхзначное число в восьмеричной системе, как в Unix‑системах. Пример: 640 — владелец может читать и записывать, группа может читать, остальные не имеют доступа.

Строка
Chmod DirectorychmodDirectory

Доступен только для блоков‑отправителей
Позволяет задать права доступа (chmod) при создании пути. Например: chmod=640.

Строка
Disconnect On Batch CompletedisconnectOnBatchComplete

Доступен только для блоков‑отправителей
Определяет, нужно ли отключаться от удалённого FTP‑сервера сразу после завершения пакетной загрузки (batch upload). При активации опции будет разорвано только текущее соединение с FTP‑сервером — другие возможные соединения не затрагиваются. Использование этой настройки может помочь освободить ресурсы сервера и клиента, но приведёт к дополнительным затратам на повторное установление соединения при следующей операции.

FalseЛогическое значение
Eager Delete Target FileeagerDeleteTargetFile

Доступен только для блоков‑отправителей
Определяет, нужно ли принудительно удалять существующий целевой файл до выполнения операции записи. При True (по умолчанию): существующий файл удаляется до записи временного файла (при fileExists=Override); при fileExist=Move существующий файл удаляется перед операцией перемещения. При False: целевой файл не удаляется до момента переименования временного файла в целевой (сохраняется на протяжении всей записи временного файла); это полезно при записи больших файлов, когда важно, чтобы целевой файл оставался доступным до самого конца операции; если fileExist=Move и файл уже существует, будет выброшено исключение (если не задано иное поведение).

TrueЛогическое значение
Keep Last ModifiedkeepLastModified

Доступен только для блоков‑отправителей
Определяет, нужно ли сохранять метку времени последнего изменения (timestamp) от исходного файла при записи целевого файла. Система ищет метку времени в заголовке FileConstants.FILE_LAST_MODIFIED. Заголовок может содержать значение типа java.util.Date или long (числовое представление timestamp); если метка времени существует и опция включена, она будет установлена для записываемого файла.

FalseЛогическое значение
Lazy Start ProducerlazyStartProducer

Доступен только для блоков‑отправителей
Определяет, должен ли отправитель стартовать в отложенном режиме (при получении первого сообщения). Отложенный запуск полезен, если запуск отправителя может завершиться неудачей и привести к сбою при старте потока. При отложенном запуске сбой можно обработать во время маршрутизации сообщений с помощью обработчиков ошибок. Примечание: при обработке первого сообщения создание и старт отправителя могут занять время и увеличить общее время обработки.

FalseЛогическое значение
Move Existing File StrategymoveExistingFileStrategy

Доступен только для блоков‑отправителей
Стратегия перемещения существующего файла при fileExist=Move. Задаёт правило именования/пути для перемещаемого файла (с поддержкой токенов). Если не задана — применяется стандартная реализация (добавляет суффикс .bak, .old и т. д.).

Строка
Send NoopsendNoop

Доступен только для блоков-отправителей
Отправляет команду NOOP для проверки активности FTP‑соединения перед загрузкой файла. При отсутствии ответа выполняется автоматическое переподключение.

TrueЛогическое значение
Auto CreateautoCreateЗадает автоматическое создание отсутствующих каталогов в имени пути к файлу. Для получателя файла это означает создание начального каталога. Для отправителя файла – это каталог, в который должны быть записаны файлы.TrueЛогическое значение
Bind AddressbindAddressУказывает адрес локального интерфейса, к которому должно быть привязано соединение.Строка
Bulk RequestsbulkRequestsУказывает, сколько запросов может быть обработано одновременно. Увеличение этого значения может немного повысить скорость передачи файлов, но увеличит использование памяти.Целочисленное значение
Compressioncompression

Параметр применяется для того, чтобы использовать сжатие. Укажите уровень от 1 до 10.
Примечание:
Вы должны вручную добавить необходимый JAR-файл JSCH zlib в classpath для поддержки сжатия.

Целочисленное значение
Connect TimeoutconnectTimeoutУстанавливает тайм-аут подключения для ожидания установления соединения в миллисекундах, используемый как FTPClient, так и JSCH.10000Целочисленное значение
Exist Dir Check Using LsexistDirCheckUsingLsОпределяет следует ли проверять наличие существующего каталога с помощью команды LS или CD.TrueЛогическое значение
Filename EncodingfilenameEncodingКодировка, используемая FTP-клиентом при разборе имен файлов.UTF - 8Строка
Maximum Reconnect AttemptsmaximumReconnectAttemptsУказывает максимальное количество попыток повторного подключения при подключении к удаленному FTP-серверу. Значение параметра 0 отключает эту функциональность.Целочисленное значение
ProxyproxyЗадает пользовательский com.jcraft.jsch.Proxy. Этот прокси-сервер используется для получения/отправки сообщений с целевого узла SFTP.Строка
Reconnect DelayreconnectDelayЗадержка в миллисекундах до попытки повторного подключения.1000Длинное целое число
Server Alive Count MaxserverAliveCountMaxУстанавливает количество сообщений keep-alive, которые могут быть отправлены без получения каких-либо сообщений от сервера. При достижении этого порогового значения во время отправки сообщений keep-alive соединение будет разорвано. Значение по умолчанию - единица.1Целочисленное значение
Server Alive IntervalserverAliveIntervalУстанавливает интервал в миллисекундах для отправки сообщения keep-alive. Если указано значение ноль, сообщения keep-alive не должны отправляться. Интервал по умолчанию равен нулю.Целочисленное значение
Server Message Logging LevelserverMessageLoggingLevel

Уровень логирования для сообщений, отправляемых с FTP-сервера.
Возможные значения:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • OFF
DEBUGСписок
So TimeoutsoTimeoutУстанавливает время ожидания Socket Options для FTP и FTPS в миллисекундах. Рекомендуется установить значение 300000, чтобы избежать зависания соединения. В SFTP этот параметр установлен как тайм-аут для экземпляра сеанса JSCH.300000Целочисленное значение
StepwisestepwiseОпределяет, следует ли поэтапно изменять каталоги при просмотре файловых структур при выгрузке файлов или при загрузке файла в каталог. Параметр Stepwise нельзя использовать вместе с параметром Stream Download.TrueЛогическое значение
Throw Exception On Connect FailedthrowExceptionOnConnectFailedОпределяет должно ли быть выдано исключение, если соединение завершилось ошибкой (исчерпано). По умолчанию исключение не выдается и регистрируется запись WARN.FalseЛогическое значение
TimeouttimeoutУстанавливает время ожидания ответа в миллисекундах. Используется только на FTPClient.30000Целочисленное значение
Disableddisabled

Доступен только для блоков-отправителей
Определяет будет ли отключен блок в потоке. В активированном потоке функциональность блока не будет отрабатываться.

FalseЛогическое значение
Patternpattern

Доступен только для блоков-отправителей

Устанавливает стиль взаимодействия с присоединенной частью потока.
Возможные значения:

  • InOnly — отправить без подтверждения приемки. При выборе в отправленном yaml и в режиме просмотра кода будет виден параметр pattern на том же уровне, что и uri.
  • InОut — ждать подтверждения после отправки.
Список

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

Название в UIНазвание атрибутаОписаниеЗначение по умолчаниюТип данных
CiphersciphersРазделенный запятыми список шифров, которые будут использоваться в порядке предпочтения. Возможные названия шифров определены в JCraft JSCH. Некоторые примеры включают в себя: aes128-ctr, aes128-cbc, 3des-ctr, 3des-cbc, blowfish-cbc, aes192-cbc, aes256-cbc. Если не указано иное, будет использоваться список по умолчанию из JSCH.Строка
Key Exchange ProtocolskeyExchangeProtocolsРазделенный запятыми список протоколов обмена ключами, которые будут использоваться в порядке предпочтения. Возможные названия шифров определены в JCraft JSCH. Некоторые примеры включают в себя: diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1,diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521. Если не указано иное, будет использоваться список по умолчанию из JSCH.Строка
PasswordpasswordПароль для входа в систему.Строка
Preferred AuthenticationspreferredAuthenticationsПредпочтительные способы аутентификации, которые будет использовать конечная точка SFTP. В качестве примера можно привести следующие: пароль, публичный ключ. Если не указано иное, будет использоваться список по умолчанию из JSCH.Строка
Private Key FileprivateKeyFileФайл закрытого ключа, предназначенный для того, чтобы конечная точка SFTP могла выполнять проверку закрытого ключа.Строка
Private Key PassphraseprivateKeyPassphraseКодовая фраза файла закрытого ключа, предназначенная для того, чтобы конечная точка SFTP могла выполнить проверку закрытого ключа.Строка
Public Key Accepted AlgorithmspublicKeyAcceptedAlgorithmsСписок алгоритмов, принимаемых с открытым ключом разделенный запятыми. Некоторые примеры включают в себя: ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521. Если не указано иное, будет использоваться список по умолчанию из JSCH.Строка
Server Host KeysserverHostKeysСписок поддерживаемых алгоритмов, разделенных запятыми, для ключа хоста сервера. Некоторые примеры включают в себя: ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521. Если не указано иное, будет использоваться список по умолчанию из JSCH.Строка
Strict Host Key CheckingstrictHostKeyChecking

Определяет, следует ли использовать строгую проверку ключа хоста.
Возможные значения:

  • no
  • yes
noСтрока
UsernameusernameИмя пользователя, которое будет использоваться для входа в систему.Строка
Use User Known Hosts FileuseUserKnownHostsFileЕсли параметр Known Host File явно не настроен, используйте файл хоста из System.getProperty(user.home)/.ssh/known_hosts.TrueЛогическое значение