This documentation is for WSO2 Enterprise Integrator version 6.0.0 . View documentation for the latest release.

All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This transport is based on the Apache Commons VFS implementation, which is provided in the <EI_HOME>/wso2/components/plugins/commons-vfs<version>.jar file. The transport is a module of the Apache Synapse project, and the synapse-vfs-transport.jar file contains the necessary classes, including those that implement the listener and sender APIs:

...

The VFS transport does not have any global parameters to be configured. Rather, it has a set of service-level parameters that must be specified for each proxy service that uses the VFS transport.

Parameter Name

Description

Required

Possible Values

Default Value

transport.vfs.
FileURI

The URI where the files you want to process are located. You can specify connection-level parameters on the URL (see VFS URL parameters below).

When you need to access the absolute path of the URL, you can define the URL with sftpPathFromRoot:

<parameter name="transport.vfs.FileURI">sftp://[ username[: password]@] hostname[: port][ absolute-path]?sftpPathFromRoot=true</parameter>

Yes

A valid file URI in the following form:
file://<path>

 


transport.vfs.
ContentType

Content type of the files processed by the transport. To specify the encoding, follow the content type with a semi-colon and the character set. For example:

<parameter name="transport.vfs.ContentType“>text/plain;charset=UTF-32</parameter>
When writing a file, you can set a different encoding with the CHARACTER_SET_ENCODING property:
<property name="CHARACTER_SET_ENCODING" value="UTF-8" scope="axis2" type="STRING"/>

Yes

A valid content type for the files (e.g., text/xml). You can specify the encoding after the content type, such as text/plain;charset=UTF-32 

 


transport.vfs.
FileNamePattern

If the VFS listener should process only a subset of the files available at the specified file URI location, use this parameter to select those files by name using a regular expression.

No

A regular expression to select files by name (e.g., *\.xml)

 


transport.
PollInterval

The polling interval for the transport receiver to poll the file URI location. The value is expressed in seconds unless you add "ms" for milliseconds, e.g., "2" or "2000ms" to specify 2 seconds.

No

A positive integer.

 


transport.vfs.
ActionAfterProcess

Whether to move, delete or take no action on the files after the transport has processed them.

No

MOVE, DELETE or NONE

DELETE

transport.vfs.
ActionAfterFailure

Whether to move, delete or take no action on the files if a failure occurs.

No

MOVE, DELETE or NONE

DELETE

transport.vfs.
MoveAfterProcess

Where to move the files after processing if ActionAfterProcess is MOVE.

Yes, if
ActionAfterProcess
is MOVE

A valid file URI

 


transport.vfs.
MoveAfterFailure

Where to move the files after processing if ActionAfterFailure is MOVE.

Yes, if
ActionAfterFailure
is MOVE

A valid file URI

 


transport.vfs.
ReplyFileURI

The location where reply files should be written by the transport.

No

A valid file URI

 


transport.vfs.
ReplyFileName

The name for reply files written by the transport.

No

A valid file name

response.xml

transport.vfs.
MoveTimestampFormat

The pattern/format of the timestamps added to file names as prefixes when moving files.

No

A valid timestamp pattern
(e.g., yyyy-MM-dd'T'HH:mm:ss.SSSZ )

 


transport.vfs.
Streaming

Whether files should be transferred in streaming mode, which is useful when transferring large files

No

true or false

false

transport.vfs.
ReconnectTimeout

Reconnect timeout value in seconds to be used in case of an error when transferring files

No

A positive integer

30 sec

transport.vfs.
MaxRetryCount

Maximum number of retry attempts to carry out in case of errors.

No

A positive integer

3

transport.vfs.Append

When writing the response to a file, whether the response should be appended to the response file instead of overwriting the file. This value should be defined as a query parameter in the out/reply
file URI. For example:
"vfs:file:///home/user/test/out?
transport.vfs.Append=true"

or:

<parameter name="
transport.vfs.ReplyFileURI">
file:///home/user/test/out?
transport.vfs.Append=true
</parameter>

No

true or false

false (the response file will be completely overwritten).

transport.vfs.
MoveAfterFailedMove

Where to move the failed file.

No

A valid file URI

 


transport.vfs.
FailedRecordsFileName

The name of the file that maintains
the list of failed files.

No

A valid file name

vfs-move-failed-records.
properties

transport.vfs.
FailedRecordsFile
Destination

Where to store the failed records file.

No

A folder URI


transport.vfs.
MoveFailedRecord
TimestampFormat

Entries in the failed records file include the name of the file that failed and the timestamp of its failure. This property configures the time stamp format.

No

A valid timestamp pattern
(e.g., yyyy-MM-dd'T'HH:mm:ss.SSSZ )

dd-MM-yyyy HH:mm:ss

transport.vfs.
FailedRecordNext
RetryDuration

The time in milliseconds to wait before retrying the move task.

No

A positive integer

3000 milliseconds

transport.vfs.Locking

By default, file locking is enabled in the VFS transport. This parameter lets you configure the locking behavior on a per service basis. You can also disable locking globally by specifying the parameter at the receiver level and selectively enable locking only for a set of services.

No

enable or disable

enable

transport.vfs.
FileProcessCount
This setting allows you to throttle the VFS listener by processing files in batches. Specify the number of files you want to process in each batch.NoA positive integer, such as 10N/A
transport.vfs.
FileProcessInterval
The interval in milliseconds between two file processes.NoA positive integer, such as 1000N/A
transport.vfs.ClusterAwareWhether VFS coordination support is enabled in a clustered deployment or not.Notrue or falsefalse
transport.vfs.FileSizeLimitOnly file sizes that are less than or equal to the defined limit
will be
are processed. NoFile size in bytes

-1(unlimited file size)

transport.vfs.AutoLockReleaseInterval

The timeout value for stale locks where the VFS transport will ignore those file locks once the defined time period is reached. (The time period is calculated from the time the lock is created to the time you attempt to access it.)

If you need stale locks to never timeout provide -1 as the timeout value.

NoTime in milliseconds20000
transport.vfs.SFTPIdentitiesLocation of the private keyNoA valid file pathN/A
transport.vfs.SFTPIdentityPassPhrasePassphrase of the private keyNoA valid passphraseN/A
transport.vfs.SFTPUserDirIsRootIf the SFTP user directory should be treated as rootNotrue or falsetrue

Anchor
URLparams
URLparams

VFS URL parameters

...

Following are details on the URL parameters you can set. To configure the proxy over ftp/sftp click here.

Parameter Name

Description

Possible Values

Default Value

vfs.passive

Enable FTP passive mode. This is required when the FTP client and server are not in the same network.

true | falsefalse
transport. vfs . AppendIf file with same name exists, this parameter tells whether to create a new file and write content or append content to existing file

true | false

false
vfs.protection

Set data channel protection level using FTP PROT command

  • C - Clear
  • S - Safe(SSL protocol only)
  • E - Confidential(SSL protocol only)
  • P - Private
C
vfs.ssl.keystorePrivate key store to use for mutual SSL. Your keystore must be signed by a certificate authority. For more information, see http://docs.oracle.com/cd/E19509-01/820-3503/ggfen/index.html.String - Path of keystore
 

vfs.ssl.kspasswordPrivate key store passwordString
 

vfs.ssl.keypasswordPrivate key passwordString
 

vfs.ssl.truststoreTrust store to use for FTPSString - Path of keystore
 

vfs.ssl.tspasswordTrust store passwordString
 

transport.vfs.CreateFolderIf the directory does not exists create and write the filetrue | falsefalse
transport. vfs.SendFileSynchronouslyWhether to send files synchronously to the file host. When this parameter is set to true, files will be sent one after another to the file host. This synchronous write can be configured on a per host basis.true | falsefalse

Samples