FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

FtpEndpointBuilderFactory.FtpEndpointBuilder

Enclosing interface:

FtpEndpointBuilderFactory
```
public static interface FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the FTP component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`account(String account)` Account to use for login.
`default FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder`	`advanced()`
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`antExclude(String antExclude)` Ant style filter exclusion.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`antFilterCaseSensitive(boolean antFilterCaseSensitive)` Sets case sensitive flag on ant filter.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`antFilterCaseSensitive(String antFilterCaseSensitive)` Sets case sensitive flag on ant filter.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`antInclude(String antInclude)` Ant style filter inclusion.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`binary(boolean binary)` Specifies the file transfer mode, BINARY or ASCII.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`binary(String binary)` Specifies the file transfer mode, BINARY or ASCII.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`bridgeErrorHandler(String bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`charset(String charset)` This option is used to specify the encoding of the file.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`delete(boolean delete)` If true, the file will be deleted after it is processed successfully.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`delete(String delete)` If true, the file will be deleted after it is processed successfully.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`disconnect(boolean disconnect)` Whether or not to disconnect from remote FTP server right after use.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`disconnect(String disconnect)` Whether or not to disconnect from remote FTP server right after use.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`doneFileName(String doneFileName)` Producer: If provided, then Camel will write a 2nd done file when the original file has been written.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`eagerMaxMessagesPerPoll(boolean eagerMaxMessagesPerPoll)` Allows for controlling whether the limit from maxMessagesPerPoll is eager or not.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`eagerMaxMessagesPerPoll(String eagerMaxMessagesPerPoll)` Allows for controlling whether the limit from maxMessagesPerPoll is eager or not.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`exclude(String exclude)` Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`excludeExt(String excludeExt)` Is used to exclude files matching file extension name (case insensitive).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`exclusiveReadLockStrategy(Object exclusiveReadLockStrategy)` Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`exclusiveReadLockStrategy(String exclusiveReadLockStrategy)` Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`fileName(org.apache.camel.Expression fileName)` Use Expression such as File Language to dynamically set the filename.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`fileName(String fileName)` Use Expression such as File Language to dynamically set the filename.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`filter(Object filter)` Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`filter(String filter)` Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`filterDirectory(org.apache.camel.Predicate filterDirectory)` Filters the directory based on Simple language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`filterDirectory(String filterDirectory)` Filters the directory based on Simple language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`filterFile(org.apache.camel.Predicate filterFile)` Filters the file based on Simple language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`filterFile(String filterFile)` Filters the file based on Simple language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`idempotent(Boolean idempotent)` Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`idempotent(String idempotent)` Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`idempotentKey(org.apache.camel.Expression idempotentKey)` To use a custom idempotent key.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`idempotentKey(String idempotentKey)` To use a custom idempotent key.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`idempotentRepository(org.apache.camel.spi.IdempotentRepository idempotentRepository)` A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`idempotentRepository(String idempotentRepository)` A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`include(String include)` Is used to include files, if filename matches the regex pattern (matching is case in-sensitive).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`includeExt(String includeExt)` Is used to include files matching file extension name (case insensitive).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`maxDepth(int maxDepth)` The maximum depth to traverse when recursively processing a directory.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`maxDepth(String maxDepth)` The maximum depth to traverse when recursively processing a directory.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` To define a maximum messages to gather per poll.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` To define a maximum messages to gather per poll.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`minDepth(int minDepth)` The minimum depth to start processing when recursively processing a directory.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`minDepth(String minDepth)` The minimum depth to start processing when recursively processing a directory.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`move(org.apache.camel.Expression move)` Expression (such as Simple Language) used to dynamically set the filename when moving it after processing.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`move(String move)` Expression (such as Simple Language) used to dynamically set the filename when moving it after processing.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`moveFailed(org.apache.camel.Expression moveFailed)` Sets the move failure expression based on Simple language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`moveFailed(String moveFailed)` Sets the move failure expression based on Simple language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`noop(boolean noop)` If true, the file is not moved or deleted in any way.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`noop(String noop)` If true, the file is not moved or deleted in any way.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`passiveMode(boolean passiveMode)` Sets passive mode connections.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`passiveMode(String passiveMode)` Sets passive mode connections.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`password(String password)` Password to use for login.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`preMove(org.apache.camel.Expression preMove)` Expression (such as File Language) used to dynamically set the filename when moving it before processing.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`preMove(String preMove)` Expression (such as File Language) used to dynamically set the filename when moving it before processing.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`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.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`preSort(String 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.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLock(String readLock)` Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockCheckInterval(long readLockCheckInterval)` Interval in millis for the read-lock, if supported by the read lock.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockCheckInterval(String readLockCheckInterval)` Interval in millis for the read-lock, if supported by the read lock.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`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).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`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).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockLoggingLevel(org.apache.camel.LoggingLevel readLockLoggingLevel)` Logging level used when a read lock could not be acquired.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockLoggingLevel(String readLockLoggingLevel)` Logging level used when a read lock could not be acquired.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockMarkerFile(boolean readLockMarkerFile)` Whether to use marker file with the changed, rename, or exclusive read lock types.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockMarkerFile(String readLockMarkerFile)` Whether to use marker file with the changed, rename, or exclusive read lock types.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockMinAge(long readLockMinAge)` This option is applied only for readLock=changed.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockMinAge(String readLockMinAge)` This option is applied only for readLock=changed.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockMinLength(long readLockMinLength)` This option is applied only for readLock=changed.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockMinLength(String readLockMinLength)` This option is applied only for readLock=changed.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockRemoveOnCommit(boolean readLockRemoveOnCommit)` This option is applied only for readLock=idempotent.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockRemoveOnCommit(String readLockRemoveOnCommit)` This option is applied only for readLock=idempotent.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockRemoveOnRollback(boolean readLockRemoveOnRollback)` This option is applied only for readLock=idempotent.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockRemoveOnRollback(String readLockRemoveOnRollback)` This option is applied only for readLock=idempotent.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockTimeout(long readLockTimeout)` Optional timeout in millis for the read-lock, if supported by the read-lock.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`readLockTimeout(String readLockTimeout)` Optional timeout in millis for the read-lock, if supported by the read-lock.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`recursive(boolean recursive)` If a directory, will look for files in all the sub-directories as well.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`recursive(String recursive)` If a directory, will look for files in all the sub-directories as well.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`resumeDownload(boolean resumeDownload)` Configures whether resume download is enabled.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`resumeDownload(String resumeDownload)` Configures whether resume download is enabled.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`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.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`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.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`separator(FtpEndpointBuilderFactory.PathSeparator separator)` Sets the path separator to be used.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`separator(String separator)` Sets the path separator to be used.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`shuffle(boolean shuffle)` To shuffle the list of files (sort in random order).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`shuffle(String shuffle)` To shuffle the list of files (sort in random order).
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`sortBy(Comparator<org.apache.camel.Exchange> sortBy)` Built-in sort by using the File Language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`sortBy(String sortBy)` Built-in sort by using the File Language.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`sorter(Comparator<Object> sorter)` Pluggable sorter as a java.util.Comparator class.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`sorter(String sorter)` Pluggable sorter as a java.util.Comparator class.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`streamDownload(boolean streamDownload)` Sets the download method to use when not using a local working directory.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`streamDownload(String streamDownload)` Sets the download method to use when not using a local working directory.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`transferLoggingIntervalSeconds(int transferLoggingIntervalSeconds)` Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`transferLoggingIntervalSeconds(String transferLoggingIntervalSeconds)` Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`transferLoggingLevel(org.apache.camel.LoggingLevel transferLoggingLevel)` Configure the logging level to use when logging the progress of upload and download operations.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`transferLoggingLevel(String transferLoggingLevel)` Configure the logging level to use when logging the progress of upload and download operations.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`transferLoggingVerbose(boolean transferLoggingVerbose)` Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`transferLoggingVerbose(String transferLoggingVerbose)` Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder`	`username(String username)` Username to use for login.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder advanced()
```
  - binary
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder binary(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder binary(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder charset(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder disconnect(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder disconnect(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder doneFileName(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder fileName(org.apache.camel.Expression 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>org.apache.camel.Expression</code> type. Group: common
    
    Parameters:
    
    fileName - the value to set
    
    Returns:
    
    the dsl builder
  - fileName
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder fileName(String 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 will be converted to a <code>org.apache.camel.Expression</code> type. Group: common
    
    Parameters:
    
    fileName - the value to set
    
    Returns:
    
    the dsl builder
  - passiveMode
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder passiveMode(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder passiveMode(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder separator(FtpEndpointBuilderFactory.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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder separator(String 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
  - transferLoggingIntervalSeconds
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder transferLoggingIntervalSeconds(int transferLoggingIntervalSeconds)
```
    Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. The option is a: <code>int</code> type. Default: 5 Group: common
    
    Parameters:
    
    transferLoggingIntervalSeconds - the value to set
    
    Returns:
    
    the dsl builder
  - transferLoggingIntervalSeconds
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder transferLoggingIntervalSeconds(String transferLoggingIntervalSeconds)
```
    Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time. The option will be converted to a <code>int</code> type. Default: 5 Group: common
    
    Parameters:
    
    transferLoggingIntervalSeconds - the value to set
    
    Returns:
    
    the dsl builder
  - transferLoggingLevel
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder transferLoggingLevel(org.apache.camel.LoggingLevel transferLoggingLevel)
```
    Configure the logging level to use when logging the progress of upload and download operations. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: common
    
    Parameters:
    
    transferLoggingLevel - the value to set
    
    Returns:
    
    the dsl builder
  - transferLoggingLevel
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder transferLoggingLevel(String transferLoggingLevel)
```
    Configure the logging level to use when logging the progress of upload and download operations. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: common
    
    Parameters:
    
    transferLoggingLevel - the value to set
    
    Returns:
    
    the dsl builder
  - transferLoggingVerbose
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder transferLoggingVerbose(boolean transferLoggingVerbose)
```
    Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    transferLoggingVerbose - the value to set
    
    Returns:
    
    the dsl builder
  - transferLoggingVerbose
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder transferLoggingVerbose(String transferLoggingVerbose)
```
    Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    transferLoggingVerbose - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - delete
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder delete(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder delete(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder moveFailed(org.apache.camel.Expression 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>org.apache.camel.Expression</code> type. Group: consumer
    
    Parameters:
    
    moveFailed - the value to set
    
    Returns:
    
    the dsl builder
  - moveFailed
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder moveFailed(String 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 will be converted to a <code>org.apache.camel.Expression</code> type. Group: consumer
    
    Parameters:
    
    moveFailed - the value to set
    
    Returns:
    
    the dsl builder
  - noop
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder noop(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder noop(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder preMove(org.apache.camel.Expression 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>org.apache.camel.Expression</code> type. Group: consumer
    
    Parameters:
    
    preMove - the value to set
    
    Returns:
    
    the dsl builder
  - preMove
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder preMove(String 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 will be converted to a <code>org.apache.camel.Expression</code> type. Group: consumer
    
    Parameters:
    
    preMove - the value to set
    
    Returns:
    
    the dsl builder
  - preSort
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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. 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder preSort(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder recursive(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder recursive(String 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
  - resumeDownload
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder resumeDownload(boolean resumeDownload)
```
    Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    resumeDownload - the value to set
    
    Returns:
    
    the dsl builder
  - resumeDownload
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder resumeDownload(String resumeDownload)
```
    Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    resumeDownload - the value to set
    
    Returns:
    
    the dsl builder
  - sendEmptyMessageWhenIdle
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder antExclude(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder antInclude(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder exclude(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder excludeExt(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder filter(Object 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.commons.net.ftp.FTPFile></code> type. Group: filter
    
    Parameters:
    
    filter - the value to set
    
    Returns:
    
    the dsl builder
  - filter
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder filter(String 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.commons.net.ftp.FTPFile></code> type. Group: filter
    
    Parameters:
    
    filter - the value to set
    
    Returns:
    
    the dsl builder
  - filterDirectory
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder filterDirectory(org.apache.camel.Predicate 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>org.apache.camel.Predicate</code> type. Group: filter
    
    Parameters:
    
    filterDirectory - the value to set
    
    Returns:
    
    the dsl builder
  - filterDirectory
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 will be converted to a <code>org.apache.camel.Predicate</code> type. Group: filter
    
    Parameters:
    
    filterDirectory - the value to set
    
    Returns:
    
    the dsl builder
  - filterFile
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder filterFile(org.apache.camel.Predicate 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>org.apache.camel.Predicate</code> type. Group: filter
    
    Parameters:
    
    filterFile - the value to set
    
    Returns:
    
    the dsl builder
  - filterFile
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder filterFile(String filterFile)
```
    Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000. The option will be converted to a <code>org.apache.camel.Predicate</code> type. Group: filter
    
    Parameters:
    
    filterFile - the value to set
    
    Returns:
    
    the dsl builder
  - idempotent
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder idempotent(Boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder idempotent(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder idempotentKey(org.apache.camel.Expression 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>org.apache.camel.Expression</code> type. Group: filter
    
    Parameters:
    
    idempotentKey - the value to set
    
    Returns:
    
    the dsl builder
  - idempotentKey
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder idempotentKey(String 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 will be converted to a <code>org.apache.camel.Expression</code> type. Group: filter
    
    Parameters:
    
    idempotentKey - the value to set
    
    Returns:
    
    the dsl builder
  - idempotentRepository
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder idempotentRepository(org.apache.camel.spi.IdempotentRepository idempotentRepository)
```
    A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder idempotentRepository(String idempotentRepository)
```
    A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder include(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder includeExt(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder maxDepth(int 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder maxDepth(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder minDepth(int 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder minDepth(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder move(org.apache.camel.Expression 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>org.apache.camel.Expression</code> type. Group: filter
    
    Parameters:
    
    move - the value to set
    
    Returns:
    
    the dsl builder
  - move
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder move(String 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 will be converted to a <code>org.apache.camel.Expression</code> type. Group: filter
    
    Parameters:
    
    move - the value to set
    
    Returns:
    
    the dsl builder
  - exclusiveReadLockStrategy
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder exclusiveReadLockStrategy(Object 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.commons.net.ftp.FTPFile></code> type. Group: lock
    
    Parameters:
    
    exclusiveReadLockStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - exclusiveReadLockStrategy
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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.commons.net.ftp.FTPFile></code> type. Group: lock
    
    Parameters:
    
    exclusiveReadLockStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - readLock
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder readLock(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
  - readLockLoggingLevel
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder readLockMinAge(long 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder delay(long 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder delay(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder greedy(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder greedy(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder initialDelay(long 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder initialDelay(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder repeatCount(long 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder repeatCount(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder scheduler(Object 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder scheduler(String 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 key
    
    value - the option value
    
    Returns:
    
    the dsl builder
  - schedulerProperties
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder schedulerProperties(Map values)
```
    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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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 FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder timeUnit(TimeUnit 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder timeUnit(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder useFixedDelay(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder useFixedDelay(String 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
  - account
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder account(String account)
```
    Account to use for login. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    account - the value to set
    
    Returns:
    
    the dsl builder
  - password
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder password(String 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
  - username
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder username(String 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
  - shuffle
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder shuffle(boolean 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder shuffle(String 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
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder sortBy(Comparator<org.apache.camel.Exchange> 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.util.Comparator<org.apache.camel.Exchange></code> type. Group: sort
    
    Parameters:
    
    sortBy - the value to set
    
    Returns:
    
    the dsl builder
  - sortBy
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder sortBy(String 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 will be converted to a <code>java.util.Comparator<org.apache.camel.Exchange></code> type. Group: sort
    
    Parameters:
    
    sortBy - the value to set
    
    Returns:
    
    the dsl builder
  - sorter
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder sorter(Comparator<Object> 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.commons.net.ftp.FTPFile>></code> type. Group: sort
    
    Parameters:
    
    sorter - the value to set
    
    Returns:
    
    the dsl builder
  - sorter
```
default FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder sorter(String 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.commons.net.ftp.FTPFile>></code> type. Group: sort
    
    Parameters:
    
    sorter - the value to set
    
    Returns:
    
    the dsl builder

Interface FtpEndpointBuilderFactory.FtpEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

binary

binary

charset

disconnect

disconnect

doneFileName

fileName

fileName

passiveMode

passiveMode

separator

separator

transferLoggingIntervalSeconds

transferLoggingIntervalSeconds

transferLoggingLevel

transferLoggingLevel

transferLoggingVerbose

transferLoggingVerbose

bridgeErrorHandler

bridgeErrorHandler

delete

delete

moveFailed

moveFailed

noop

noop

preMove

preMove

preSort

preSort

recursive

recursive

resumeDownload

resumeDownload

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

streamDownload

streamDownload

antExclude

antFilterCaseSensitive

antFilterCaseSensitive

antInclude

eagerMaxMessagesPerPoll

eagerMaxMessagesPerPoll

exclude

excludeExt

filter

filter

filterDirectory

filterDirectory

filterFile

filterFile

idempotent

idempotent

idempotentKey

idempotentKey

idempotentRepository

idempotentRepository

include

includeExt

maxDepth

maxDepth

maxMessagesPerPoll

maxMessagesPerPoll

minDepth

minDepth

move

move

exclusiveReadLockStrategy

exclusiveReadLockStrategy

readLock

readLockCheckInterval

readLockCheckInterval

readLockDeleteOrphanLockFiles