Interface SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
SftpEndpointBuilderFactory.SftpEndpointBuilder
- Enclosing interface:
- SftpEndpointBuilderFactory
public static interface SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the SFTP component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
antExclude
(String antExclude) Ant style filter exclusion.antFilterCaseSensitive
(boolean antFilterCaseSensitive) Sets case sensitive flag on ant filter.antFilterCaseSensitive
(String antFilterCaseSensitive) Sets case sensitive flag on ant filter.antInclude
(String antInclude) Ant style filter inclusion.backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.binary
(boolean binary) Specifies the file transfer mode, BINARY or ASCII.Specifies the file transfer mode, BINARY or ASCII.This option is used to specify the encoding of the file.Set a comma separated list of ciphers that will be used in order of preference.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.delete
(boolean delete) If true, the file will be deleted after it is processed successfully.If true, the file will be deleted after it is processed successfully.disconnect
(boolean disconnect) Whether or not to disconnect from remote FTP server right after use.disconnect
(String disconnect) Whether or not to disconnect from remote FTP server right after use.doneFileName
(String doneFileName) Producer: If provided, then Camel will write a 2nd done file when the original file has been written.eagerMaxMessagesPerPoll
(boolean eagerMaxMessagesPerPoll) Allows for controlling whether the limit from maxMessagesPerPoll is eager or not.eagerMaxMessagesPerPoll
(String eagerMaxMessagesPerPoll) Allows for controlling whether the limit from maxMessagesPerPoll is eager or not.Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive).excludeExt
(String excludeExt) Is used to exclude files matching file extension name (case insensitive).exclusiveReadLockStrategy
(String exclusiveReadLockStrategy) Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.exclusiveReadLockStrategy
(org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<org.apache.camel.component.file.remote.SftpRemoteFile> exclusiveReadLockStrategy) Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.Use Expression such as File Language to dynamically set the filename.Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class.filter
(org.apache.camel.component.file.GenericFileFilter<org.apache.camel.component.file.remote.SftpRemoteFile> filter) Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class.filterDirectory
(String filterDirectory) Filters the directory based on Simple language.filterFile
(String filterFile) Filters the file based on Simple language.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.idempotent
(Boolean idempotent) Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files.idempotent
(String idempotent) Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files.idempotentKey
(String idempotentKey) To use a custom idempotent key.idempotentRepository
(String idempotentRepository) A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true.idempotentRepository
(org.apache.camel.spi.IdempotentRepository idempotentRepository) A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true.Is used to include files, if filename matches the regex pattern (matching is case in-sensitive).includeExt
(String includeExt) Is used to include files matching file extension name (case insensitive).initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.jschLoggingLevel
(String jschLoggingLevel) The logging level to use for JSCH activity logging.jschLoggingLevel
(org.apache.camel.LoggingLevel jschLoggingLevel) The logging level to use for JSCH activity logging.keyExchangeProtocols
(String keyExchangeProtocols) Set a comma separated list of key exchange protocols that will be used in order of preference.Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification.Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification.knownHosts
(byte[] knownHosts) Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification.knownHosts
(String knownHosts) Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification.knownHostsFile
(String knownHostsFile) Sets the known_hosts file, so that the SFTP endpoint can do host key verification.knownHostsUri
(String knownHostsUri) Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification.maxDepth
(int maxDepth) The maximum depth to traverse when recursively processing a directory.The maximum depth to traverse when recursively processing a directory.maxMessagesPerPoll
(int maxMessagesPerPoll) To define a maximum messages to gather per poll.maxMessagesPerPoll
(String maxMessagesPerPoll) To define a maximum messages to gather per poll.minDepth
(int minDepth) The minimum depth to start processing when recursively processing a directory.The minimum depth to start processing when recursively processing a directory.Expression (such as Simple Language) used to dynamically set the filename when moving it after processing.moveFailed
(String moveFailed) Sets the move failure expression based on Simple language.noop
(boolean noop) If true, the file is not moved or deleted in any way.If true, the file is not moved or deleted in any way.passiveMode
(boolean passiveMode) Sets passive mode connections.passiveMode
(String passiveMode) Sets passive mode connections.Password to use for login.preferredAuthentications
(String preferredAuthentications) Set the preferred authentications which SFTP endpoint will used.Expression (such as File Language) used to dynamically set the filename when moving it before processing.preSort
(boolean preSort) When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system.When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system.privateKey
(byte[] privateKey) Set the private key as byte so that the SFTP endpoint can do private key verification.privateKey
(String privateKey) Set the private key as byte so that the SFTP endpoint can do private key verification.privateKeyFile
(String privateKeyFile) Set the private key file so that the SFTP endpoint can do private key verification.privateKeyPassphrase
(String privateKeyPassphrase) Set the private key file passphrase so that the SFTP endpoint can do private key verification.privateKeyUri
(String privateKeyUri) Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification.publicKeyAcceptedAlgorithms
(String publicKeyAcceptedAlgorithms) Set a comma separated list of public key accepted algorithms.Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e.readLockCheckInterval
(long readLockCheckInterval) Interval in millis for the read-lock, if supported by the read lock.readLockCheckInterval
(String readLockCheckInterval) Interval in millis for the read-lock, if supported by the read lock.readLockDeleteOrphanLockFiles
(boolean readLockDeleteOrphanLockFiles) Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash).readLockDeleteOrphanLockFiles
(String readLockDeleteOrphanLockFiles) Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash).readLockIdempotentReleaseAsync
(boolean readLockIdempotentReleaseAsync) Whether the delayed release task should be synchronous or asynchronous.readLockIdempotentReleaseAsync
(String readLockIdempotentReleaseAsync) Whether the delayed release task should be synchronous or asynchronous.readLockIdempotentReleaseAsyncPoolSize
(int readLockIdempotentReleaseAsyncPoolSize) The number of threads in the scheduled thread pool when using asynchronous release tasks.readLockIdempotentReleaseAsyncPoolSize
(String readLockIdempotentReleaseAsyncPoolSize) The number of threads in the scheduled thread pool when using asynchronous release tasks.readLockIdempotentReleaseDelay
(int readLockIdempotentReleaseDelay) Whether to delay the release task for a period of millis.readLockIdempotentReleaseDelay
(String readLockIdempotentReleaseDelay) Whether to delay the release task for a period of millis.readLockIdempotentReleaseExecutorService
(String readLockIdempotentReleaseExecutorService) To use a custom and shared thread pool for asynchronous release tasks.readLockIdempotentReleaseExecutorService
(ScheduledExecutorService readLockIdempotentReleaseExecutorService) To use a custom and shared thread pool for asynchronous release tasks.readLockLoggingLevel
(String readLockLoggingLevel) Logging level used when a read lock could not be acquired.readLockLoggingLevel
(org.apache.camel.LoggingLevel readLockLoggingLevel) Logging level used when a read lock could not be acquired.readLockMarkerFile
(boolean readLockMarkerFile) Whether to use marker file with the changed, rename, or exclusive read lock types.readLockMarkerFile
(String readLockMarkerFile) Whether to use marker file with the changed, rename, or exclusive read lock types.readLockMinAge
(long readLockMinAge) This option is applied only for readLock=changed.readLockMinAge
(String readLockMinAge) This option is applied only for readLock=changed.readLockMinLength
(long readLockMinLength) This option is applied only for readLock=changed.readLockMinLength
(String readLockMinLength) This option is applied only for readLock=changed.readLockRemoveOnCommit
(boolean readLockRemoveOnCommit) This option is applied only for readLock=idempotent.readLockRemoveOnCommit
(String readLockRemoveOnCommit) This option is applied only for readLock=idempotent.readLockRemoveOnRollback
(boolean readLockRemoveOnRollback) This option is applied only for readLock=idempotent.readLockRemoveOnRollback
(String readLockRemoveOnRollback) This option is applied only for readLock=idempotent.readLockTimeout
(long readLockTimeout) Optional timeout in millis for the read-lock, if supported by the read-lock.readLockTimeout
(String readLockTimeout) Optional timeout in millis for the read-lock, if supported by the read-lock.recursive
(boolean recursive) If a directory, will look for files in all the sub-directories as well.If a directory, will look for files in all the sub-directories as well.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.sendEmptyMessageWhenIdle
(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sendEmptyMessageWhenIdle
(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.Sets the path separator to be used.separator
(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator) Sets the path separator to be used.serverHostKeys
(String serverHostKeys) Set a comma separated list of algorithms supported for the server host key.shuffle
(boolean shuffle) To shuffle the list of files (sort in random order).To shuffle the list of files (sort in random order).Built-in sort by using the File Language.Pluggable sorter as a java.util.Comparator class.sorter
(Comparator<org.apache.camel.component.file.GenericFile<org.apache.camel.component.file.remote.SftpRemoteFile>> sorter) Pluggable sorter as a java.util.Comparator class.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.streamDownload
(boolean streamDownload) Sets the download method to use when not using a local working directory.streamDownload
(String streamDownload) Sets the download method to use when not using a local working directory.strictHostKeyChecking
(String strictHostKeyChecking) Sets whether to use strict host key checking.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.Username to use for login.useUserKnownHostsFile
(boolean useUserKnownHostsFile) If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.useUserKnownHostsFile
(String useUserKnownHostsFile) If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
binary
Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
binary
- the value to set- Returns:
- the dsl builder
-
binary
Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
binary
- the value to set- Returns:
- the dsl builder
-
charset
This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
charset
- the value to set- Returns:
- the dsl builder
-
disconnect
Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
disconnect
- the value to set- Returns:
- the dsl builder
-
disconnect
Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
disconnect
- the value to set- Returns:
- the dsl builder
-
doneFileName
Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
doneFileName
- the value to set- Returns:
- the dsl builder
-
fileName
Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
fileName
- the value to set- Returns:
- the dsl builder
-
jschLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder jschLoggingLevel(org.apache.camel.LoggingLevel jschLoggingLevel) The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: common- Parameters:
jschLoggingLevel
- the value to set- Returns:
- the dsl builder
-
jschLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder jschLoggingLevel(String jschLoggingLevel) The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: common- Parameters:
jschLoggingLevel
- the value to set- Returns:
- the dsl builder
-
passiveMode
Sets passive mode connections. Default is active mode connections. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
passiveMode
- the value to set- Returns:
- the dsl builder
-
passiveMode
Sets passive mode connections. Default is active mode connections. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
passiveMode
- the value to set- Returns:
- the dsl builder
-
separator
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder separator(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator) Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name. The option is a: <code>org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator</code> type. Default: UNIX Group: common- Parameters:
separator
- the value to set- Returns:
- the dsl builder
-
separator
Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name. The option will be converted to a <code>org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator</code> type. Default: UNIX Group: common- Parameters:
separator
- the value to set- Returns:
- the dsl builder
-
delete
If true, the file will be deleted after it is processed successfully. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
delete
- the value to set- Returns:
- the dsl builder
-
delete
If true, the file will be deleted after it is processed successfully. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
delete
- the value to set- Returns:
- the dsl builder
-
moveFailed
Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
moveFailed
- the value to set- Returns:
- the dsl builder
-
noop
If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
noop
- the value to set- Returns:
- the dsl builder
-
noop
If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
noop
- the value to set- Returns:
- the dsl builder
-
preMove
Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
preMove
- the value to set- Returns:
- the dsl builder
-
preSort
When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
preSort
- the value to set- Returns:
- the dsl builder
-
preSort
When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
preSort
- the value to set- Returns:
- the dsl builder
-
recursive
If a directory, will look for files in all the sub-directories as well. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
recursive
- the value to set- Returns:
- the dsl builder
-
recursive
If a directory, will look for files in all the sub-directories as well. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
recursive
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
streamDownload
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder streamDownload(boolean streamDownload) Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
streamDownload
- the value to set- Returns:
- the dsl builder
-
streamDownload
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder streamDownload(String streamDownload) Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route. If enabling this option then you must set stepwise=false as both cannot be enabled at the same time. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
streamDownload
- the value to set- Returns:
- the dsl builder
-
antExclude
Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
antExclude
- the value to set- Returns:
- the dsl builder
-
antFilterCaseSensitive
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder antFilterCaseSensitive(boolean antFilterCaseSensitive) Sets case sensitive flag on ant filter. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
antFilterCaseSensitive
- the value to set- Returns:
- the dsl builder
-
antFilterCaseSensitive
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder antFilterCaseSensitive(String antFilterCaseSensitive) Sets case sensitive flag on ant filter. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
antFilterCaseSensitive
- the value to set- Returns:
- the dsl builder
-
antInclude
Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
antInclude
- the value to set- Returns:
- the dsl builder
-
eagerMaxMessagesPerPoll
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder eagerMaxMessagesPerPoll(boolean eagerMaxMessagesPerPoll) Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. The option is a: <code>boolean</code> type. Default: true Group: filter- Parameters:
eagerMaxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
eagerMaxMessagesPerPoll
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder eagerMaxMessagesPerPoll(String eagerMaxMessagesPerPoll) Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. The option will be converted to a <code>boolean</code> type. Default: true Group: filter- Parameters:
eagerMaxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
exclude
Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
exclude
- the value to set- Returns:
- the dsl builder
-
excludeExt
Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
excludeExt
- the value to set- Returns:
- the dsl builder
-
filter
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder filter(org.apache.camel.component.file.GenericFileFilter<org.apache.camel.component.file.remote.SftpRemoteFile> filter) Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. The option is a: <code>org.apache.camel.component.file.GenericFileFilter<org.apache.camel.component.file.remote.SftpRemoteFile></code> type. Group: filter- Parameters:
filter
- the value to set- Returns:
- the dsl builder
-
filter
Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. The option will be converted to a <code>org.apache.camel.component.file.GenericFileFilter<org.apache.camel.component.file.remote.SftpRemoteFile></code> type. Group: filter- Parameters:
filter
- the value to set- Returns:
- the dsl builder
-
filterDirectory
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder filterDirectory(String filterDirectory) Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
filterDirectory
- the value to set- Returns:
- the dsl builder
-
filterFile
Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
filterFile
- the value to set- Returns:
- the dsl builder
-
idempotent
Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: filter- Parameters:
idempotent
- the value to set- Returns:
- the dsl builder
-
idempotent
Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. The option will be converted to a <code>java.lang.Boolean</code> type. Default: false Group: filter- Parameters:
idempotent
- the value to set- Returns:
- the dsl builder
-
idempotentKey
To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
idempotentKey
- the value to set- Returns:
- the dsl builder
-
idempotentRepository
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder idempotentRepository(org.apache.camel.spi.IdempotentRepository idempotentRepository) A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true. The option is a: <code>org.apache.camel.spi.IdempotentRepository</code> type. Group: filter- Parameters:
idempotentRepository
- the value to set- Returns:
- the dsl builder
-
idempotentRepository
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder idempotentRepository(String idempotentRepository) A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true. The option will be converted to a <code>org.apache.camel.spi.IdempotentRepository</code> type. Group: filter- Parameters:
idempotentRepository
- the value to set- Returns:
- the dsl builder
-
include
Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
include
- the value to set- Returns:
- the dsl builder
-
includeExt
Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
includeExt
- the value to set- Returns:
- the dsl builder
-
maxDepth
The maximum depth to traverse when recursively processing a directory. The option is a: <code>int</code> type. Default: 2147483647 Group: filter- Parameters:
maxDepth
- the value to set- Returns:
- the dsl builder
-
maxDepth
The maximum depth to traverse when recursively processing a directory. The option will be converted to a <code>int</code> type. Default: 2147483647 Group: filter- Parameters:
maxDepth
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll) To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards. The option is a: <code>int</code> type. Group: filter- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll) To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards. The option will be converted to a <code>int</code> type. Group: filter- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
minDepth
The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. The option is a: <code>int</code> type. Group: filter- Parameters:
minDepth
- the value to set- Returns:
- the dsl builder
-
minDepth
The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. The option will be converted to a <code>int</code> type. Group: filter- Parameters:
minDepth
- the value to set- Returns:
- the dsl builder
-
move
Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
move
- the value to set- Returns:
- the dsl builder
-
exclusiveReadLockStrategy
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder exclusiveReadLockStrategy(org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<org.apache.camel.component.file.remote.SftpRemoteFile> exclusiveReadLockStrategy) Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. The option is a: <code>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<org.apache.camel.component.file.remote.SftpRemoteFile></code> type. Group: lock- Parameters:
exclusiveReadLockStrategy
- the value to set- Returns:
- the dsl builder
-
exclusiveReadLockStrategy
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder exclusiveReadLockStrategy(String exclusiveReadLockStrategy) Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. The option will be converted to a <code>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<org.apache.camel.component.file.remote.SftpRemoteFile></code> type. Group: lock- Parameters:
exclusiveReadLockStrategy
- the value to set- Returns:
- the dsl builder
-
readLock
Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan. The option is a: <code>java.lang.String</code> type. Default: none Group: lock- Parameters:
readLock
- the value to set- Returns:
- the dsl builder
-
readLockCheckInterval
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockCheckInterval(long readLockCheckInterval) Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option is a: <code>long</code> type. Default: 1000 Group: lock- Parameters:
readLockCheckInterval
- the value to set- Returns:
- the dsl builder
-
readLockCheckInterval
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockCheckInterval(String readLockCheckInterval) Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option will be converted to a <code>long</code> type. Default: 1000 Group: lock- Parameters:
readLockCheckInterval
- the value to set- Returns:
- the dsl builder
-
readLockDeleteOrphanLockFiles
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockDeleteOrphanLockFiles(boolean readLockDeleteOrphanLockFiles) Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory. The option is a: <code>boolean</code> type. Default: true Group: lock- Parameters:
readLockDeleteOrphanLockFiles
- the value to set- Returns:
- the dsl builder
-
readLockDeleteOrphanLockFiles
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockDeleteOrphanLockFiles(String readLockDeleteOrphanLockFiles) Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory. The option will be converted to a <code>boolean</code> type. Default: true Group: lock- Parameters:
readLockDeleteOrphanLockFiles
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseAsync
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseAsync(boolean readLockIdempotentReleaseAsync) Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option. The option is a: <code>boolean</code> type. Default: false Group: lock- Parameters:
readLockIdempotentReleaseAsync
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseAsync
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseAsync(String readLockIdempotentReleaseAsync) Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a <code>boolean</code> type. Default: false Group: lock- Parameters:
readLockIdempotentReleaseAsync
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseAsyncPoolSize
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseAsyncPoolSize(int readLockIdempotentReleaseAsyncPoolSize) The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option. The option is a: <code>int</code> type. Group: lock- Parameters:
readLockIdempotentReleaseAsyncPoolSize
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseAsyncPoolSize
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseAsyncPoolSize(String readLockIdempotentReleaseAsyncPoolSize) The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a <code>int</code> type. Group: lock- Parameters:
readLockIdempotentReleaseAsyncPoolSize
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseDelay
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseDelay(int readLockIdempotentReleaseDelay) Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true. The option is a: <code>int</code> type. Group: lock- Parameters:
readLockIdempotentReleaseDelay
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseDelay
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseDelay(String readLockIdempotentReleaseDelay) Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true. The option will be converted to a <code>int</code> type. Group: lock- Parameters:
readLockIdempotentReleaseDelay
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseExecutorService
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseExecutorService(ScheduledExecutorService readLockIdempotentReleaseExecutorService) To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: lock- Parameters:
readLockIdempotentReleaseExecutorService
- the value to set- Returns:
- the dsl builder
-
readLockIdempotentReleaseExecutorService
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockIdempotentReleaseExecutorService(String readLockIdempotentReleaseExecutorService) To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: lock- Parameters:
readLockIdempotentReleaseExecutorService
- the value to set- Returns:
- the dsl builder
-
readLockLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockLoggingLevel(org.apache.camel.LoggingLevel readLockLoggingLevel) Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: lock- Parameters:
readLockLoggingLevel
- the value to set- Returns:
- the dsl builder
-
readLockLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockLoggingLevel(String readLockLoggingLevel) Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: lock- Parameters:
readLockLoggingLevel
- the value to set- Returns:
- the dsl builder
-
readLockMarkerFile
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockMarkerFile(boolean readLockMarkerFile) Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application. The option is a: <code>boolean</code> type. Default: true Group: lock- Parameters:
readLockMarkerFile
- the value to set- Returns:
- the dsl builder
-
readLockMarkerFile
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockMarkerFile(String readLockMarkerFile) Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application. The option will be converted to a <code>boolean</code> type. Default: true Group: lock- Parameters:
readLockMarkerFile
- the value to set- Returns:
- the dsl builder
-
readLockMinAge
This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age. The option is a: <code>long</code> type. Default: 0 Group: lock- Parameters:
readLockMinAge
- the value to set- Returns:
- the dsl builder
-
readLockMinAge
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockMinAge(String readLockMinAge) This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age. The option will be converted to a <code>long</code> type. Default: 0 Group: lock- Parameters:
readLockMinAge
- the value to set- Returns:
- the dsl builder
-
readLockMinLength
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockMinLength(long readLockMinLength) This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. The option is a: <code>long</code> type. Default: 1 Group: lock- Parameters:
readLockMinLength
- the value to set- Returns:
- the dsl builder
-
readLockMinLength
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockMinLength(String readLockMinLength) This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. The option will be converted to a <code>long</code> type. Default: 1 Group: lock- Parameters:
readLockMinLength
- the value to set- Returns:
- the dsl builder
-
readLockRemoveOnCommit
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockRemoveOnCommit(boolean readLockRemoveOnCommit) This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option. The option is a: <code>boolean</code> type. Default: false Group: lock- Parameters:
readLockRemoveOnCommit
- the value to set- Returns:
- the dsl builder
-
readLockRemoveOnCommit
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockRemoveOnCommit(String readLockRemoveOnCommit) This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a <code>boolean</code> type. Default: false Group: lock- Parameters:
readLockRemoveOnCommit
- the value to set- Returns:
- the dsl builder
-
readLockRemoveOnRollback
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockRemoveOnRollback(boolean readLockRemoveOnRollback) This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit). The option is a: <code>boolean</code> type. Default: true Group: lock- Parameters:
readLockRemoveOnRollback
- the value to set- Returns:
- the dsl builder
-
readLockRemoveOnRollback
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockRemoveOnRollback(String readLockRemoveOnRollback) This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit). The option will be converted to a <code>boolean</code> type. Default: true Group: lock- Parameters:
readLockRemoveOnRollback
- the value to set- Returns:
- the dsl builder
-
readLockTimeout
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockTimeout(long readLockTimeout) Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option is a: <code>long</code> type. Default: 10000 Group: lock- Parameters:
readLockTimeout
- the value to set- Returns:
- the dsl builder
-
readLockTimeout
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder readLockTimeout(String readLockTimeout) Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option will be converted to a <code>long</code> type. Default: 10000 Group: lock- Parameters:
readLockTimeout
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
repeatCount
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder startScheduler(String startScheduler) Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
ciphers
Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
ciphers
- the value to set- Returns:
- the dsl builder
-
keyExchangeProtocols
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder keyExchangeProtocols(String keyExchangeProtocols) Set a comma separated list of key exchange protocols that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: 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. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
keyExchangeProtocols
- the value to set- Returns:
- the dsl builder
-
keyPair
Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification. The option is a: <code>java.security.KeyPair</code> type. Group: security- Parameters:
keyPair
- the value to set- Returns:
- the dsl builder
-
keyPair
Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification. The option will be converted to a <code>java.security.KeyPair</code> type. Group: security- Parameters:
keyPair
- the value to set- Returns:
- the dsl builder
-
knownHosts
Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification. The option is a: <code>byte[]</code> type. Group: security- Parameters:
knownHosts
- the value to set- Returns:
- the dsl builder
-
knownHosts
Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification. The option will be converted to a <code>byte[]</code> type. Group: security- Parameters:
knownHosts
- the value to set- Returns:
- the dsl builder
-
knownHostsFile
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder knownHostsFile(String knownHostsFile) Sets the known_hosts file, so that the SFTP endpoint can do host key verification. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
knownHostsFile
- the value to set- Returns:
- the dsl builder
-
knownHostsUri
Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
knownHostsUri
- the value to set- Returns:
- the dsl builder
-
password
Password to use for login. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
preferredAuthentications
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder preferredAuthentications(String preferredAuthentications) Set the preferred authentications which SFTP endpoint will used. Some example include:password,publickey. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
preferredAuthentications
- the value to set- Returns:
- the dsl builder
-
privateKey
Set the private key as byte so that the SFTP endpoint can do private key verification. The option is a: <code>byte[]</code> type. Group: security- Parameters:
privateKey
- the value to set- Returns:
- the dsl builder
-
privateKey
Set the private key as byte so that the SFTP endpoint can do private key verification. The option will be converted to a <code>byte[]</code> type. Group: security- Parameters:
privateKey
- the value to set- Returns:
- the dsl builder
-
privateKeyFile
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder privateKeyFile(String privateKeyFile) Set the private key file so that the SFTP endpoint can do private key verification. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
privateKeyFile
- the value to set- Returns:
- the dsl builder
-
privateKeyPassphrase
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder privateKeyPassphrase(String privateKeyPassphrase) Set the private key file passphrase so that the SFTP endpoint can do private key verification. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
privateKeyPassphrase
- the value to set- Returns:
- the dsl builder
-
privateKeyUri
Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
privateKeyUri
- the value to set- Returns:
- the dsl builder
-
publicKeyAcceptedAlgorithms
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder publicKeyAcceptedAlgorithms(String publicKeyAcceptedAlgorithms) Set a comma separated list of public key accepted algorithms. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
publicKeyAcceptedAlgorithms
- the value to set- Returns:
- the dsl builder
-
serverHostKeys
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder serverHostKeys(String serverHostKeys) Set a comma separated list of algorithms supported for the server host key. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
serverHostKeys
- the value to set- Returns:
- the dsl builder
-
strictHostKeyChecking
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder strictHostKeyChecking(String strictHostKeyChecking) Sets whether to use strict host key checking. The option is a: <code>java.lang.String</code> type. Default: no Group: security- Parameters:
strictHostKeyChecking
- the value to set- Returns:
- the dsl builder
-
username
Username to use for login. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
username
- the value to set- Returns:
- the dsl builder
-
useUserKnownHostsFile
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder useUserKnownHostsFile(boolean useUserKnownHostsFile) If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts. The option is a: <code>boolean</code> type. Default: true Group: security- Parameters:
useUserKnownHostsFile
- the value to set- Returns:
- the dsl builder
-
useUserKnownHostsFile
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder useUserKnownHostsFile(String useUserKnownHostsFile) If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts. The option will be converted to a <code>boolean</code> type. Default: true Group: security- Parameters:
useUserKnownHostsFile
- the value to set- Returns:
- the dsl builder
-
shuffle
To shuffle the list of files (sort in random order). The option is a: <code>boolean</code> type. Default: false Group: sort- Parameters:
shuffle
- the value to set- Returns:
- the dsl builder
-
shuffle
To shuffle the list of files (sort in random order). The option will be converted to a <code>boolean</code> type. Default: false Group: sort- Parameters:
shuffle
- the value to set- Returns:
- the dsl builder
-
sortBy
Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. The option is a: <code>java.lang.String</code> type. Group: sort- Parameters:
sortBy
- the value to set- Returns:
- the dsl builder
-
sorter
default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder sorter(Comparator<org.apache.camel.component.file.GenericFile<org.apache.camel.component.file.remote.SftpRemoteFile>> sorter) Pluggable sorter as a java.util.Comparator class. The option is a: <code>java.util.Comparator<org.apache.camel.component.file.GenericFile<org.apache.camel.component.file.remote.SftpRemoteFile>></code> type. Group: sort- Parameters:
sorter
- the value to set- Returns:
- the dsl builder
-
sorter
Pluggable sorter as a java.util.Comparator class. The option will be converted to a <code>java.util.Comparator<org.apache.camel.component.file.GenericFile<org.apache.camel.component.file.remote.SftpRemoteFile>></code> type. Group: sort- Parameters:
sorter
- the value to set- Returns:
- the dsl builder
-