The Virtual File System (VFS) transport is used by WSO2 Enterprise Integrator(WSO2 EI) to process files in a specified source directory. It supports numerous file systems such as ftp, ftps, sftp, local and samba.
When you work with the VFS transport, you might have a scenario where you need to send large files to a destination. If you use the normal VFS configuration, the memory consumption will be very high since WSO2 EI builds the file inside it. To overcome this issue, WSO2 EI provides VFS file streaming support. With VFS file streaming, only the stream is passed and therefore memory consumption is less.Note that w
| Tip |
|---|
Tip: When you transfer a file to a remote FTP location via VFS, WSO2 EI tries to detect the FTP location by navigating from the root folder first. If the EI does not have at least list permission to the root (/), the file transfer fails. |
To use the streaming mode with the VFS transport, follow the steps below:
In
<EI_HOME>/conf/axis2/axis2.xml, in themessageBuilderssection, add the binary message builder as follows:Code Block language html/xml <messageBuilder contentType="application/binary" class="org.apache.axis2.format.BinaryBuilder"/>
and in the
messageFormatterssection, add the binary message formatter as follows:Code Block language html/xml <messageFormatter contentType="application/binary" class="org.apache.axis2.format.BinaryFormatter"/>
In the proxy service where you use the VFS transport, add the following parameter to enable streaming:
Code Block language html/xml <parameter name="transport.vfs.Streaming">true</parameter>
In the same proxy service, before the Send mediator, add the following property:
Info title Note You also need to add the following property if you want to use the VFS transport to transfer files from VFS to VFS.
Code Block language html/xml <property name="ClientApiNonBlocking" value="true" scope="axis2" action="remove"/>
For more information, see Example 3 of the Send Mediator.
...