This is an automated email from the ASF dual-hosted git repository.
pascalschumacher pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 3e5c93b GenericFileEndpoint: minimal correction and improvements of
the javadoc
3e5c93b is described below
commit 3e5c93b47804107bff835a9164ceb53a0e3fd6e4
Author: Pascal Schumacher <[email protected]>
AuthorDate: Tue Apr 3 23:01:51 2018 +0200
GenericFileEndpoint: minimal correction and improvements of the javadoc
---
camel-core/src/main/docs/file-component.adoc | 8 ++++----
.../apache/camel/component/file/GenericFileEndpoint.java | 14 +++++++-------
components/camel-ftp/src/main/docs/ftp-component.adoc | 8 ++++----
components/camel-ftp/src/main/docs/ftps-component.adoc | 8 ++++----
components/camel-ftp/src/main/docs/sftp-component.adoc | 8 ++++----
5 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/camel-core/src/main/docs/file-component.adoc
b/camel-core/src/main/docs/file-component.adoc
index 46ce0e1..4fb3ad1 100644
--- a/camel-core/src/main/docs/file-component.adoc
+++ b/camel-core/src/main/docs/file-component.adoc
@@ -142,10 +142,10 @@ with the following path and query parameters:
| *readLockIdempotentRelease ExecutorService* (lock) | To use a custom and
shared thread pool for asynchronous release tasks. See more details at the
readLockIdempotentReleaseDelay option. | | ScheduledExecutor Service
| *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 n [...]
-| *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
+| *readLockMinAge* (lock) | This option is applied only for readLock=changed.
It 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 is applied only for
readLock=changed. It 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 is applied only for
readLock=idempotent. It 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 en [...]
+| *readLockRemoveOnRollback* (lock) | This option is applied only for
readLock=idempotent. It 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 readL [...]
| *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
diff --git
a/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
b/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
index 59b4951..3b067df 100644
---
a/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
+++
b/camel-core/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java
@@ -933,7 +933,7 @@ public abstract class GenericFileEndpoint<T> extends
ScheduledPollEndpoint imple
}
/**
- * This option applied only for readLock=changed. This option allows you
to configure a minimum file length.
+ * This option is applied only for readLock=changed. It 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.
*/
@@ -946,8 +946,8 @@ public abstract class GenericFileEndpoint<T> extends
ScheduledPollEndpoint imple
}
/**
- * 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.
+ * This option is applied only for readLock=changed.
+ * It 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.
*/
@@ -960,8 +960,8 @@ public abstract class GenericFileEndpoint<T> extends
ScheduledPollEndpoint imple
}
/**
- * This option applied only for readLock=idempotent.
- * This option allows to specify whether to remove the file name entry
from the idempotent repository
+ * This option is applied only for readLock=idempotent.
+ * It 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).
*/
@@ -974,8 +974,8 @@ public abstract class GenericFileEndpoint<T> extends
ScheduledPollEndpoint imple
}
/**
- * This option applied only for readLock=idempotent.
- * This option allows to specify whether to remove the file name entry
from the idempotent repository
+ * This option is applied only for readLock=idempotent.
+ * It allows to specify whether to remove the file name entry from the
idempotent repository
* when processing the file is succeeded and a commit happens.
* <p/>
* By default the file is not removed which ensures that any
race-condition do not occur so another active
diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc
b/components/camel-ftp/src/main/docs/ftp-component.adoc
index de01e95..1a89cbc 100644
--- a/components/camel-ftp/src/main/docs/ftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftp-component.adoc
@@ -190,10 +190,10 @@ with the following path and query parameters:
| *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 n [...]
-| *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
+| *readLockMinAge* (lock) | This option is applied only for readLock=changed.
It 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 is applied only for
readLock=changed. It 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 is applied only for
readLock=idempotent. It 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 en [...]
+| *readLockRemoveOnRollback* (lock) | This option is applied only for
readLock=idempotent. It 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 readL [...]
| *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
diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc
b/components/camel-ftp/src/main/docs/ftps-component.adoc
index ae85f28..6b801c6 100644
--- a/components/camel-ftp/src/main/docs/ftps-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftps-component.adoc
@@ -154,10 +154,10 @@ with the following path and query parameters:
| *readLockIdempotentRelease ExecutorService* (lock) | To use a custom and
shared thread pool for asynchronous release tasks. See more details at the
readLockIdempotentReleaseDelay option. | | ScheduledExecutor Service
| *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 n [...]
-| *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
+| *readLockMinAge* (lock) | This option is applied only for readLock=changed.
It 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 is applied only for
readLock=changed. It 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 is applied only for
readLock=idempotent. It 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 en [...]
+| *readLockRemoveOnRollback* (lock) | This option is applied only for
readLock=idempotent. It 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 readL [...]
| *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
diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc
b/components/camel-ftp/src/main/docs/sftp-component.adoc
index c355bd3..e127442 100644
--- a/components/camel-ftp/src/main/docs/sftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/sftp-component.adoc
@@ -137,10 +137,10 @@ with the following path and query parameters:
| *readLockIdempotentRelease ExecutorService* (lock) | To use a custom and
shared thread pool for asynchronous release tasks. See more details at the
readLockIdempotentReleaseDelay option. | | ScheduledExecutor Service
| *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 n [...]
-| *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
+| *readLockMinAge* (lock) | This option is applied only for readLock=changed.
It 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 is applied only for
readLock=changed. It 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 is applied only for
readLock=idempotent. It 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 en [...]
+| *readLockRemoveOnRollback* (lock) | This option is applied only for
readLock=idempotent. It 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 readL [...]
| *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
--
To stop receiving notification emails like this one, please contact
[email protected].
