Page History

h2. FTP/SFTP Component

This component provides access to remote file systems over the FTP and SFTP protocols.

h3. URI format

{code}
ftp://[username@]hostname[:port]/filename[?options]
sftp://[username@]hostname[:port]/filename[?options]
{code}

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)

h4. 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}}

{tip:title=More examplesinformation}
This component is an extension of the [File2] component. So there couldare be more samples and details on the [File2] component page as well.
{tip}

h3. URI Options
The options below are exclusive for the [FTP2] component. 
{div:class=confluenceTableSmall}
|| 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 | Set whether to use passive mode connections. Default is active. This feature is only for regular FTP, not SFTP. |
| ftpClientConfig | null | *FTP only*: Reference to a bean in the registry as a {{[org.apache.commons.net.ftp.FTPClientConfig|http://commons.apache.org/net/apidocs/org/apache/commons/net/ftp/FTPClientConfig.html]}} 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|http://commons.apache.org/net/apidocs/org/apache/commons/net/ftp/FTPClientConfig.html]}} for more documentation.
| 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. |
{div}

Common options:
TODO: Copy from File2


h3.See [File2] as all the options there also applies for this component.

h4. Limitation of Exclusive Read Lock in this component
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. 

h3. 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. |

h3. 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.
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-ftp/src/test/java/org/apache/camel/component/file/remote/FromFtpToBinarySampleTest.java}

And the route using Spring DSL:
{code:xml}
  <route>
     <from uri="ftp://scott@localhost/public/reports?password=tiger&amp;binary=true&amp;delay=60000"/>
     <to uri="file://target/test-reports"/>
  </route>
{code}

h4. 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:
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-ftp/src/test/java/org/apache/camel/component/file/remote/FromQueueThenConsumeFtpToMockTest.java}

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.
{snippet:id=e2|lang=java|url=camel/trunk/components/camel-ftp/src/test/java/org/apache/camel/component/file/remote/FromQueueThenConsumeFtpToMockTest.java}

h3. 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.
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-ftp/src/test/java/org/apache/camel/component/file/remote/FromFtpRemoteFileFilterTest.java}

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:
{code:xml}
   <!-- define our sorter as a plain spring bean -->
   <bean id="myFilter" class="com.mycompany.MyFileFilter"/>

  <route>
    <from uri="ftp://someuser@someftpserver.com?password=secret&amp;filter=#myFilter"/>
    <to uri="bean:processInbox"/>
  </route>
{code}

h4. 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|http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/util/AntPathMatcher.html] 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:
{snippet:id=example|lang=xml|url=camel/trunk/tests/camel-itest/src/test/resources/org/apache/camel/itest/ftp/SpringFileAntPathMatcherRemoteFileFilterTest-context.xml}

h3. Debug logging
This component has log level *TRACE* that can be helpful if you have problems.

{include:Endpoint See Also}
- [File2]