搜索

第 111 章 FTPS 组件

download PDF

可作为 Camel 版本 2.2 提供

此组件通过 FTP 和 SFTP 协议提供对远程文件系统的访问。

Maven 用户需要将以下依赖项添加到其 pom.xml 中:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-ftp</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

如需更多信息,您可以查看 FTP 组件

111.1. URI 选项

以下选项适用于 FTPS 组件。

FTPS 组件支持 2 个选项,它们如下所列。

名称描述默认类型

useGlobalSslContext Parameters (security)

启用使用全局 SSL 上下文参数。

false

布尔值

resolveProperty Placeholders (advanced)

启动时,组件是否应自行解析属性占位符。只有 String 类型的属性才能使用属性占位符。

true

布尔值

FTPS 端点使用 URI 语法配置:

ftps:host:port/directoryName

使用以下路径和查询参数:

111.1.1. 路径名(3 参数):

名称描述默认类型

主机

FTP 服务器 所需的 主机名

 

字符串

port

FTP 服务器的端口

 

int

directoryName

启动目录

 

字符串

111.1.2. 查询参数(122 参数):

名称描述默认类型

binary (common)

指定文件传输模式 BINARY 或 ASCII。默认为 ASCII (false)。

false

布尔值

charset (common)

此选项用于指定文件的编码。您可以在使用者上使用此来指定文件的编码,允许 Camel 知道 charset,以便在访问文件内容时加载文件内容。同样在编写文件时,也可以使用这个选项来指定 charset 以写入该文件。请记住,在编写文件 Camel 时,可能需要读取消息内容到内存中,以便能够将数据转换为配置的 charset,因此如果您有较大消息,则不会使用此消息。

 

字符串

disconnect (common)

使用后是否与远程 FTP 服务器断开连接。断开连接只会断开当前与 FTP 服务器的连接。如果您有一个要停止的消费者,则需要停止消费者/路由。

false

布尔值

doneFileName (common)

制作者:如果提供,Camel 将在写入原始文件时写入 2 个操作文件。完成的文件将为空。此选项配置要使用的文件名。您可以指定一个固定名称。或者您可以使用动态占位符。生成的文件将始终写在与原始文件相同的文件夹中。消费者:如果提供,Camel 才会消耗文件(如果存在)文件。此选项配置要使用的文件名。您可以指定一个固定名称。或者您可以使用动态占位符。完成的文件始终与原始文件在同一文件夹中。只支持 $file.name 和 $file.name.noext 作为动态占位符。

 

字符串

fileName (common)

使用文件语言等表达式动态设置文件名。对于消费者,它被用作文件名过滤器。对于制作者而言,用于评估要写入的文件名。如果设置了表达式,它将优先于 CamelFileName 标头。(注:标题本身也可以是 Expression)。表达式选项支持 String 和 Expression 类型。如果表达式是 String 类型,则始终会使用文件语言来评估。如果表达式是 Expression 类型,则使用指定的 Expression 类型 - 这允许您使用 OGNL 表达式。对于消费者,您可以使用文件名来过滤文件名,因此您可以使用文件语言语法:mydata-$date:now:yyyyMMdd.txt。生产者支持 CamelOverruleFileName 标头,其优先级高于任何现有的 CamelFileName 标头;CamelOverruleFileName 只是一个标头,而且可以更轻松地进行临时存储 CamelFileName,且必须稍后恢复。

 

字符串

passiveMode (common)

设置被动模式连接。默认为 active 模式连接。

false

布尔值

separator (common)

设置要使用的路径分隔符。Unix = 使用 unix 风格路径分隔符 Windows = 使用 Windows 风格的路径分隔符 = Auto = (默认)在文件名称中使用现有路径分隔符

UNIX

PathSeparator

transferLoggingInterval Seconds (common)

配置记录上传和下载操作进程时的间隔(以秒为单位)。当操作需要较长时,这用于日志记录进度。

5

int

transferLoggingLevel (common)

配置日志级别,以便在记录上传和下载操作的进度时使用。

DEBUG

LoggingLevel

transferLoggingVerbose (common)

配置上传和下载操作进度的详细(细粒度)日志记录。

false

布尔值

fastExistsCheck (common)

如果将这个选项设置为 true,则 camel-ftp 将使用列表文件直接检查文件是否存在。由于某些 FTP 服务器可能不支持直接列出文件,如果 选项为 false,则 camel-ftp 将使用旧方法列出该目录并检查文件是否存在。这个选项还会影响 readLock=changed,以控制它执行快速检查来更新文件信息。如果 FTP 服务器具有很多文件,则这可用于加快进程速度。

false

布尔值

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由 Error Handler,这意味着使用者试图获取传入消息或类似信息时出现任何异常,现在将作为一个消息进行处理,并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.Exception 处理程序处理异常,该处理程序将记录在 WARN 或 ERROR 级别,并忽略。

false

布尔值

delete (consumer)

如果为 true,则在成功处理该文件后会删除该文件。

false

布尔值

moveFailed (consumer)

根据简单语言设置移动失败表达式。例如,将文件移动到 .error 子目录,请使用: .error。注意:将文件移动到故障位置 Camel 将处理错误,且不会再次选择该文件。

 

字符串

noop (consumer)

如果为 true,则该文件不会以任何方式移动或删除。此选项对于只读数据或者 ETL 类型要求是很好的选择。如果 noop=true,Camel 也将设置 idempotent=true,以避免再次消耗相同的文件。

false

布尔值

preMove (consumer)

用于在处理前动态设置文件名的表达式(如文件语言)。例如,要将 in-progres 文件移动到 order 目录中,把这个值设置为 order。

 

字符串

preSort (consumer)

启用预先排序后,消费者将在轮询过程中对文件和目录名称进行排序,该名称是从文件系统检索的。如果需要以有序的顺序处理文件,您可能希望执行此操作。预先排序是在消费者开始过滤之前执行,并接受 Camel 进行处理的文件。这个选项为 default=false 表示禁用。

false

布尔值

recursive (consumer)

如果某个目录也会在所有子目录中查找文件。

false

布尔值

resumeDownload (consumer)

配置是否启用恢复下载。FTP 服务器必须支持它(几乎所有 FTP 服务器都支持它)。另外,还必须配置 localWorkDirectory 选项,这样下载的文件会存储在本地目录中,必须启用 选项二进制文件,以支持下载恢复。

false

布尔值

sendEmptyMessageWhenIdle (consumer)

如果轮询使用者没有轮询任何文件,您可以启用这个选项来发送空消息(无正文)。

false

布尔值

streamDownload (consumer)

设置不使用本地工作目录时要使用的下载方法。如果设置为 true,则远程文件会在读取时流传输至路由。当设置为 false 时,在将远程文件发送到路由之前将远程文件加载到内存。

false

布尔值

directoryMustExist (consumer)

与 startDirectoryMustExist 类似,但这在轮询递归子目录期间应用。

false

布尔值

download (consumer)

FTP 用户是否应下载 文件。如果此选项设置为 false,则消息正文将为空,但使用者仍将触发 Camel Exchange,其具有文件名、文件大小等文件的详细信息。这只是文件不会下载。

false

布尔值

exceptionHandler (consumer)

要让使用者使用自定义 ExceptionHandler。请注意,如果启用了选项 bridgeErrorHandler,则不使用这个选项。默认情况下,消费者处理异常,这将在 WARN 或 ERROR 级别记录,并忽略。

 

ExceptionHandler

exchangePattern (consumer)

在使用者创建交换时设置交换模式。

 

ExchangePattern

handleDirectoryParser AbsoluteResult (consumer)

如果目录解析器结果为绝对路径,则设置消费者如何处理子文件夹和文件。原因在于,一些 FTP 服务器可能会使用绝对路径返回文件名,如果是 FTP 组件需要处理这个路径,那么 FTP 组件需要通过将返回的路径转换为相对路径来进行处理。

false

布尔值

ignoreFileNotFoundOr PermissionError (consumer)

是否要忽略(尝试列出目录中的文件或在下载文件时),它们不存在或因为权限错误而存在。默认情况下,当目录或文件不存在或权限不足时,会抛出异常。将这个选项设置为 true 可强制忽略它。

false

布尔值

inProgressRepository (consumer)

可插拔插入存储库 org.apache.camel.spi.IdempotentRepository。in-progress 存储库用于考虑当前正在使用的进程文件中。默认情况下会使用基于内存的存储库。

 

IdempotentRepository

localWorkDirectory (consumer)

消耗时,可以使用本地工作目录直接将远程文件内容存储在本地文件中,以避免将内容加载到内存中。这在您消耗非常大的远程文件时很有用,因此可以节省内存。

 

字符串

onCompletionException Handler (consumer)

使用自定义 org.apache.camel.spi.ExceptionHandler 处理在完成过程中文件的异常,以处理使用者在完成过程中进行的提交或回滚。默认实现会将任何异常记录在 WARN 级别,并忽略。

 

ExceptionHandler

pollStrategy (consumer)

可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作中通常会发生错误处理,然后再在 Camel 中创建并被路由。

 

PollingConsumerPoll Strategy

processStrategy (consumer)

可插拔 org.apache.camel.component.file.GenericFileProcessStrategy 允许您实施自己的 readLock 选项或类似内容。在文件被消耗(如有特殊就绪文件)之前,还可使用特殊条件。如果设置了这个选项,则不会应用 readLock 选项。

 

GenericFileProcess Strategy

receiveBufferSize (consumer)

仅由 FTPClient 使用的接收(download)缓冲区大小

32768

int

startingDirectoryMustExist (consumer)

启动目录是否必须存在。请注意,autoCreate 选项是默认的启用状态,这意味着如果起始目录不存在,通常会自动创建起始目录。您可以禁用 autoCreate 并启用它,以确保起始目录必须存在。如果目录不存在,将抛出异常。

false

布尔值

useList (consumer)

下载文件时是否允许使用 LIST 命令.默认为 true。在某些情况下,您可能需要下载特定文件,且不允许使用 LIST 命令,因此您可以将这个选项设置为 false。请注意,使用这个选项时,要下载的特定文件不包含 meta-data 信息,如文件大小、时间戳、权限等,因为这些信息仅在使用 LIST 命令时检索。

true

布尔值

fileExist (producer)

如果文件已存在相同名称的文件,应该怎么办?覆盖(默认)替换现有文件。append - 将内容添加到现有文件中。fail - 引发 GenericFileOperationException,这表示已有的文件。ignore - 静默忽略问题且不覆盖现有文件,但假设一切正常。move - 选项需要使用同时配置 moveExisting 选项。选项 eagerDeleteTargetFile 可用于控制移动文件要做什么,并且已存在一个现有文件,否则会导致移动操作失败。Move 选项将在编写目标文件之前移动任何现有文件。TryRename 仅在使用 tempFileName 选项时才适用。这样,可以在不做任何检查的情况下,尝试将文件从临时名称重命名为实际名称。在某些文件系统中,这个检查可能会更快,特别是 FTP 服务器。

覆盖

GenericFileExist

flatten (producer)

flatten 用于扁平化文件名路径,以剥离任何前导路径,因此这仅仅是文件名。这样,您可以以递归方式使用子目录,但当您将这些文件写入单个目录中时。在制作者上,在制作者上将强制将设置 CamelFileName 标头中的任何文件名用于任何领先的路径。

false

布尔值

jailStartingDirectory (producer)

用于判断(限制)将文件写入起始目录(和子目录)。默认情况下,启用此项以允许 Camel 将文件写入外部目录(从该框更受保护)。您可以关闭此目的,允许将文件写入起始目录之外的目录,如父级或根文件夹。

true

布尔值

moveExisting (producer)

配置 fileExist=Move 时要使用的表达式(如文件语言)。要将文件移动到备份子目录中,只需输入备份。这个选项只支持以下文件语言令牌:file:name、file:name.ext、file:name.noext、file:onlyname、file:onlyname.noext、file:ext 和 file:parent。注意 file:parent 不受 FTP 组件支持,因为 FTP 组件只能将任何现有文件移到基于当前 dir 的相对目录中。

 

字符串

tempFileName (producer)

与 tempPrefix 选项相同,但可以为临时文件名命名提供更精细的控制,因为它使用文件语言。

 

字符串

tempPrefix (producer)

这个选项用于使用临时名称写入文件,然后在写入完成后将其重命名为真实名称。可用于识别正在写入的文件,并避免消费者(不使用专用读取锁定)读取进度文件。上传较大的文件时通常由 FTP 使用。

 

字符串

allowNullBody (producer)

用于指定在写入过程中是否允许 null 正文。如果设置为 true,则会创建一个空文件,如果设为 false,并且试图向文件组件发送 null 正文,则使用"Cannot将 null body 写入空正文到 file.' 的 GenericFileWriteException 的 GenericFileWriteException 来抛出。'如果将 fileExist 选项设置为 'Override',则文件将被截断,如果设置为 append,则文件将保持不变。

false

布尔值

chmod (producer)

允许您在存储的文件上设置 chmod。例如 chmod=640。

 

字符串

disconnectOnBatchComplete (producer)

批处理上传完成后是否与远程 FTP 服务器断开连接。disconnectedOnBatchComplete 将仅断开当前与 FTP 服务器的连接。

false

布尔值

eagerDeleteTargetFile (producer)

是否完全删除任何现有的目标文件。这个选项只适用于使用 fileExists=Override 和 tempFileName 选项。您可以使用它来禁用(将其设置为 false)在写入 temp 文件前删除目标文件。例如,您可以写入大文件,并且希望目标文件在正在写入时存在。这样可保证目标文件仅在最后一开始删除,而在 temp 文件被重命名为目标文件名之前。这个选项还用来控制是否在启用 fileExist=Move 时删除任何现有文件,并且存在现有文件。如果此选项 copyAndDeleteOnRenameFails false,则在存在现有文件(如果其 true)存在时,则会抛出异常(如果存在),那么在移动操作前会删除现有文件。

true

布尔值

keepLastModified (producer)

将保留来自源文件(若有)的最后修改的时间戳。将使用 Exchange.FILE_LAST_MODIFIED 标头来定位时间戳。此标头可以包含 java.util.Date 或 long with timestamp。如果存在时间戳,并且启用 选项,它将对写入的文件设置此时间戳。注:此选项仅适用于文件制作者。您不能对任何 ftp 制作者使用这个选项。

false

布尔值

moveExistingFileStrategy (producer)

用于在配置 fileExist=Move 时移动带有特殊命名令牌的文件的策略(Custom 策略)。默认情况下,如果没有提供自定义策略,则使用实施

 

FileMoveExisting 策略

sendNoop (producer)

在上传文件到 FTP 服务器之前,是否以预先写入的方式发送 noop 命令。这默认是启用的,因为连接的验证仍然有效,这样可以静默地重新连接来上传文件。但是,如果这会导致问题,您可以关闭这个选项。

true

布尔值

activePortRange (advanced)

以活动模式设置客户端侧端口范围。其语法为: minPort-maxPort Both 端口号为,如 10000-19999,以包括所有 1xxxx 端口。

 

字符串

autoCreate (advanced)

在文件路径名称中自动创建缺失的目录。对于文件使用者,这意味着创建起始目录。对于文件制作者,这意味着文件应写入到其中的目录。

true

布尔值

bufferSize (advanced)

以字节为单位写入缓冲区大小。

131072

int

connectTimeout (advanced)

设置等待由 FTPClient 和 JSCH 使用的连接的连接超时

10000

int

ftpClient (advanced)

使用 FTPClient 的自定义实例

 

FTPClient

ftpClientConfig (advanced)

要使用自定义 FTPClientConfig 实例来配置端点应使用的 FTP 客户端。

 

FTPClientConfig

ftpClientConfigParameters (advanced)

FtpComponent 用于为 FTPClientConfig 提供额外的参数

 

map

ftpClientParameters (advanced)

FtpComponent 用于为 FTPClient 提供额外的参数

 

map

maximumReconnectAttempts (advanced)

指定在尝试连接到远程 FTP 服务器时,Camel 会执行的最大重新连接尝试。使用 0 禁用此行为。

 

int

reconnectDelay (advanced)

在执行重新连接尝试前,millis Camel 会等待延迟。

 

long

siteCommand (advanced)

设置在成功登录后要执行的可选的 site 命令。可以使用新行字符分隔多个站点命令。

 

字符串

soTimeout (advanced)

设置仅由 FTPClient 使用的 so 超时

300000

int

stepwise (advanced)

设置在下载文件时是否应采取措施更改目录,或在上传文件到目录时。例如,如果因为安全原因而无法更改 FTP 服务器上的目录,您可以禁用此设置。

true

布尔值

同步 (高级)

设置同步处理是否应当严格使用,还是允许 Camel 使用异步处理(如果受支持)。

false

布尔值

throwExceptionOnConnect Failed (advanced)

如果连接失败(费用)默认情况下不会抛出异常,则应该抛出异常,日志为 WARN。您可以使用此功能启用异常,并处理来自 org.apache.camel.spi.PollingConsumerPollStrategy rollback 方法的抛出异常。

false

布尔值

timeout (advanced)

设置数据超时,以等待仅由 FTPClient 使用回复

30000

int

antExclude (filter)

Ant 样式过滤器排除.如果使用 antInclude 和 antExclude,则 antExclude 优先于 antInclude。可以用逗号分隔的格式指定多个排除项。

 

字符串

antFilterCaseSensitive (filter)

在 at 过滤器中设置区分大小写的标记

true

布尔值

antInclude (filter)

Ant 风格过滤器包含.可以用逗号分隔的格式指定多个包含。

 

字符串

eagerMaxMessagesPerPoll (filter)

允许控制 maxMessagesPerPoll 的限制是预先控制。如果预先考虑,则限制会在扫描文件期间进行。如果为 false,则扫描所有文件,然后执行排序。将此选项设置为 false 可首先对所有文件进行排序,然后限制轮询。请注意,这需要较高的内存用量,因为所有文件详细信息都位于内存中来执行排序。

true

布尔值

exclude (filter)

如果文件名与 regex 模式匹配,则使用 排除文件(匹配是 in-senstive)。请注意,如果将这个符号配置为端点 uri,则需要使用 RAW ()语法等符号(如加号)进行配置。有关配置端点 uris 时的详情,请参阅

 

字符串

filter (filter)

可插入的过滤器作为 org.apache.camel.component.file.GenericFileFilter 类。如果过滤器在其 accept ()方法中返回 false,则将跳过文件。

 

GenericFileFilter

filterDirectory (filter)

根据简单语言过滤目录。例如,要过滤当前日期,您可以使用一个简单的日期模式,如 $date:now:yyyMMdd

 

字符串

filterFile (filter)

根据简单语言过滤文件。例如,要根据文件大小进行过滤,可以使用 $file:size 5000

 

字符串

idempotent (filter)

使用 Idempotent Consumer EIP 模式的选项允许 Camel 跳过已处理的文件。默认情况下,将使用包含 1000 条目的基于内存的 LRUCache。如果 noop=true 之后,将启用幂等性,以避免再次消耗相同的文件。

false

布尔值

idempotentKey (filter)

使用自定义幂等密钥。默认情况下,使用文件的绝对路径。您可以使用文件语言(例如,使用文件名和文件大小),您可以完成: idempotentKey=$file:name-$file:size

 

字符串

idempotentRepository (filter)

可插拔存储库 org.apache.camel.spi.IdempotentRepository,如果未指定,则默认使用 MemoryMessageIdRepository,并且幂等为 true。

 

IdempotentRepository

include (filter)

如果文件名与 regex 模式匹配,则用于包含文件(匹配区分大小写)。请注意,如果将这个符号配置为端点 uri,则需要使用 RAW ()语法等符号(如加号)进行配置。有关配置端点 uris 时的详情,请参阅

 

字符串

maxDepth (filter)

递归处理目录时要遍历的最大深度。

2147483647

int

maxMessagesPerPoll (filter)

定义要为每个轮询收集的最大消息。默认情况下没有设置最大值。可用于设置 e.g. 1000 的限制,以避免在启动存在数千台服务器时。将值设为 0 或负数设为 disabled。注意:如果使用这个选项正在使用,则文件和 FTP 组件将在任何排序前限制。例如,如果您有 100000 文件并使用 maxMessagesPerPoll=500,则只会提取前 500 个文件,然后排序。您可以使用 eagerMaxMessagesPerPoll 选项,将其设置为 false,以允许首先扫描所有文件,然后再排序。

 

int

minDepth (filter)

递归处理目录时开始处理的最小深度信息。使用 minDepth=1 意味着基础目录。使用 minDepth=2 表示第一个子目录。

 

int

Move (filter)

表达式(如简单语言),用于在处理后动态设置文件名。要将文件移动到 .done 子目录中,只需输入 .done。

 

字符串

exclusiveReadLockStrategy (lock)

可插拔 read-lock 作为 org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy 实施。

 

GenericFileExclusive ReadLockStrategy

readLock (lock)

供使用者使用,仅当文件具有独占的 read-lock 时(例如,该文件没有处于-progres 或被写入时)轮询文件。Camel 将等待文件锁定。此选项以策略形式提供构建:无 - 无读取锁定在使用 markerFile - Camel 创建一个标志文件(fileName.camelLock),然后保存锁定。FTP 组件更改的这个选项 - 更改使用文件长度/修改时间戳来检测当前正在复制的文件。将至少使用 1 sec 来确定这一点,因此此选项无法像其他形式使用文件一样迅速使用,但由于 JDK IO API 无法始终确定文件当前是否正在被另一个进程使用。选项 readLockCheckInterval 可用于设置检查频率。fileLock - 用于使用 java.nio.channels.FileLock。这个选项不适用于 Windows 或 FTP 组件。在通过 mount/share 访问远程文件系统时,应该避免这种方法,除非文件系统支持分布式文件锁定。重命名 - 使用重命名文件作为测试,如果我们可以获得独占的 read-lock。幂等 - (对于文件组件)幂等的幂等性是使用 idempotentRepository 作为 read-lock 的 read-lock。这允许在幂等存储库实现支持集群时使用读取锁定,该锁定支持集群。幂等更改 - (对于文件组件)使用 idempotentRepository,并随着合并的 read-lock 改变。这允许使用支持集群的读取锁定,如果幂等存储库实施支持集群。幂等-rename - ( file 组件)幂等-rename 使用 idempotentRepository 并将 重命名为 combined read-lock。这允许在幂等存储库实现支持的情况下使用支持集群的读取锁定。注意:各种读取锁定不适用于在集群模式下工作,不同节点上的并发用户对共享文件系统上的相同文件都竞争。使用接近 atomic 操作来创建空的标志文件,但它无法保证在集群中工作。fileLock 可以更好地工作,但文件系统需要支持分布式文件锁定,以此类推。如果幂等存储库支持集群(如 Hazelcast 组件或 Infinispan),则使用幂等的读取锁定可以支持集群。

none

字符串

readLockCheckInterval (lock)

read-lock 的间隔(如果被读取锁定支持)。这个间隔用于在尝试获取读取锁定间进行睡眠状态。例如,在使用 changed 的 read lock 时,您可以将更高的间隔周期设置为 cater 以慢速写入。如果制作者非常慢,写入文件,则默认为 1 sec.。注意:对于 FTP 默认 readLockCheckInterval 为 5000。readLockTimeout 值必须大于 readLockCheckInterval,但经验规则至少为 2 个或更多或更多为 readLockCheckInterval。这需要确保读取锁定进程允许修改时间尝试在超时达到前获取锁。

1000

long

readLockDeleteOrphanLock Files (lock)

如果 Camel 未正确关闭,则启动时是否应该在启动时使用标志文件读取锁定文件来读取锁定文件(如 JVM 崩溃)。如果将此选项转换为 false,则任何孤立的锁定文件将导致 Camel 无法启动该文件,这可能是因为另一个节点同时从同一共享目录中读取文件。

true

布尔值

readLockIdempotentRelease Async (lock)

延迟发行版本任务应该是同步还是异步。请参阅 readLockIdempotentReleaseDelay 选项的详情。

false

布尔值

readLockIdempotentRelease AsyncPoolSize (lock)

使用异步发行任务时调度线程池中的线程数量。使用默认 1 个核心线程几乎应该已经足够了,只有更新幂等存储库或需要处理大量文件时,它才会将其设置为更高的值。如果您通过配置 readLockIdempotentReleaseExecutorService 选项,则使用这个选项。请参阅 readLockIdempotentReleaseDelay 选项的详情。

 

int

readLockIdempotentRelease Delay (lock)

是否延迟发布任务在millis 的期间。在带有共享幂等库的主动/主动集群场景中使用共享幂等存储库来确保其他节点无法扫描和获取同一文件,这可用于延迟发行任务以扩展窗口。通过扩展发行任务的 time-window 有助于防止这些情况。只有在将 readLockRemoveOnCommit 配置为 true 时,才需要注意延迟。

 

int

readLockIdempotentRelease ExecutorService (lock)

要将自定义和共享线程池用于异步发行任务。请参阅 readLockIdempotentReleaseDelay 选项的详情。

 

ScheduledExecutor 服务

readLockLoggingLevel (lock)

无法获取读取锁定时使用的日志记录级别。默认情况下记录 WARN。您可以更改此级别,例如,变为 OFF 以没有任何日志。这个选项仅适用于 readLock 类型的 readLock: changed、fileLock、幂等、幂等更改、幂等名称、重命名。

DEBUG

LoggingLevel

readLockMarkerFile (lock)

是否使用带 changed、重命名或专用读锁定类型的标记文件。默认情况下,也可使用标志文件来保护其他进程的获取相同的文件。可以通过将此选项设置为 false 来关闭此行为。例如,如果您不想将标记文件写入 Camel 应用程序的文件系统。

true

布尔值

readLockMinAge (lock)

此选项仅适用于 readLock=changed。它允许在尝试获取读取锁定前指定文件的最短期限。例如,使用 readLockMinAge=300s 来要求文件最多 5 分钟。这可能会加快更改的读取锁定,因为它只会试图获取至少是给定期限的文件。

0

long

readLockMinLength (lock)

此选项仅适用于 readLock=changed。它允许您配置最小长度。默认情况下,Camel 预期文件包含数据,因此默认值为 1。您可以将这个选项设置为零,以允许消耗零长度的文件。

1

long

readLockRemoveOnCommit (lock)

此选项仅适用于 readLock=idempotent。它允许您指定在处理文件成功并且提交发生时是否从幂等存储库中删除文件名条目。默认情况下,该文件不会被删除,以确保不会发生任何竞争条件,因此另一个活跃节点可能会尝试获取该文件。相反,幂等存储库可能会支持驱除策略,您可以配置在 X 分钟后驱除文件名条目 - 这可确保出现竞争条件的问题。请参阅 readLockIdempotentReleaseDelay 选项的详情。

false

布尔值

readLockRemoveOnRollback (lock)

此选项仅适用于 readLock=idempotent。它允许您指定在处理文件失败时是否从幂等存储库中删除文件名条目,并进行回滚。如果此选项为 false,则文件名条目已确认(如同文件提交一样)。

true

布尔值

readLockTimeout (lock)

如果 read-lock 支持,则 millis 中的可选超时。如果无法授予 read-lock 且触发超时,则 Camel 将跳过该文件。下次轮询 Camel 时,将重试文件,此时可能会授予 read-lock。使用 0 或 lower 值来永久指示。目前,fileLock,更改并重命名支持超时。注意:对于 FTP,默认的 readLockTimeout 值为 20000,而不是 10000。readLockTimeout 值必须大于 readLockCheckInterval,但经验规则至少为 2 个或更多或更多为 readLockCheckInterval。这需要确保读取锁定进程允许修改时间尝试在超时达到前获取锁。

10000

long

backoffErrorThreshold (scheduler)

后续错误轮询(因某些错误导致的失败)的数量,在 backoffMultipler 应该启动前发生。

 

int

backoffIdleThreshold (scheduler)

后续闲置轮询的数量,在 backoffMultipler 应该启动之前发生。

 

int

backoffMultiplier (scheduler)

如果行中有多个后续闲置/errors,让调度的轮询消费者重新关闭。然后,倍数是下一次实际尝试发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/or backoffErrorThreshold。

 

int

延迟 (scheduler)

下次轮询前的毫秒。您还可以使用单位(60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)指定时间值。

500

long

greedy (scheduler)

如果启用了 greedy,则 ScheduledPollConsumer 将立即再次运行,如果上一运行轮询了 1 或更多消息。

false

布尔值

initialDelay (scheduler)

第一次轮询启动前的毫秒。您还可以使用单位(60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)指定时间值。

1000

long

runLoggingLevel (scheduler)

消费者日志轮询轮询时启动/完成日志行。此选项允许您为其配置日志级别。

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

允许配置用于使用者的自定义/共享线程池。默认情况下,每个使用者都有自己的单个线程池。

 

ScheduledExecutor 服务

调度程序 (scheduler)

使用来自 camel-spring 或 camel-quartz2 组件的 cron 调度程序

none

ScheduledPollConsumer Scheduler

schedulerProperties (scheduler)

在使用自定义调度程序或任何基于 Spring 的调度程序时配置额外属性。

 

map

startScheduler (scheduler)

调度程序是否应自动启动。

true

布尔值

timeUnit (scheduler)

初始延迟和延迟选项的时间单位。

毫秒

TimeUnit

useFixedDelay (scheduler)

控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。

true

布尔值

shuffle (sort)

要取消文件列表(以随机顺序排序)

false

布尔值

sortBy (sort)

内置使用文件语言排序.支持嵌套的排序,因此您可以按文件名排序,并根据修改日期进行排序。

 

字符串

排序 器(排序)

可插拔排序器作为 java.util.Comparator 类。

 

比较器

帐户 (安全)

用于登录的帐户

 

字符串

disableSecureDataChannel Defaults (security)

使用这个选项禁用使用安全数据频道时的默认选项。这可让您完全控制应使用 execPbsz 和 execProt 设置的内容。默认为 false

false

布尔值

execPbsz (security)

使用安全数据频道时,您可以设置 exec 保护缓冲区大小

 

Long

execProt (security)

exec 保护级别 PROT 命令。c - 清除 S - Safe (仅限 SSL 协议)E- Confidential (SSL 协议) P - 私有

 

字符串

ftpClientKeyStore Parameters (security)

设置密钥存储参数

 

map

ftpClientTrustStore Parameters (security)

设置信任存储参数

 

map

isImplicit (security)

设置安全模式(Implicit/Explicit). true - Implicit Mode / False - Explicit Mode

false

布尔值

密码 (安全)

用于登录的密码

 

字符串

securityProtocol (security)

设置底层安全协议。

TLS

字符串

sslContextParameters (security)

获取 JSSE 配置,可覆盖 FtpsEndpoint#ftpClientKeyStoreParameters、ftpClientTrustStoreParameters 和 FtpsConfiguration#getSecurityProtocol ()中的任何设置。

 

SSLContextParameters

username (security)

用于登录的用户名

 

字符串

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.