http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-ftp/src/main/docs/ftps-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc
b/components/camel-ftp/src/main/docs/ftps-component.adoc
index f849da2..adb771d 100644
--- a/components/camel-ftp/src/main/docs/ftps-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftps-component.adoc
@@ -1,4 +1,4 @@
-## FTPS Component
+== FTPS Component
*Available as of Camel version 2.2*
@@ -30,145 +30,147 @@ The FTPS component supports 2 options which are listed
below.
[width="100%",cols="2,5,^1,2",options="header"]
-|=======================================================================
+|===
| Name | Description | Default | Type
-| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL
context parameters. | false | boolean
-| **resolveProperty Placeholders** (advanced) | Whether the component should
resolve property placeholders on itself when starting. Only properties which
are of String type can use property placeholders. | true | boolean
-|=======================================================================
+| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL
context parameters. | false | boolean
+| *resolveProperty Placeholders* (advanced) | Whether the component should
resolve property placeholders on itself when starting. Only properties which
are of String type can use property placeholders. | true | boolean
+|===
// component options: END
// endpoint options: START
The FTPS endpoint is configured using URI syntax:
- ftps:host:port/directoryName
+----
+ftps:host:port/directoryName
+----
with the following path and query parameters:
-#### Path Parameters (3 parameters):
+==== Path Parameters (3 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
-|=======================================================================
+|===
| Name | Description | Default | Type
-| **host** | *Required* Hostname of the FTP server | | String
-| **port** | Port of the FTP server | | int
-| **directoryName** | The starting directory | | String
-|=======================================================================
+| *host* | *Required* Hostname of the FTP server | | String
+| *port* | Port of the FTP server | | int
+| *directoryName* | The starting directory | | String
+|===
-#### Query Parameters (110 parameters):
+==== Query Parameters (110 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
-|=======================================================================
+|===
| Name | Description | Default | Type
-| **binary** (common) | Specifies the file transfer mode BINARY or ASCII.
Default is ASCII (false). | false | boolean
-| **charset** (common) | 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. Do mind that
when writing the file Camel may have to read the message content into memory to
be able to convert the data into the configured charset so do not use this if
you have big messages. | | String
-| **disconnect** (common) | 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. | false | boolean
-| **doneFileName** (common) | Producer: 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. Consumer: If provided Camel
will only consume files if a done file exists. This option configures what file
name to use. Either you can specify a fixed name. Or you can use dynamic
placeholders.The done file is always expected in the same folder as the
original file. Only $file.name and $file.name.noext is supported as dynamic
placeholders. | | String
-| **fileName** (common) | 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 temporary
store CamelFileName and have to restore it afterwards. | | String
-| **passiveMode** (common) | Sets passive mode connections. Default is active
mode connections. | false | boolean
-| **separator** (common) | 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 | UNIX | PathSeparator
-| **fastExistsCheck** (common) | 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. | false | boolean
-| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false |
boolean
-| **delete** (consumer) | If true the file will be deleted after it is
processed successfully. | false | boolean
-| **moveFailed** (consumer) | 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. | | String
-| **noop** (consumer) | 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. | false | boolean
-| **preMove** (consumer) | 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. | |
String
-| **recursive** (consumer) | If a directory will look for files in all the
sub-directories as well. | false | boolean
-| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not
poll any files you can enable this option to send an empty message (no body)
instead. | false | boolean
-| **streamDownload** (consumer) | 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. | false | boolean
-| **directoryMustExist** (consumer) | Similar to startingDirectoryMustExist
but this applies during polling recursive sub directories. | false | boolean
-| **download** (consumer) | 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. | false | boolean
-| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler
-| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
-| **ignoreFileNotFoundOr PermissionError** (consumer) | 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.
| false | boolean
-| **inProgressRepository** (consumer) | 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. | | String>
-| **localWorkDirectory** (consumer) | 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. | | String
-| **onCompletionException Handler** (consumer) | 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. | | ExceptionHandler
-| **pollStrategy** (consumer) | 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.
| | PollingConsumerPoll Strategy
-| **processStrategy** (consumer) | 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. |
| GenericFileProcess Strategy<T>
-| **receiveBufferSize** (consumer) | The receive (download) buffer size Used
only by FTPClient | 32768 | int
-| **startingDirectoryMustExist** (consumer) | 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. | false | boolean
-| **useList** (consumer) | 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. | true | boolean
-| **fileExist** (producer) | 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 FTP servers. | Override | Ge
nericFileExist
-| **flatten** (producer) | 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. | false | boolean
-| **moveExisting** (producer) | 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. |
| String
-| **tempFileName** (producer) | 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. | | String
-| **tempPrefix** (producer) | 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. | | String
-| **allowNullBody** (producer) | 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. | false | boolean
-| **chmod** (producer) | Allows you to set chmod on the stored file. For
example chmod=640. | | String
-| **disconnectOnBatchComplete** (producer) | Whether or not to disconnect from
remote FTP server right after a Batch upload is complete.
disconnectOnBatchComplete will only disconnect the current connection to the
FTP server. | false | boolean
-| **eagerDeleteTargetFile** (producer) | 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. | true | boolean
-| **keepLastModified** (producer) | 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. |
false | boolean
-| **sendNoop** (producer) | 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. | true | boolean
-| **activePortRange** (advanced) | Set the client side port range in active
mode. The syntax is: minPort-maxPort Both port numbers are inclusive eg
10000-19999 to include all 1xxxx ports. | | String
-| **autoCreate** (advanced) | 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. | true | boolean
-| **bufferSize** (advanced) | Write buffer sized in bytes. | 131072 | int
-| **connectTimeout** (advanced) | Sets the connect timeout for waiting for a
connection to be established Used by both FTPClient and JSCH | 10000 | int
-| **ftpClient** (advanced) | To use a custom instance of FTPClient | |
FTPClient
-| **ftpClientConfig** (advanced) | To use a custom instance of FTPClientConfig
to configure the FTP client the endpoint should use. | | FTPClientConfig
-| **ftpClientConfigParameters** (advanced) | Used by FtpComponent to provide
additional parameters for the FTPClientConfig | | Map
-| **ftpClientParameters** (advanced) | Used by FtpComponent to provide
additional parameters for the FTPClient | | Map
-| **maximumReconnectAttempts** (advanced) | Specifies the maximum reconnect
attempts Camel performs when it tries to connect to the remote FTP server. Use
0 to disable this behavior. | | int
-| **reconnectDelay** (advanced) | Delay in millis Camel will wait before
performing a reconnect attempt. | | long
-| **siteCommand** (advanced) | Sets optional site command(s) to be executed
after successful login. Multiple site commands can be separated using a new
line character (\n). | | String
-| **soTimeout** (advanced) | Sets the so timeout Used only by FTPClient |
300000 | int
-| **stepwise** (advanced) | 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. | true | boolean
-| **synchronous** (advanced) | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
-| **throwExceptionOnConnect Failed** (advanced) | 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. | false | boolean
-| **timeout** (advanced) | Sets the data timeout for waiting for reply Used
only by FTPClient | 30000 | int
-| **antExclude** (filter) | 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. | | String
-| **antFilterCaseSensitive** (filter) | Sets case sensitive flag on ant fiter
| true | boolean
-| **antInclude** (filter) | Ant style filter inclusion. Multiple inclusions
may be specified in comma-delimited format. | | String
-| **eagerMaxMessagesPerPoll** (filter) | 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. | true | boolean
-| **exclude** (filter) | 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 | | String
-| **filter** (filter) | Pluggable filter as a
org.apache.camel.component.file.GenericFileFilter class. Will skip files if
filter returns false in its accept() method. | | GenericFileFilter<T>
-| **filterDirectory** (filter) | Filters the directory based on Simple
language. For example to filter on current date you can use a simple date
pattern such as $date:now:yyyMMdd | | String
-| **filterFile** (filter) | Filters the file based on Simple language. For
example to filter on file size you can use $file:size 5000 | | String
-| **idempotent** (filter) | 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. | false | Boolean
-| **idempotentKey** (filter) | 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
| | String
-| **idempotentRepository** (filter) | A pluggable repository
org.apache.camel.spi.IdempotentRepository which by default use
MemoryMessageIdRepository if none is specified and idempotent is true. | |
String>
-| **include** (filter) | Is used to include files if filename matches the
regex pattern (matching is case in-sensitive). 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 | | String
-| **maxDepth** (filter) | The maximum depth to traverse when recursively
processing a directory. | 2147483647 | int
-| **maxMessagesPerPoll** (filter) | 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. | | int
-| **minDepth** (filter) | 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. | | int
-| **move** (filter) | 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. | | String
-| **exclusiveReadLockStrategy** (lock) | Pluggable read-lock as a
org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy
implementation. | | GenericFileExclusive ReadLockStrategy<T>
-| **readLock** (lock) | 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 accessing
a r
emote 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. idempotent-changed - (only for file
component) idempotent-changed is for using a idempotentRepository and changed
as the combined read-lock. This allows to use read locks that supports
clustering if the idempotent repository implementation supports that.
idempotent-rename - (only for file component) idempotent-rename is for using a
idempotentRepository and rename as the combined 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. | | String
-| **readLockCheckInterval** (lock) | 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. | 1000 | long
-| **readLockDeleteOrphanLock Files** (lock) | 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. | true |
boolean
-| **readLockLoggingLevel** (lock) | 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 idempotent idempotent-changed
idempotent-rename rename. | DEBUG | LoggingLevel
-| **readLockMarkerFile** (lock) | 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. | true |
boolean
-| **readLockMinAge** (lock) | 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. | 0 | long
-| **readLockMinLength** (lock) | 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. | 1 | long
-| **readLockRemoveOnCommit** (lock) | 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. | false | boolean
-| **readLockRemoveOnRollback** (lock) | 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). | true | boolean
-| **readLockTimeout** (lock) | 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. | 10000 | long
-| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
-| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls
that should happen before the backoffMultipler should kick-in. | | int
-| **backoffMultiplier** (scheduler) | 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. | |
int
-| **delay** (scheduler) | Milliseconds before the next poll. You can also
specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and
30 seconds) and 1h (1 hour). | 500 | long
-| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer
will run immediately again if the previous run polled 1 or more messages. |
false | boolean
-| **initialDelay** (scheduler) | Milliseconds before the first poll starts.
You can also specify time values using units such as 60s (60 seconds) 5m30s (5
minutes and 30 seconds) and 1h (1 hour). | 1000 | long
-| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log
line when it polls. This option allows you to configure the logging level for
that. | TRACE | LoggingLevel
-| **scheduledExecutorService** (scheduler) | Allows for configuring a
custom/shared thread pool to use for the consumer. By default each consumer has
its own single threaded thread pool. | | ScheduledExecutor Service
-| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring
or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
-| **schedulerProperties** (scheduler) | To configure additional properties
when using a custom scheduler or any of the Quartz2 Spring based scheduler. |
| Map
-| **startScheduler** (scheduler) | Whether the scheduler should be auto
started. | true | boolean
-| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. |
MILLISECONDS | TimeUnit
-| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is
used. See ScheduledExecutorService in JDK for details. | true | boolean
-| **shuffle** (sort) | To shuffle the list of files (sort in random order) |
false | boolean
-| **sortBy** (sort) | 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. | | String
-| **sorter** (sort) | Pluggable sorter as a java.util.Comparator class. | |
GenericFile<T>>
-| **account** (security) | Account to use for login | | String
-| **disableSecureDataChannel Defaults** (security) | Use this option to
disable default options when using secure data channel. This allows you to be
in full control what the execPbsz and execProt setting should be used. Default
is false | false | boolean
-| **execPbsz** (security) | When using secure data channel you can set the
exec protection buffer size | | Long
-| **execProt** (security) | The exec protection level PROT command. C - Clear
S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private |
| String
-| **ftpClientKeyStore Parameters** (security) | Set the key store parameters |
| Map
-| **ftpClientTrustStore Parameters** (security) | Set the trust store
parameters | | Map
-| **isImplicit** (security) | Set the security mode(Implicit/Explicit). true -
Implicit Mode / False - Explicit Mode | false | boolean
-| **password** (security) | Password to use for login | | String
-| **securityProtocol** (security) | Set the underlying security protocol. |
TLS | String
-| **sslContextParameters** (security) | Gets the JSSE configuration that
overrides any settings in link FtpsEndpointftpClientKeyStoreParameters link
ftpClientTrustStoreParameters and link FtpsConfigurationgetSecurityProtocol().
| | SSLContextParameters
-| **username** (security) | Username to use for login | | String
-|=======================================================================
+| *binary* (common) | Specifies the file transfer mode BINARY or ASCII.
Default is ASCII (false). | false | boolean
+| *charset* (common) | 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. Do mind that
when writing the file Camel may have to read the message content into memory to
be able to convert the data into the configured charset so do not use this if
you have big messages. | | String
+| *disconnect* (common) | 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. | false | boolean
+| *doneFileName* (common) | Producer: 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. Consumer: If provided Camel will only
consume files if a done file exists. This option configures what file name to
use. Either you can specify a fixed name. Or you can use dynamic
placeholders.The done file is always expected in the same folder as the
original file. Only $file.name and $file.name.noext is supported as dynamic
placeholders. | | String
+| *fileName* (common) | 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 temporary st
ore CamelFileName and have to restore it afterwards. | | String
+| *passiveMode* (common) | Sets passive mode connections. Default is active
mode connections. | false | boolean
+| *separator* (common) | 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 | UNIX | PathSeparator
+| *fastExistsCheck* (common) | 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. | false | boolean
+| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false |
boolean
+| *delete* (consumer) | If true the file will be deleted after it is processed
successfully. | false | boolean
+| *moveFailed* (consumer) | 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. | | String
+| *noop* (consumer) | 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. | false | boolean
+| *preMove* (consumer) | 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. | |
String
+| *recursive* (consumer) | If a directory will look for files in all the
sub-directories as well. | false | boolean
+| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files you can enable this option to send an empty message (no body)
instead. | false | boolean
+| *streamDownload* (consumer) | 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. | false | boolean
+| *directoryMustExist* (consumer) | Similar to startingDirectoryMustExist but
this applies during polling recursive sub directories. | false | boolean
+| *download* (consumer) | 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. | false | boolean
+| *exceptionHandler* (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
+| *ignoreFileNotFoundOr PermissionError* (consumer) | 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.
| false | boolean
+| *inProgressRepository* (consumer) | 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. | | String>
+| *localWorkDirectory* (consumer) | 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. | | String
+| *onCompletionException Handler* (consumer) | 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. | | ExceptionHandler
+| *pollStrategy* (consumer) | 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.
| | PollingConsumerPoll Strategy
+| *processStrategy* (consumer) | 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. |
| GenericFileProcess Strategy<T>
+| *receiveBufferSize* (consumer) | The receive (download) buffer size Used
only by FTPClient | 32768 | int
+| *startingDirectoryMustExist* (consumer) | 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. | false | boolean
+| *useList* (consumer) | 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. | true | boolean
+| *fileExist* (producer) | 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 FTP servers. | Override | Gene
ricFileExist
+| *flatten* (producer) | 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. | false | boolean
+| *moveExisting* (producer) | 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. |
| String
+| *tempFileName* (producer) | 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. | | String
+| *tempPrefix* (producer) | 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. | | String
+| *allowNullBody* (producer) | 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. | false | boolean
+| *chmod* (producer) | Allows you to set chmod on the stored file. For example
chmod=640. | | String
+| *disconnectOnBatchComplete* (producer) | Whether or not to disconnect from
remote FTP server right after a Batch upload is complete.
disconnectOnBatchComplete will only disconnect the current connection to the
FTP server. | false | boolean
+| *eagerDeleteTargetFile* (producer) | 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. | true | boolean
+| *keepLastModified* (producer) | 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. |
false | boolean
+| *sendNoop* (producer) | 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. | true | boolean
+| *activePortRange* (advanced) | Set the client side port range in active
mode. The syntax is: minPort-maxPort Both port numbers are inclusive eg
10000-19999 to include all 1xxxx ports. | | String
+| *autoCreate* (advanced) | 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. | true | boolean
+| *bufferSize* (advanced) | Write buffer sized in bytes. | 131072 | int
+| *connectTimeout* (advanced) | Sets the connect timeout for waiting for a
connection to be established Used by both FTPClient and JSCH | 10000 | int
+| *ftpClient* (advanced) | To use a custom instance of FTPClient | | FTPClient
+| *ftpClientConfig* (advanced) | To use a custom instance of FTPClientConfig
to configure the FTP client the endpoint should use. | | FTPClientConfig
+| *ftpClientConfigParameters* (advanced) | Used by FtpComponent to provide
additional parameters for the FTPClientConfig | | Map
+| *ftpClientParameters* (advanced) | Used by FtpComponent to provide
additional parameters for the FTPClient | | Map
+| *maximumReconnectAttempts* (advanced) | Specifies the maximum reconnect
attempts Camel performs when it tries to connect to the remote FTP server. Use
0 to disable this behavior. | | int
+| *reconnectDelay* (advanced) | Delay in millis Camel will wait before
performing a reconnect attempt. | | long
+| *siteCommand* (advanced) | Sets optional site command(s) to be executed
after successful login. Multiple site commands can be separated using a new
line character (\n). | | String
+| *soTimeout* (advanced) | Sets the so timeout Used only by FTPClient | 300000
| int
+| *stepwise* (advanced) | 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. | true | boolean
+| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
+| *throwExceptionOnConnect Failed* (advanced) | 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. | false | boolean
+| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only
by FTPClient | 30000 | int
+| *antExclude* (filter) | 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. | | String
+| *antFilterCaseSensitive* (filter) | Sets case sensitive flag on ant fiter |
true | boolean
+| *antInclude* (filter) | Ant style filter inclusion. Multiple inclusions may
be specified in comma-delimited format. | | String
+| *eagerMaxMessagesPerPoll* (filter) | 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. | true | boolean
+| *exclude* (filter) | 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 | | String
+| *filter* (filter) | Pluggable filter as a
org.apache.camel.component.file.GenericFileFilter class. Will skip files if
filter returns false in its accept() method. | | GenericFileFilter<T>
+| *filterDirectory* (filter) | Filters the directory based on Simple language.
For example to filter on current date you can use a simple date pattern such as
$date:now:yyyMMdd | | String
+| *filterFile* (filter) | Filters the file based on Simple language. For
example to filter on file size you can use $file:size 5000 | | String
+| *idempotent* (filter) | 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. | false | Boolean
+| *idempotentKey* (filter) | 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
| | String
+| *idempotentRepository* (filter) | A pluggable repository
org.apache.camel.spi.IdempotentRepository which by default use
MemoryMessageIdRepository if none is specified and idempotent is true. | |
String>
+| *include* (filter) | Is used to include files if filename matches the regex
pattern (matching is case in-sensitive). 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 | | String
+| *maxDepth* (filter) | The maximum depth to traverse when recursively
processing a directory. | 2147483647 | int
+| *maxMessagesPerPoll* (filter) | 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. | | int
+| *minDepth* (filter) | 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. | | int
+| *move* (filter) | 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. | | String
+| *exclusiveReadLockStrategy* (lock) | Pluggable read-lock as a
org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy
implementation. | | GenericFileExclusive ReadLockStrategy<T>
+| *readLock* (lock) | 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 accessing
a rem
ote 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. idempotent-changed - (only for file component)
idempotent-changed is for using a idempotentRepository and changed as the
combined read-lock. This allows to use read locks that supports clustering if
the idempotent repository implementation supports that. idempotent-rename -
(only for file component) idempotent-rename is for using a idempotentRepository
and rename as the combined 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 c
oncurrent 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. | | String
+| *readLockCheckInterval* (lock) | 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. | 1000 | long
+| *readLockDeleteOrphanLock Files* (lock) | 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. | true |
boolean
+| *readLockLoggingLevel* (lock) | 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 idempotent idempotent-changed
idempotent-rename rename. | DEBUG | LoggingLevel
+| *readLockMarkerFile* (lock) | 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. | true |
boolean
+| *readLockMinAge* (lock) | 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. | 0 | long
+| *readLockMinLength* (lock) | 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. | 1 | long
+| *readLockRemoveOnCommit* (lock) | 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. | false | boolean
+| *readLockRemoveOnRollback* (lock) | 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). | true | boolean
+| *readLockTimeout* (lock) | 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. | 10000 | long
+| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
+| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls
that should happen before the backoffMultipler should kick-in. | | int
+| *backoffMultiplier* (scheduler) | 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. | |
int
+| *delay* (scheduler) | Milliseconds before the next poll. You can also
specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and
30 seconds) and 1h (1 hour). | 500 | long
+| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer
will run immediately again if the previous run polled 1 or more messages. |
false | boolean
+| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You
can also specify time values using units such as 60s (60 seconds) 5m30s (5
minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line
when it polls. This option allows you to configure the logging level for that.
| TRACE | LoggingLevel
+| *scheduledExecutorService* (scheduler) | Allows for configuring a
custom/shared thread pool to use for the consumer. By default each consumer has
its own single threaded thread pool. | | ScheduledExecutor Service
+| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring
or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| *schedulerProperties* (scheduler) | To configure additional properties when
using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| *startScheduler* (scheduler) | Whether the scheduler should be auto started.
| true | boolean
+| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. |
MILLISECONDS | TimeUnit
+| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
+| *shuffle* (sort) | To shuffle the list of files (sort in random order) |
false | boolean
+| *sortBy* (sort) | 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. | | String
+| *sorter* (sort) | Pluggable sorter as a java.util.Comparator class. | |
GenericFile<T>>
+| *account* (security) | Account to use for login | | String
+| *disableSecureDataChannel Defaults* (security) | Use this option to disable
default options when using secure data channel. This allows you to be in full
control what the execPbsz and execProt setting should be used. Default is false
| false | boolean
+| *execPbsz* (security) | When using secure data channel you can set the exec
protection buffer size | | Long
+| *execProt* (security) | The exec protection level PROT command. C - Clear S
- Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private | |
String
+| *ftpClientKeyStore Parameters* (security) | Set the key store parameters |
| Map
+| *ftpClientTrustStore Parameters* (security) | Set the trust store parameters
| | Map
+| *isImplicit* (security) | Set the security mode(Implicit/Explicit). true -
Implicit Mode / False - Explicit Mode | false | boolean
+| *password* (security) | Password to use for login | | String
+| *securityProtocol* (security) | Set the underlying security protocol. | TLS
| String
+| *sslContextParameters* (security) | Gets the JSSE configuration that
overrides any settings in link FtpsEndpointftpClientKeyStoreParameters link
ftpClientTrustStoreParameters and link FtpsConfigurationgetSecurityProtocol().
| | SSLContextParameters
+| *username* (security) | Username to use for login | | String
+|===
// endpoint options: END
