FTP/SFTP Component
This component provides access to remote file systems over the FTP and SFTP protocols.
URI format
ftp://[username@]hostname[:port]/filename[?options] sftp://[username@]hostname[:port]/filename[?options]
Where filename represents the underlying file name or directory. Can contain nested folders.
The username is currently only possible to provide in the hostname parameter.
If no username is provided then anonymous
login is attempted using no password.
If no port number is provided. Camel will provide default values according to the protocol. (ftp = 21, sftp = 22)
Examples
ftp://someone@someftpserver.com/public/upload/images/holiday2008?password=secret&binary=true
ftp://someoneelse@someotherftpserver.co.uk:12049/reports/2008/budget.txt?password=secret&binary=false&directory=false
ftp://publicftpserver.com/download
More information
URI Options
The options below are exclusive for the FTP2 component.
Name |
Default Value |
Description |
---|---|---|
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. |
passiveMode |
false |
FTP only: Set whether to use passive mode connections. Default is active. |
localWorkDirectory |
null |
When consuming a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This benefits if you consume very big remote file and thus can preserve memory usage. Another benefit is if your want to route to a file producer, then Camel will be able to leverage the local work directory and work on the java.io.File handle directly. So if you want to download big files and store it in files, then use this option. Camel will delete the temporary local file in the local work directory when the Exchange is completed. |
ftpClientConfig |
null |
FTP only: Reference to a bean in the registry as a |
knownHostsFile |
null |
SFTP only: Sets the known_hosts file so that the SFTP endpoint can do host key verification. |
privateKeyFile |
null |
SFTP only: Set the private key file to that the SFTP endpoint can do private key verification. |
privateKeyFilePassphrase |
null |
SFTP only: Set the private key file passphrase to that the SFTP endpoint can do private key verification. |
More URI options
See File2 as all the options there also applies for this component.
limitations
The option readLock can be used to force Camel not to consume files that is currently in the progress of being written. However this option is default turned off, as it requires that the user has write access. There are other solutions to avoid consuming files that are currently being written over FTP, for instance you can write the a temporary destination and move the file after it has been written.
The ftp producer does not support appending, to existing files. Any existing files on the remote server will be deleted before the file is written.
Message Headers
The following message headers can be used to affect the behavior of the component
Header |
Description |
---|---|
CamelFileName |
Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either then a generated message Id is used as filename instead. |
CamelFileNameProduced |
The actual absolute filepath (path + name) for the output file that was written. This header is set by Camel and its purpose is providing end-users the name of the file that was written. |
CamelFileBatchTotal |
Current index out of total number of files being consumed in this batch. |
CamelFileBatchIndex |
Total number of files being consumed in this batch. |
CamelFileHost |
The remote hostname. |
CamelFileLocalWorkPath |
Path to the local work file, if local work directory is used. |
Sample
In the sample below we setup Camel to download all the reports from the FTP server once every hour (60 min) as BINARY content and store it as files on the local file system.
And the route using Spring DSL:
<route> <from uri="ftp://scott@localhost/public/reports?password=tiger&binary=true&delay=60000"/> <to uri="file://target/test-reports"/> </route>
Consuming a remote FTP server triggered by a route
The FTP consumer is build as a scheduled consumer to be used in the from route. However if you want to start consuming from a FTP server triggered within a route it's a bit cumbersome to do this in Camel 1.x (we plan to improve this in Camel 2.x). However it's possible as this code below demonstrates.
In the sample we have a SEDA queue where a message arrives that holds a message containing a filename to poll from a remote FTP server. So we setup a basic FTP url as:
And then we have the route where we use Processor within the route so we can use Java code. In this Java code we create the ftp consumer that downloads the file we want. And after the download we can get the content of the file and put it in the original exchange that continues being routed. As this is based on an unit test it routes to a Mock endpoint.
Using Local Work Directory
TODO:
Filter using org.apache.camel.component.file.GenericFileFilter
Camel supports pluggable filtering strategies. This strategy it to use the build in org.apache.camel.component.file.GenericFileFilter
in Java. You can then configure the endpoint with such a filter to skip certain filters before being processed.
In the sample we have build our own filter that only accepts files starting with report in the filename.
And then we can configure our route using the filter attribute to reference our filter (using # notation) that we have defines in the spring XML file:
<!-- define our sorter as a plain spring bean --> <bean id="myFilter" class="com.mycompany.MyFileFilter"/> <route> <from uri="ftp://someuser@someftpserver.com?password=secret&filter=#myFilter"/> <to uri="bean:processInbox"/> </route>
Filtering using ANT path matcher
Available in Camel 2.0
The ANT path matcher is a filter that is shipped out-of-the-box in the camel-spring jar. So you need to depend on camel-spring if you are using Maven.
The reasons is that we leverage Spring's AntPathMatcher to do the actual matching.
The file paths is matched with the following rules:
?
matches one character*
matches zero or more characters**
matches zero or more directories in a path
The sample below demonstrates how to use it:
Debug logging
This component has log level TRACE that can be helpful if you have problems.