Page History

directory

true

indicates whether or not the given file name should be interpreted by default as a directory or file (as it sometimes hard to be sure with some FTP servers)

password

null

specifies the password to use to login to the remote file system

binary

false

specifies the file transfer mode BINARY or ASCII. Default is ASCII.

ftpClientConfig

null

Camel 1.5: Reference to a bean in the registry as a org.apache.commons.net.ftp.FTPClientConfig class. Use this option if you need to configure the client according to the FTP Server date format, locale, timezone, platform etc. See the javadoc FTPClientConfig for more documentation.

consumer.recursive

true/false

if a directory, will look for changes in files in all the sub directories. Is true as default for Camel 1.4 or older. Will change to false as default value as of Camel 1.5

consumer.setNames

false

Used by FTPConsumer. If set to true Camel will set the special filename header FileComponent.HEADER_FILE_NAME value to the filename from the FTP Server.
Note: In Camel 1.4 the default value has changed to true.

consumer.delay

500

Delay in millis between each poll

consumer.initialDelay

1000

Millis before polling starts

consumer.userFixedDelay

false

true to use fixed delay between pools, otherwise fixed rate is used. See ScheduledExecutorService in JDK for details.

consumer.regexPattern

null

Used by FTPConsumer. Regular expression to use for matching files when consuming.

consumer.exclusiveReadLock

false

Camel 1.5: Used by FTPConsumer. If set to true Camel will only poll the ftp files if it has exclusive read to the file (= the file is not in progress of being written). Camel will wait until it is granted, testing once every second. The test is implemented by Camel will try to rename the file. Setting to false Camel will poll the file even if its in progress of being written.

consumer.deleteFile

false

Camel 1.5: Used by FTPConsumer. Flag to set if the consumed file should be deleted after it has been downloaded.

consumer.moveNamePrefix

null

Camel 1.5: Used by FTPConsumer. The prefix String perpended to the filename when moving it. For example to move processed files into the done directory, set this value to 'done/'

consumer.moveNamePostfix

null

Camel 1.5: Used by FTPConsumer. The postfix String appended to the filename when moving it. For example to rename processed files from foo to foo.old set this value to '.old'

consumer.excludedNamePrefix

null

Camel 1.5: Used by FTPConsumer. Is used to exclude files if filename is starting with the given prefix.

consumer.excludedNamePostfix

null

Camel 1.5: Used by FTPConsumer. Is used to exclude files if filename is ending with the given postfix.

consumer.timestamp

false

Camel 1.5: @deprecated will be removed in Camel 2.0. This option is only for backwards comparability.

expression

null

Camel 1.5: Use expression to dynamically set the filename. This allows you to very easily set dynamic pattern style filenames. If an expression is set it take precedes over the org.apache.camel.file.name header. (Note: The header can itself also be an expression). The expression options supports both String and Expression types. If the expression is a String type then its always evaluated using the File Language. If the expression is an Expression type then this type is of course used as it - this allows for instance to use OGNL as expression too.

passiveMode

false

Camel 1.5.1/2.0: Set whether to use passive mode connections. Default is active. This feature is only for regular FTP, not SFTP.