[CONF] Apache Camel > FTP2

[confluence]

FTP2 Page edited by Claus Ibsen FTP/SFTP/FTPS Component - Camel 2.0 onwards This component provides access to remote file systems over the FTP and SFTP protocols. Using Camel 1.x If you are using Camel 1.x then see this link for documentation. This page is only for Camel 2.0 or newer. Using FTPS The FTPS component is only available in Camel 2.2 or newer. FTPS (also known as FTP Secure) is an extension to FTP that adds support for the Transport Layer Security (TLS) and the Secure Sockets Layer (SSL) cryptographic protocols. URI format ftp://[usern...@]hostname[:port]/directoryname[?options] sftp://[usern...@]hostname[:port]/directoryname[?options] ftps://[usern...@]hostname[:port]/directoryname[?options] Where directoryname represents the underlying 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, ftps = 2222). You can append query options to the URI in the following format, ?option=value&option=value&... URI Options The options below are exclusive for the FTP2 component. Name Default Value Description password null Specifies the password to use to log in to the remote file system. binary false Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). 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 is beneficial, if you consume a very big remote file and thus can conserve memory. See below for more details. passiveMode false FTP and FTPS only: Specifies whether to use passive mode connections. Default is active mode (false). securityProtocol TLS FTPS only: Sets the underlying security protocol. The following values are defined: TLS: Transport Layer Security SSL: Secure Sockets Layer isImplicit false FTPS only: Sets the security mode(implicit/explicit). Default is explicit (false). 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. strictHostKeyChecking no SFTP only: Camel 2.2: Sets whether to use strict host key checking. Possible values are: no, yes and ask. ask does not make sense to use as Camel cannot answer the question for you as its meant for human intervention. Note: The default in Camel 2.1 and below was ask. maximumReconnectAttempts 3 Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. reconnectDelay 1000 Delay in millis Camel will wait before performing a reconnect attempt. ftpClient null FTP and FTPS Only: Camel 2.1: Allows you to use a custom org.apache.commons.net.ftp.FTPClient instance. ftpClientConfig null FTP and FTPS Only: Camel 2.1: Allows you to use a custom org.apache.commons.net.ftp.FTPClientConfig instance. ftpClient.trustStore.file null FTPS Only: Sets the trust store file, so that the FTPS client can look up for trusted certificates. ftpClient.trustStore.type JKS FTPS Only: Sets the trust store type. ftpClient.trustStore.algorithm SunX509 FTPS Only: Sets the trust store algorithm. ftpClient.trustStore.password null FTPS Only: Sets the trust store password. ftpClient.keyStore.file null FTPS Only: Sets the key store file, so that the FTPS client can look up for the private certificate. ftpClient.keyStore.type JKS FTPS Only: Sets the key store type. ftpClient.keyStore.algorithm SunX509 FTPS Only: Sets the key store algorithm. ftpClient.keyStore.password null FTPS Only: Sets the key store password. ftpClient.keyStore.keyPassword null FTPS Only: Sets the private key password. FTPS component default trust store By default, the FTPS component trust store accept all certificates. If you only want trust selective certificates, you have to configure the trust store with the ftpClient.trustStore.xxx options or by configuring a custom ftpClient. You can configure additional options on the ftpClient and ftpClientConfig from the URI directly by using the ftpClient. or ftpClientConfig. prefix. For example to set the setDataTimeout on the FTPClient to 30 seconds you can do: from("ftp://f...@myserver?password=secret&ftpClient.dataTimeout=30000").to("bean:foo"); You can mix and match and have use both prefixes, for example to configure date format or timezones. from("ftp://f...@myserver?password=secret&ftpClient.dataTimeout=30000&ftpClientConfig.serverLanguageCode=fr").to("bean:foo"); You can have as many of these options as you like. See the documentation of the Apache Commons FTP FTPClientConfig for possible options and more details. And as well for Apache Commons FTP FTPClient. If you do not like having many and long configuration in the url you can refer to the ftpClient or ftpClientConfig to use by letting Camel lookup in the Registry for it. For example: <bean id="myConfig" class="org.apache.commons.net.ftp.FTPClientConfig"> <property name="lenientFutureDates" value="true"/> <property name="serverLanguageCode" value="fr"/> </bean> And then let Camel lookup this bean when you use the # notation in the url. from("ftp://f...@myserver?password=secret&ftpClientConfig=#myConfig").to("bean:foo"); More URI options See File2 as all the options there also applies for this component. Examples ftp://some...@someftpserver.com/public/upload/images/holiday2008?password=secret&binary=true ftp://someonee...@someotherftpserver.co.uk:12049/reports/2008/password=secret&binary=false ftp://publicftpserver.com/download FTP Consumer does not support concurrency The FTP consumer (with the same endpoint) does not support concurrency (the backing FTP client is not thread safe). You can use multiple FTP consumers to poll from different endpoints. It is only a single endpoint that does not support concurrent consumers. The FTP producer does not have this issue, it supports concurrency. In the future we will add consumer pooling to Camel to allow this consumer to support concurrency as well. More information This component is an extension of the File2 component. So there are more samples and details on the File2 component page. Default when consuming files The FTP consumer will by default leave the consumed files untouched on the remote FTP server. You have to configure it explicit if you want it to delete the files or move them to another location. For example you can use delete=true to delete the files, or use move=.done to move the files into a hidden done sub directory. The regular File consumer is different as it will by default move files to a .camel sub directory. The reason Camel does not do this by default for the FTP consumer is that it may lack permissions by default to be able to move or delete files. 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 turned off by default, 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 to a temporary destination and move the file after it has been written. When moving files using move or preMove option the files are restricted to the FTP_ROOT folder. That prevents you from moving files outside the FTP area. If you want to move files to another area you can use soft links and move files into a soft linked folder. 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 the 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. CamelFileBatchIndex Current index out of total number of files being consumed in this batch. CamelFileBatchSize 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. Using Local Work Directory Camel supports consuming from remote FTP servers and downloading the files directly into a local work directory. This avoids reading the entire remote file content into memory as it is streamed directly into the local file using FileOutputStream. Camel will store to a local file with the same name as the remote file, though with .inprogress as extension while the file is being downloaded. Afterwards, the file is renamed to remove the .inprogress suffix. And finally, when the Exchange is complete the local file is deleted. So if you want to download files from a remote FTP server and store it as files then you need to route to a file endpoint such as: from("ftp://some...@someserver.com?password=secret&localWorkDirectory=/tmp").to("file://inbox"); Optimization by renaming work file The route above is ultra efficient as it avoids reading the entire file content into memory. It will download the remote file directly to a local file stream. The java.io.File handle is then used as the Exchange body. The file producer leverages this fact and can work directly on the work file java.io.File handle and perform a java.io.File.rename to the target filename. As Camel knows it's a local work file, it can optimize and use a rename instead of a file copy, as the work file is meant to be deleted anyway. Samples In the sample below we set up 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. protected RouteBuilder createRouteBuilder() throws Exception { return new RouteBuilder() { public void configure() throws Exception { // we use a delay of 60 minutes (eg. once pr. hour we poll the FTP server long delay = 60 * 60 * 1000L; // from the given FTP server we poll (= download) all the files // from the public/reports folder as BINARY types and store this as files // in a local directory. Camel will use the filenames from the FTPServer // notice that the FTPConsumer properties must be prefixed with "consumer." in the URL // the delay parameter is from the FileConsumer component so we should use consumer.delay as // the URI parameter name. The FTP Component is an extension of the File Component. from("ftp://sc...@localhost/public/reports?password=tiger&binary=true&consumer.delay=" + delay). to("file://target/test-reports"); } }; } And the route using Spring DSL: <route> <from uri="ftp://sc...@localhost/public/reports?password=tiger&amp;binary=true&amp;delay=60000"/> <to uri="file://target/test-reports"/> </route> Consuming a remote FTP server triggered by a route The FTP consumer is built as a scheduled consumer to be used in the from route. However, if you want to start consuming from an FTP server triggered within a route. Notice we use the Content Enricher EIP with the pollEnrich DSL to consume the FTP file: from("seda:start") // set the filename in FILE_NAME header so Camel know the name of the remote file to poll .setHeader(Exchange.FILE_NAME, header("myfile")) .pollEnrich("ftp://ad...@localhost:21/getme?password=admin&binary=false") .to("mock:result"); Consuming a remote FTPS server (implicit SSL) and client authentication from("ftps://ad...@localhost:2222/public/camel?password=admin&securityProtocol=SSL&isImplicit=true&ftpClient.keyStore.file=./src/test/resources/server.jks&ftpClient.keyStore.password=password&ftpClient.keyStore.keyPassword=password") .to("bean:foo"); Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration from("ftps://ad...@localhost:2222/public/camel?password=admin&ftpClient.trustStore.file=./src/test/resources/server.jks&ftpClient.trustStore.password=password") .to("bean:foo"); 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. public class MyFileFilter implements GenericFileFilter { public boolean accept(GenericFile file) { // we only want report files return file.getFileName().startsWith("report"); } } 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://someu...@someftpserver.com?password=secret&amp;filter=#myFilter"/> <to uri="bean:processInbox"/> </route> Filtering using ANT path matcher 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 reason is that we leverage Spring's AntPathMatcher to do the actual matching. The file paths are 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: <camelContext xmlns="http://camel.apache.org/schema/spring"> <template id="camelTemplate"/> <!-- use myFilter as filter to allow setting ANT paths for which files to scan for --> <endpoint id="myFTPEndpoint" uri="ftp://ad...@localhost:20123/antpath?password=admin&amp;recursive=true&amp;delay=10000&amp;initialDelay=2000&amp;filter=#myAntFilter"/> <route> <from ref="myFTPEndpoint"/> <to uri="mock:result"/> </route> </camelContext> <!-- we use the AntPathMatcherRemoteFileFilter to use ant paths for includes and exlucde --> <bean id="myAntFilter" class="org.apache.camel.component.file.AntPathMatcherGenericFileFilter"> <!-- include and file in the subfolder that has day in the name --> <property name="includes" value="**/subfolder/**/*day*"/> <!-- exclude all files with bad in name or .xml files. Use comma to seperate multiple excludes --> <property name="excludes" value="**/*bad*,**/*.xml"/> </bean> Debug logging This component has log level TRACE that can be helpful if you have problems. See Also Configuring Camel Component Endpoint Getting Started File2 Change Notification Preferences View Online | View Change | Add Comment