GetFTP

文档中心 › 组件索引 › GetFTP

GetFTP Processor

类型全限定名:cn.org.acal.lynxus.processors.standard.GetFTP

所属 Bundle:cn.org.acal.lynxus:lynxus-standard-nar:2.11.8

描述

从 FTP 服务器获取文件并从中创建 FlowFiles

标签

FTPgetretrievefilesfetchremoteingestsourceinput

属性

下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。

名称默认值可选值描述
Hostname远程系统的完全限定主机名或 IP 地址
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Port21远程系统正在侦听文件传输的端口
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Username用户名
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Password用户帐户的密码
敏感属性:是
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
Connection ModePassive
  • Active
  • Passive
FTP 连接方式
Transfer ModeBinary
  • Binary
  • ASCII
FTP传输模式
Remote Path远程系统上从中拉取或推送文件的路径
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
File Filter Regex提供Java正则表达式用于过滤文件名; 如果提供了过滤器,则仅获取名称与正则表达式匹配的文件
Path Filter Regex当'递归搜索'为 true 时,仅扫描路径匹配给定正则表达式的子目录
Polling Interval60 sec确定获取新文件列表之间等待的时间
Search Recursivelyfalse
  • true
  • false
如果为 true,将从任意嵌套的子目录中提取文件; 否则,不会遍历子目录
Follow Symbolic Linksfalse
  • true
  • false
如果为 true,则甚至会拉取符号文件以及嵌套的符号子目录; 否则,不会读取符号文件,也不会遍历符号链接子目录
Ignore Dotted Filestrue
  • true
  • false
如果为 true,名称以点开头的文件('.')将被忽略
Delete Originaltrue
  • true
  • false
确定文件成功传输后是否从远程系统中删除
Connection Timeout30 sec创建连接时超时之前等待的时间量
Data Timeout30 sec在本地和远程系统之间传输文件时,该值指定允许在系统之间不传输任何数据的时间长度
Max Selects100单个连接中拉取的最大文件数
Remote Poll Batch Size5000指定在远程系统上执行文件列表时,在给定目录中查找多少个文件路径。此值通常不需要修改,但在对包含大量文件的远程系统进行轮询时,此值可能至关重要。设置过高会导致性能很差,设置过低会导致流程比正常情况慢。
Use Natural Orderingfalse
  • true
  • false
如果为 true,将按照文件自然列出的顺序拉取文件; 否则,未定义拉取文件的顺序
Proxy Configuration Service控制器服务 API:
ProxyConfigurationService
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8
指定代理配置 Controller Service 来代理网络请求。
Internal Buffer Size16KB设置缓冲数据流的内部缓冲区大小
Use UTF-8 Encodingfalse
  • true
  • false
告诉客户端在处理文件和文件名时使用 UTF-8 编码。 如果设置为 true,服务器还必须支持 UTF-8 编码。

关系 (Relationships)

名称描述自动终止
success所有收到的 FlowFiles 都会成功路由否

写入的 FlowFile 属性

名称描述
filename文件名设置为远程服务器上的文件名
path路径设置为文件目录在远程服务器上的路径。例如,如果 <Remote Path> 属性设置为 /tmp,从 /tmp 拾取的文件的路径属性设置为 /tmp。如果 <Search Recursively> 属性设置为 true 且从 /tmp/abc/1/2/3 拾取文件,则路径属性设置为 /tmp/abc/1/2/3
file.lastModifiedTime源文件上次修改的日期和时间
file.lastAccessTime文件最后访问的日期和时间。可能不适用于所有文件系统
file.owner源文件的数字所有者 ID
file.group源文件的数字组 ID
file.permissions源文件的读/写/执行权限
absolute.path文件被拾取的完整/绝对路径。当前的 'path' 属性仍然被填充,但可能是相对路径

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件不允许有传入连接。

另请参阅