Repository: camel Updated Branches: refs/heads/master 7f9c85ebb -> 330487b4f
Added camel-ftp docs to gitbook Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/330487b4 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/330487b4 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/330487b4 Branch: refs/heads/master Commit: 330487b4f8fe65609f2896c60488cad973db81c0 Parents: 7f9c85e Author: Andrea Cosentino <anco...@gmail.com> Authored: Fri Mar 25 11:14:38 2016 +0100 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Fri Mar 25 11:14:38 2016 +0100 ---------------------------------------------------------------------- components/camel-ftp/src/main/docs/ftp.adoc | 823 +++++++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 824 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/330487b4/components/camel-ftp/src/main/docs/ftp.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/docs/ftp.adoc b/components/camel-ftp/src/main/docs/ftp.adoc new file mode 100644 index 0000000..ea72ae9 --- /dev/null +++ b/components/camel-ftp/src/main/docs/ftp.adoc @@ -0,0 +1,823 @@ +[[FTPComponent]] +FTP/SFTP/FTPS Component +~~~~~~~~~~~~~~~~~~~~~~~ + +This component provides access to remote file systems over the FTP and +SFTP protocols. + +Maven users will need to add the following dependency to their `pom.xml` +for this component: + +[source,xml] +----------------------------------------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-ftp</artifactId> + <version>x.x.x</version>See the documentation of the Apache Commons + <!-- use the same version as your Camel core version --> +</dependency> +----------------------------------------------------------------------- + +[Info] +==== +More options + +See link:file2.html[File] for more options as all the options from +link:file2.html[File] is inherited. + +==== + +[Info] +==== +Absolute paths + +Absolute path is *not* supported. + +*Camel 2.16* will translate absolute path to relative by trimming all +leading slashes from `directoryname`. There'll be WARN message printed +in the logs. + +==== + +[Tip] +==== +Consuming from remote FTP server + +Make sure you read the section titled _Default when consuming files_ +further below for details related to consuming files. + +==== + +[[FTP2-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +--------------------------------------------------------- +ftp://[username@]hostname[:port]/directoryname[?options] +sftp://[username@]hostname[:port]/directoryname[?options] +ftps://[username@]hostname[:port]/directoryname[?options] +--------------------------------------------------------- + +Where *directoryname* represents the underlying directory. The directory +name is a relative path. Absolute path's is *not* supported. The +relative path can contain nested folders, such as /inbox/us. + +For Camel versions before *Camel 2.16*, the directoryName *must* exist +already as this component does not support the `autoCreate` option +(which the file component does). The reason is that its the FTP +administrator (FTP server) task to properly setup user accounts, and +home directories with the right file permissions etc. + +For *Camel 2.16*, `autoCreate` option is supported. When consumer +starts, before polling is scheduled, there's additional FTP operation +performed to create the directory configured for endpoint. The default +value for `autoCreate` is `true`. + +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&...` + +This component uses two different libraries for the actual FTP work. FTP +and FTPS uses http://commons.apache.org/net/[Apache Commons Net] while +SFTP uses http://www.jcraft.com/jsch/[JCraft JSCH]. + +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. + +[[FTP2-URIOptions]] +URI Options +^^^^^^^^^^^ + +The options below are exclusive for the FTP component. + +[Info] +==== +More options + +See link:file2.html[File] for more options as all the options from +link:file2.html[File] is inherited. + +==== + +// component options: START +The FTP component has no options. +// component options: END + +// endpoint options: START +The FTP component supports 100 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| host | common | | String | *Required* Hostname of the FTP server +| port | common | | int | Port of the FTP server +| directoryName | common | | String | The starting directory +| binary | common | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false). +| charset | common | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. +| disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. +| download | common | false | boolean | Whether the FTP consumer should download the file. If this option is set to false then the message body will be null but the consumer will still trigger a Camel Exchange that has details about the file such as file name file size etc. It's just that the file will not be downloaded. +| fastExistsCheck | common | false | boolean | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files. +| fileName | common | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to te mporary store CamelFileName and have to restore it afterwards. +| maximumReconnectAttempts | common | | int | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. +| passiveMode | common | false | boolean | Sets passive mode connections. Default is active mode connections. +| reconnectDelay | common | | long | Delay in millis Camel will wait before performing a reconnect attempt. +| separator | common | UNIX | PathSeparator | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| delete | consumer | false | boolean | If true the file will be deleted after it is processed successfully. +| moveFailed | consumer | | String | Sets the move failure expression based on Simple language. For example to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. +| noop | consumer | false | boolean | If true the file is not moved or deleted in any way. This option is good for readonly data or for ETL type requirements. If noop=true Camel will set idempotent=true as well to avoid consuming the same files over and over again. +| preMove | consumer | | String | Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. +| recursive | consumer | false | boolean | If a directory will look for files in all the sub-directories as well. +| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. +| streamDownload | consumer | false | boolean | Sets the download method to use when not using a local working directory. If set to true the remote files are streamed to the route as they are read. When set to false the remote files are loaded into memory before being sent into the route. +| directoryMustExist | consumer (advanced) | false | boolean | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| ignoreFileNotFoundOrPermissionError | consumer (advanced) | false | boolean | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead. +| inProgressRepository | consumer (advanced) | | String> | A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. +| localWorkDirectory | consumer (advanced) | | String | 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. +| onCompletionExceptionHandler | consumer (advanced) | | ExceptionHandler | To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. +| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. +| processStrategy | consumer (advanced) | | GenericFileProcessStrategy<T> | A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed such as a special ready file exists. If this option is set then the readLock option does not apply. +| receiveBufferSize | consumer (advanced) | 32768 | int | The receive (download) buffer size Used only by FTPClient +| startingDirectoryMustExist | consumer (advanced) | false | boolean | Whether the starting directory must exist. Mind that the autoCreate option is default enabled which means the starting directory is normally auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist. +| useList | consumer (advanced) | true | boolean | Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command and therefore you can set this option to false. +| doneFileName | producer | | String | If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. +| fileExist | producer | Override | GenericFileExist | What to do if a file already exists with the same name. Override which is the default replaces the existing file. Append - adds content to the existing file. Fail - throws a GenericFileOperationException indicating that there is already an existing file. Ignore - silently ignores the problem and does not override the existing file but assumes everything is okay. Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file and there exists already an existing file otherwise causing the move operation to fail. The Move option will move any existing files before writing the target file. TryRename Camel is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name without doing any exists check.This check may be faster on some file systems and especially FT P servers. +| flatten | producer | false | boolean | Flatten is used to flatten the file name path to strip any leading paths so it's just the file name. This allows you to consume recursively into sub-directories but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. +| moveExisting | producer | | String | Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name file:name.ext file:name.noext file:onlyname file:onlyname.noext file:ext and file:parent. Notice the file:parent is not supported by the FTP component as the FTP component can only move any existing files to a relative directory based on current dir as base. +| tempFileName | producer | | String | The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. +| tempPrefix | producer | | String | This option is used to write the file using a temporary name and then after the write is complete rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files. +| allowNullBody | producer (advanced) | false | boolean | Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created when set to false and attempting to send a null body to the file component a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override' then the file will be truncated and if set to append the file will remain unchanged. +| eagerDeleteTargetFile | producer (advanced) | true | boolean | Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled and an existing file exists. If this option copyAndDeleteOnRenameFails false then an exception will be thrown if an existing file existed if its true then the existing file is deleted before the move operation. +| keepLastModified | producer (advanced) | false | boolean | Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers. +| sendNoop | producer (advanced) | true | boolean | Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid which allows to silently re-connect to be able to upload the file. However if this causes problems you can turn this option off. +| autoCreate | advanced | true | boolean | Automatically create missing directories in the file's pathname. For the file consumer that means creating the starting directory. For the file producer it means the directory the files should be written to. +| bufferSize | advanced | 131072 | int | Write buffer sized in bytes. +| connectTimeout | advanced | 10000 | int | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| ftpClient | advanced | | FTPClient | To use a custom instance of FTPClient +| ftpClientConfig | advanced | | FTPClientConfig | To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use. +| ftpClientConfigParameters | advanced | | Map | Used by FtpComponent to provide additional parameters for the FTPClientConfig +| ftpClientParameters | advanced | | Map | Used by FtpComponent to provide additional parameters for the FTPClient +| siteCommand | advanced | | String | Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character (\n). +| soTimeout | advanced | 300000 | int | Sets the so timeout Used only by FTPClient +| stepwise | advanced | true | boolean | Sets whether we should stepwise change directories while traversing file structures when downloading files or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| throwExceptionOnConnectFailed | advanced | false | boolean | Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. +| timeout | advanced | 30000 | int | Sets the data timeout for waiting for reply Used only by FTPClient +| antExclude | filter | | String | Ant style filter exclusion. If both antInclude and antExclude are used antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format. +| antFilterCaseSensitive | filter | true | boolean | Sets case sensitive flag on ant fiter +| antInclude | filter | | String | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. +| eagerMaxMessagesPerPoll | filter | true | boolean | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files and then perform sorting. Setting this option to false allows for sorting all files first and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. +| exclude | filter | | String | Is used to exclude files if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris +| filter | filter | | GenericFileFilter<T> | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. +| idempotent | filter | false | Boolean | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. +| idempotentKey | filter | | String | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language for example to use the file name and file size you can do: idempotentKey=$file:name-$file:size +| idempotentRepository | filter | | String> | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. +| include | filter | | String | Is used to include files if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris +| maxDepth | filter | 2147483647 | int | The maximum depth to traverse when recursively processing a directory. +| maxMessagesPerPoll | filter | | int | To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500 then only the first 500 files will be picked up and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards. +| minDepth | filter | | int | The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. +| move | filter | | String | Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done. +| exclusiveReadLockStrategy | lock | | GenericFileExclusiveReadLockStrategy<T> | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. +| readLock | lock | | String | Used by consumer to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: none - No read lock is in use markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this so this option cannot consume files as fast as the others but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. fileLock - is for using java.nio.channels.FileLock. This option is not avail for the FTP component. This approach should be avoided when acces sing a remote file system via a mount/share unless that file system supports distributed file locks. rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. Notice: The various read locks is not all suited to work in clustered mode where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering such as Hazelcast Component or Infinispan. +| readLockCheckInterval | lock | 1000 | long | Interval in millis for the read-lock if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. +| readLockDeleteOrphanLockFiles | lock | true | boolean | Whether or not read lock with marker files should upon startup delete any orphan read lock files which may have been left on the file system if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file this could also be due another node is concurrently reading files from the same shared directory. +| readLockLoggingLevel | lock | WARN | LoggingLevel | Logging level used when a read lock could not be acquired. By default a WARN is logged. You can change this level for example to OFF to not have any logging. This option is only applicable for readLock of types: changed fileLock rename. +| readLockMarkerFile | lock | true | boolean | Whether to use marker file with the changed rename or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application. +| readLockMinAge | lock | 0 | long | This option applied only for readLock=change. This option allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age. +| readLockMinLength | lock | 1 | long | This option applied only for readLock=changed. This option allows you to configure a minimum file length. By default Camel expects the file to contain data and thus the default value is 1. You can set this option to zero to allow consuming zero-length files. +| readLockRemoveOnCommit | lock | false | boolean | This option applied only for readLock=idempotent. This option allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. +| readLockRemoveOnRollback | lock | true | boolean | This option applied only for readLock=idempotent. This option allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false then the file name entry is confirmed (as if the file did a commit). +| readLockTimeout | lock | 10000 | long | Optional timeout in millis for the read-lock if supported by the read-lock. If the read-lock could not be granted and the timeout triggered then Camel will skip the file. At next poll Camel will try the file again and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. +| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. +| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. +| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. +| delay | scheduler | 500 | long | Milliseconds before the next poll. +| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. +| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. +| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. +| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. +| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component +| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. +| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. +| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. +| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| shuffle | sort | false | boolean | To shuffle the list of files (sort in random order) +| sortBy | sort | | String | Built-in sort by using the File Language. Supports nested sorts so you can have a sort by file name and as a 2nd group sort by modified date. +| sorter | sort | | GenericFile<T>> | Pluggable sorter as a java.util.Comparator class. +| account | security | | String | Account to use for login +| password | security | | String | Password to use for login +| username | security | | String | Username to use for login +|======================================================================= +// endpoint options: END + + +[Info] +==== +FTPS component default trust store + +When using the `ftpClient.` properties related to SSL with the FTPS +component, the 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`. + +When using `sslContextParameters`, the trust store is managed by the +configuration of the provided SSLContextParameters instance. + +==== + +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: + +[source,java] +-------------------------------------------------------------------------------------- +from("ftp://foo@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. + +[source,java] +---------------------------------------------------------------------------------------------------------------------------- +from("ftp://foo@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 link:registry.html[Registry] for it. + +For example: + +[source,java] +-------------------------------------------------------------------------- + <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. + +[source,java] +------------------------------------------------------------------------------------ +from("ftp://foo@myserver?password=secret&ftpClientConfig=#myConfig";).to("bean:foo"); +------------------------------------------------------------------------------------ + +[[FTP2-MoreURIoptions]] +More URI options +^^^^^^^^^^^^^^^^ + +[Info] +==== + + +See link:file2.html[File2] as all the options there also applies for +this component. + +==== + +[[FTP2-Examples]] +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` + +[Warning] +==== +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. + +==== + +[Tip] +==== +More information + +This component is an extension of the link:file2.html[File] component. +So there are more samples and details on the link:file2.html[File] +component page. + +==== + +[[FTP2-Defaultwhenconsumingfiles]] +Default when consuming files +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The link:ftp2.html[FTP] consumer will by default leave the consumed +files untouched on the remote FTP server. You have to configure it +explicitly 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 link:file2.html[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. + +[[FTP2-limitations]] +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. +See the options table at link:file2.html[File2] for more details about +read locks. + + 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. + +[[FTP2-MessageHeaders]] +Message Headers +^^^^^^^^^^^^^^^ + +The following message headers can be used to affect the behavior of the +component + +[width="100%",cols="50%,50%",options="header",] +|======================================================================= +|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 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. +|======================================================================= + +In addition the FTP/FTPS consumer and producer will enrich the Camel +`Message` with the following headers + +[width="100%",cols="50%,50%",options="header",] +|======================================================================= +|Header |Description + +|`CamelFtpReplyCode` |*Camel 2.11.1:* The FTP client reply code (the type is a integer) + +|`CamelFtpReplyString` | *Camel 2.11.1:* The FTP client reply string +|======================================================================= + +[[FTP2-Abouttimeouts]] +About timeouts +^^^^^^^^^^^^^^ + +The two set of libraries (see top) has different API for setting +timeout. You can use the `connectTimeout` option for both of them to set +a timeout in millis to establish a network connection. An individual +`soTimeout` can also be set on the FTP/FTPS, which corresponds to using +`ftpClient.soTimeout`. Notice SFTP will automatically use +`connectTimeout` as its `soTimeout`. The `timeout` option only applies +for FTP/FTSP as the data timeout, which corresponds to the +`ftpClient.dataTimeout` value. All timeout values are in millis. + +[[FTP2-UsingLocalWorkDirectory]] +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 link:exchange.html[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: + +[source,java] +------------------------------------------------------------------------------------------------ +from("ftp://some...@someserver.com?password=secret&localWorkDirectory=/tmp";).to("file://inbox"); +------------------------------------------------------------------------------------------------ + +[Tip] +==== + *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 +link:exchange.html[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. + +==== + +[[FTP2-Stepwisechangingdirectories]] +Stepwise changing directories +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Camel link:ftp2.html[FTP] can operate in two modes in terms of +traversing directories when consuming files (eg downloading) or +producing files (eg uploading) + +* stepwise +* not stepwise + +You may want to pick either one depending on your situation and security +issues. Some Camel end users can only download files if they use +stepwise, while others can only download if they do not. At least you +have the choice to pick (from Camel 2.6 onwards). + +In Camel 2.0 - 2.5 there is only one mode and it is: + +* before 2.5 not stepwise +* 2.5 stepwise + +From Camel 2.6 onwards there is now an option `stepwise` you can use to +control the behavior. + +Note that stepwise changing of directory will in most cases only work +when the user is confined to it's home directory and when the home +directory is reported as `"/"`. + +The difference between the two of them is best illustrated with an +example. Suppose we have the following directory structure on the remote +FTP server we need to traverse and download files: + +[source,java] +-------------- +/ +/one +/one/two +/one/two/sub-a +/one/two/sub-b +-------------- + +And that we have a file in each of sub-a (a.txt) and sub-b (b.txt) +folder. + +[[FTP2-Usingstepwise]] +Using stepwise=true (default mode) +++++++++++++++++++++++++++++++++++ + +[source,java] +---------------------------------------------------------- +TYPE A +200 Type set to A +PWD +257 "/" is current directory. +CWD one +250 CWD successful. "/one" is current directory. +CWD two +250 CWD successful. "/one/two" is current directory. +SYST +215 UNIX emulated by FileZilla +PORT 127,0,0,1,17,94 +200 Port command successful +LIST +150 Opening data channel for directory list. +226 Transfer OK +CWD sub-a +250 CWD successful. "/one/two/sub-a" is current directory. +PORT 127,0,0,1,17,95 +200 Port command successful +LIST +150 Opening data channel for directory list. +226 Transfer OK +CDUP +200 CDUP successful. "/one/two" is current directory. +CWD sub-b +250 CWD successful. "/one/two/sub-b" is current directory. +PORT 127,0,0,1,17,96 +200 Port command successful +LIST +150 Opening data channel for directory list. +226 Transfer OK +CDUP +200 CDUP successful. "/one/two" is current directory. +CWD / +250 CWD successful. "/" is current directory. +PWD +257 "/" is current directory. +CWD one +250 CWD successful. "/one" is current directory. +CWD two +250 CWD successful. "/one/two" is current directory. +PORT 127,0,0,1,17,97 +200 Port command successful +RETR foo.txt +150 Opening data channel for file transfer. +226 Transfer OK +CWD / +250 CWD successful. "/" is current directory. +PWD +257 "/" is current directory. +CWD one +250 CWD successful. "/one" is current directory. +CWD two +250 CWD successful. "/one/two" is current directory. +CWD sub-a +250 CWD successful. "/one/two/sub-a" is current directory. +PORT 127,0,0,1,17,98 +200 Port command successful +RETR a.txt +150 Opening data channel for file transfer. +226 Transfer OK +CWD / +250 CWD successful. "/" is current directory. +PWD +257 "/" is current directory. +CWD one +250 CWD successful. "/one" is current directory. +CWD two +250 CWD successful. "/one/two" is current directory. +CWD sub-b +250 CWD successful. "/one/two/sub-b" is current directory. +PORT 127,0,0,1,17,99 +200 Port command successful +RETR b.txt +150 Opening data channel for file transfer. +226 Transfer OK +CWD / +250 CWD successful. "/" is current directory. +QUIT +221 Goodbye +disconnected. +---------------------------------------------------------- + +As you can see when stepwise is enabled, it will traverse the directory +structure using CD xxx. + +[[FTP2-Notusingstepwise]] +Using stepwise=false +++++++++++++++++++++ + +[source,java] +------------------------------------------- +230 Logged on +TYPE A +200 Type set to A +SYST +215 UNIX emulated by FileZilla +PORT 127,0,0,1,4,122 +200 Port command successful +LIST one/two +150 Opening data channel for directory list +226 Transfer OK +PORT 127,0,0,1,4,123 +200 Port command successful +LIST one/two/sub-a +150 Opening data channel for directory list +226 Transfer OK +PORT 127,0,0,1,4,124 +200 Port command successful +LIST one/two/sub-b +150 Opening data channel for directory list +226 Transfer OK +PORT 127,0,0,1,4,125 +200 Port command successful +RETR one/two/foo.txt +150 Opening data channel for file transfer. +226 Transfer OK +PORT 127,0,0,1,4,126 +200 Port command successful +RETR one/two/sub-a/a.txt +150 Opening data channel for file transfer. +226 Transfer OK +PORT 127,0,0,1,4,127 +200 Port command successful +RETR one/two/sub-b/b.txt +150 Opening data channel for file transfer. +226 Transfer OK +QUIT +221 Goodbye +disconnected. +------------------------------------------- + +As you can see when not using stepwise, there are no CD operation +invoked at all. + +[[FTP2-Samples]] +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. + +And the route using Spring DSL: + +[source,xml] +------------------------------------------------------------------------------------------------------ + <route> + <from uri="ftp://scott@localhost/public/reports?password=tiger&binary=true&delay=60000"/> + <to uri="file://target/test-reports"/> + </route> +------------------------------------------------------------------------------------------------------ + +[[FTP2-ConsumingaremoteFTPSserverimplicitSSLandclientauthentication]] +Consuming a remote FTPS server (implicit SSL) and client authentication ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +[source,java] +-------------------------------------------------------------------------------------------------- +from("ftps://admin@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"); +-------------------------------------------------------------------------------------------------- + +[[FTP2-ConsumingaremoteFTPSserverexplicitTLSandacustomtruststoreconfiguration]] +Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +[source,java] +---------------------------------------------------------------------------------------------------------------------------------------------------------------- +from("ftps://admin@localhost:2222/public/camel?password=admin&ftpClient.trustStore.file=./src/test/resources/server.jks&ftpClient.trustStore.password=password") + .to("bean:foo"); +---------------------------------------------------------------------------------------------------------------------------------------------------------------- + +[[FTP2-Filterusingorg.apache.camel.component.file.GenericFileFilter]] +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 built 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 defined in the +spring XML file: + +[source,xml] +--------------------------------------------------------------------------------------- + <!-- define our sorter as a plain spring bean --> + <bean id="myFilter" class="com.mycompany.MyFileFilter"/> + + <route> + <from uri="ftp://someu...@someftpserver.com?password=secret&filter=#myFilter"/> + <to uri="bean:processInbox"/> + </route> +--------------------------------------------------------------------------------------- + +[[FTP2-FilteringusingANTpathmatcher]] +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 +http://static.springsource.org/spring/docs/3.0.x/api/org/springframework/util/AntPathMatcher.html[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: + +[[FTP2-UsingaproxywithSFTP]] +Using a proxy with SFTP +^^^^^^^^^^^^^^^^^^^^^^^ + +To use an HTTP proxy to connect to your remote host, you can configure +your route in the following way: + +[source,xml] +------------------------------------------------------------------------------------- +<!-- define our sorter as a plain spring bean --> +<bean id="proxy" class="com.jcraft.jsch.ProxyHTTP"> + <constructor-arg value="localhost"/> + <constructor-arg value="7777"/> +</bean> + +<route> + <from uri="sftp://localhost:9999/root?username=admin&password=admin&proxy=#proxy"/> + <to uri="bean:processFile"/> +</route> +------------------------------------------------------------------------------------- + +You can also assign a user name and password to the proxy, if necessary. +Please consult the documentation for `com.jcraft.jsch.Proxy` to discover +all options. + +[[FTP2-SettingpreferredSFTPauthenticationmethod]] +Setting preferred SFTP authentication method +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you want to explicitly specify the list of authentication methods +that should be used by `sftp` component, use `preferredAuthentications` +option. If for example you would like Camel to attempt to authenticate +with private/public SSH key and fallback to user/password authentication +in the case when no public key is available, use the following route +configuration: + +[source,java] +------------------------------------------------------------------------------------------------------------- +from("sftp://localhost:9999/root?username=admin&password=admin&preferredAuthentications=publickey,password";). + to("bean:processFile"); +------------------------------------------------------------------------------------------------------------- + +[[FTP2-Consumingasinglefileusingafixedname]] +Consuming a single file using a fixed name +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When you want to download a single file and knows the file name, you can +use `fileName=myFileName.txt` to tell Camel the name of the file to +download. By default the consumer will still do a FTP LIST command to do +a directory listing and then filter these files based on the `fileName` +option. Though in this use-case it may be desirable to turn off the +directory listing by setting `useList=false`. For example the user +account used to login to the FTP server may not have permission to do a +FTP LIST command. So you can turn off this with `useList=false`, and +then provide the fixed name of the file to download with +`fileName=myFileName.txt`, then the FTP consumer can still download the +file. If the file for some reason does not exist, then Camel will by +default throw an exception, you can turn this off and ignore this by +setting `ignoreFileNotFoundOrPermissionError=true`. + +For example to have a Camel route that pickup a single file, and delete +it after use you can do + +[source,java] +------------------------------------------------------------------------------------------------------------------------------------------------------------- +from("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true";) + .to("activemq:queue:report"); +------------------------------------------------------------------------------------------------------------------------------------------------------------- + +Notice that we have use all the options we talked above above. + +You can also use this with `ConsumerTemplate`. For example to download a +single file (if it exists) and grab the file content as a String type: + +[source,java] +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +String data = template.retrieveBodyNoWait("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true";, String.class); +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +[[FTP2-Debuglogging]] +Debug logging +^^^^^^^^^^^^^ + +This component has log level *TRACE* that can be helpful if you have +problems. + +[[FTP2-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + +* link:file2.html[File2] + http://git-wip-us.apache.org/repos/asf/camel/blob/330487b4/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index d9e660a..5742086 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -131,6 +131,7 @@ * [Flatpack](flatpack.adoc) * [FOP](fop.adoc) * [Freemarker](freemarker.adoc) + * [FTP](ftp.adoc) * [Ironmq](ironmq.adoc) * [JMS](jms.adoc) * [JMX](jmx.adoc)
