FetchFTP

FetchFTP Processor

类型全限定名：cn.org.acal.lynxus.processors.standard.FetchFTP

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

描述

从远程 FTP 服务器获取文件内容，并用远程文件的内容覆盖传入 FlowFile 的内容。

多处理器协同场景

检索 FTP 服务器目录中的所有文件

ftpfiletransformstateretrievefetchallstream

配置 ListFTP：

"Hostname" 属性应设置为 FTP 服务器的完全限定主机名。最好通过将其设置为类似 `#{FTP_SERVER}` 的值来参数化     此属性。
"Remote Path" 属性必须设置为文件所在 FTP 服务器上的目录。如果要构建的流程将在其他地方重用，     最好通过将其设置为类似 `#{FTP_REMOTE_PATH}` 的值来参数化此属性。
将 "Username" 属性配置为用于登录 FTP 服务器的适当用户名。通常最好通过将其设置为类似 `#{FTP_USERNAME}` 的值来参数化     此属性。
将 "Password" 属性配置为所提供用户名的适当密码。通常最好通过将其设置为类似 `#{FTP_PASSWORD}` 的值来参数化     此属性。

然后将此处理器的 'success' Relationship 连接到 FetchFTP。

配置 FetchFTP：

"Hostname" = "${ftp.remote.host}"
"Remote File" = "${path}/${filename}"
"Username" = "${ftp.listing.user}"
"Password" = "#{FTP_PASSWORD}"

属性

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

名称	默认值	可选值	描述
Hostname			用于从中获取数据的主机的完全限定主机名或 IP 地址支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Port	`21`		连接到远程主机以从中获取数据的端口支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Username			用户名支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Password			用户帐户的密码敏感属性：是支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Remote File			远程系统上的完全限定文件名支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Completion Strategy	`None`	无 — 保留文件原样移动文件 — 将文件移动到 <Move Destination Directory> 属性指定的目录删除文件 — 从远程系统删除原始文件	指定文件被拉入 Lynxus 后对服务器上的原始文件执行的操作。如果完成策略失败，将记录警告但数据仍会被传输。
Move Destination Directory			The directory on the remote server to move the original file to once it has been ingested into Lynxus. This property is ignored unless the Completion Strategy is set to '移动文件'. The specified directory must already exist on the remote system if 'Create Directory' is disabled, or the rename will fail. 支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Create Directory	`false`	true false	Used when 'Completion Strategy' is '移动文件'. 指定如果远程目录不存在，是否应创建该目录。
Connection Timeout	`30 sec`		创建连接时超时之前等待的时间量
Data Timeout	`30 sec`		在本地和远程系统之间传输文件时，该值指定允许在系统之间不传输任何数据的时间长度
Use Compression	`false`	true false	指示传输文件时是否应使用 ZLIB 压缩
Connection Mode	`Passive`	Active Passive	FTP 连接方式
Transfer Mode	`Binary`	Binary ASCII	FTP传输模式
Proxy Configuration Service		控制器服务 API： `ProxyConfigurationService` cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8	指定代理配置 Controller Service 来代理网络请求。
Internal Buffer Size	`16KB`		设置缓冲数据流的内部缓冲区大小
Log Level When File Not Found	`ERROR`	TRACE DEBUG INFO WARN ERROR FATAL NONE	触发处理器时文件不存在时使用的日志级别
Use UTF-8 Encoding	`false`	true false	告诉客户端在处理文件和文件名时使用 UTF-8 编码。如果设置为 true，服务器还必须支持 UTF-8 编码。

关系 (Relationships)

名称	描述	自动终止
`comms.failure`	由于通信故障而无法从远程服务器获取的任何 FlowFile 将被传输到此关系。	否
`not.found`	我们从远程服务器收到“未找到”消息的任何FlowFile都将被传输到此关系。	否
`permission.denied`	任何由于权限不足而无法从远程服务器获取的 FlowFile 将被传输到此关系。	否
`success`	所有收到的 FlowFiles 都会成功路由	否

写入的 FlowFile 属性

名称	描述
`ftp.remote.host`	从中提取文件的主机名或 IP 地址
`ftp.remote.port`	用于与远程 FTP 服务器通信的端口
`ftp.remote.filename`	拉取的远程文件的名称
`filename`	文件名更新为指向远程文件的文件名
`path`	如果远程文件包含目录名称，则该目录名称将使用“path”属性添加到 FlowFile
`fetch.failure.reason`	路由到任何故障关系时应用的故障关系的名称

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件要求有传入连接。