Author: rajikak
Date: Sun Aug 18 03:48:12 2013
New Revision: 1515064
URL: http://svn.apache.org/r1515064
Log:
updated the vfs documentation.
Modified:
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/transports/vfs.xml
Modified:
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/transports/vfs.xml
URL:
http://svn.apache.org/viewvc/synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/transports/vfs.xml?rev=1515064&r1=1515063&r2=1515064&view=diff
==============================================================================
---
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/transports/vfs.xml
(original)
+++
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/transports/vfs.xml
Sun Aug 18 03:48:12 2013
@@ -297,6 +297,79 @@
<td>No</td>
<td>false</td>
</tr>
+ <tr>
+ <td>transport.vfs.UseTempFile</td>
+ <td>If this parameter is set to true, the transport
will create a temporary, then
+ will transfer the content and it will be renamed to
the configured file name. This
+ is specially useful to avoid processing of partially
transferred files using VFS
+ transport. This configuration should be configured as
part of the endpoint
+ deceleration.</td>
+ <td>No</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>transport.vfs.MaxRetryCount</td>
+ <td>The number of attempts that the polling task
should attempt to poll the remote
+ VFS destination after an error occurs when trying to
resolve the remote file.
+ For each erroneous attempts polling will be suspended
for the amount given by
+ the parameter 'transport.vfs.ReconnectTimeout'.
+ <div class="xmlConf"><parameter
name="transport.vfs.MaxRetryCount">3</parameter></div>
+ </td>
+ <td>No</td>
+ <td>3</td>
+ </tr>
+ <tr>
+ <td>transport.vfs.ReconnectTimeout</td>
+ <td>The amount the current polling task should be
suspended after the failed
+ attempt to resolve the file object.
+ <div class="xmlConf"><parameter
name="transport.vfs.ReconnectTimeout">30000</parameter></div>
+ </td>
+ <td>No</td>
+ <td>30000 milliseconds</td>
+ </tr>
+ <tr>
+ <td>transport.vfs.FailedRecordsFileName</td>
+ <td>Once the processing is done on a file it will be
moved(to a new file) or
+ deleted. If this operation fails, a log can be written
with the cause to the
+ given fail record file.
+ <div class="xmlConf"><parameter
name="transport.vfs.FailedRecordsFileName">vfs-move-failed-records.properties</parameter></div>
+ </td>
+ <td>No</td>
+ <td>vfs-move-failed-records.properties</td>
+ </tr>
+ <tr>
+ <td>transport.vfs.FailedRecordsFileDestination</td>
+ <td>The destination to create the log file of failed
move or delete operations
+ on processed files.
+ <div class="xmlConf"><parameter
name="transport.vfs.FailedRecordsFileDestination">repository/conf</parameter></div>
+ </td>
+ <td>No</td>
+ <td>repository/conf</td>
+ </tr>
+ <tr>
+ <td>transport.vfs.FailedRecordNextRetryDuration</td>
+ <td>Once a move operation failed, the move task will
be retried after this
+ configured amount of time.
+ <div class="xmlConf"><parameter
name="transport.vfs.FailedRecordsFileName">vfs-move-failed-records.properties</parameter></div>
+ </td>
+ <td>No</td>
+ <td>3000 milliseconds</td>
+ </tr>
+ <tr>
+ <td>transport.vfs.MoveAfterFailedMove</td>
+ <td>The destination to move the file after a failed
move attempt.
+ </td>
+ <td>No</td>
+ <td>N/A</td>
+ </tr>
+ <tr>
+ <td>transport.vfs.MoveFailedRecordTimestampFormat</td>
+ <td>The time stamp format to report the failed move
operation in the log.
+ <div class="xmlConf"><parameter
name="transport.vfs.MoveFailedRecordTimestampFormat">dd/MM/yyyy/
HH:mm:ss</parameter></div>
+ </td>
+ <td>No</td>
+ <td>dd/MM/yyyy/ HH:mm:ss</td>
+ </tr>
</table>
<p><a href="#Contents">[Back to top]</a></p>
</subsection>