...
Name | Default Value | Description |
---|---|---|
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. |
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. |
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 | true | 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 (= this is the behavior of Camel 1.4). |
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. |
...
By default the file is only consumer if the file is not in the progress of being written.
The consumer will always skip any file which name starts with a dot, such as ".", ".camel", ".m2" or ".groovy"
.
The consumer recursive option will be changed from true to false as the default value. We don't feel that Camel out-of-the-box should recursive poll.
Message Headers
The following message headers is provided in the message.
...