VFS Transport

The Micro Integrator can access the local file system using the VFS transport sender and receiver. This example demonstrates the VFS transport by using the file system as a transport medium.

Synapse configuration

Following are the integration artifacts (proxy service) that we can used to implement this scenario.

    <proxy xmlns="http://ws.apache.org/ns/synapse" name="StockQuoteProxy" transports="vfs">
        <parameter name="transport.vfs.FileURI">file:///home/user/test/in</parameter>  
        <parameter name="transport.vfs.ContentType">text/xml</parameter>
        <parameter name="transport.vfs.FileNamePattern">.*\.xml</parameter>
        <parameter name="transport.PollInterval">15</parameter>
        <parameter name="transport.vfs.MoveAfterProcess">file:///home/user/test/original</parameter> 
        <parameter name="transport.vfs.MoveAfterFailure">file:///home/user/test/original</parameter>
        <parameter name="transport.vfs.ActionAfterProcess">MOVE</parameter>
        <parameter name="transport.vfs.ActionAfterFailure">MOVE</parameter>
                <header name="Action" value="urn:getQuote"/>
                        <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
                <property name="transport.vfs.ReplyFileName"
                          expression="fn:concat(fn:substring-after(get-property('MessageID'), 'urn:uuid:'), '.xml')"
                <property action="set" name="OUT_ONLY" value="true"/>
                        <address uri="vfs:file:///home/user/test/out"/> 
        <publishWSDL uri="conf:custom//sample_proxy_1.wsdl"/>


The VFS transport sender operation is a one-way operation, so it is necessary to use the OUT_ONLY property as mentioned above, before the send mediator.

To configure a VFS endpoint, use the vfs:file prefix in the URI. For example:

    <address uri="vfs:file:///home/user/test/out"/>

Build and run

To test this sample, the following files and directories should be created:

  1. Create the file directories:

    • Create 3 new directories (folders) named in , out, and original in a suitable location in a test directory (e.g., /home/user/test) in the local file system.
    • Be sure to update the in, out, and original directory locations with the values given as the transport.vfs.FileURI, transport.vfs.MoveAfterProcess, transport.vfs.MoveAfterFailure parameter values in your synapse configuration.
    • You need to set both transport.vfs.MoveAfterProcess and transport.vfs.MoveAfterFailure parameter values to point to the original directory location.
    • Be sure that the endpoint in the <outSequence> points to the out directory location. Make sure that the prefix vfs: in the endpoint URL is not removed or changed.
  2. Add sample_proxy_1.wsdl as a registry resource. Change the registry path of the proxy accordingly.

  3. Set up the back-end service.

    • Download the back-end service
    • Extract the downloaded zip file.
    • Open a terminal, navigate to the axis2Server/bin/ directory inside the extracted folder.
    • Execute the following command to start the axis2server with the SimpleStockQuote back-end service:

      sh axis2server.sh
  4. Create the test.xml file shown below and copy it to the location specified by the transport.vfs.FileURI property in the configuration (i.e., the in directory). This contains a simple stock quote request in XML/SOAP format.

    <?xml version='1.0' encoding='UTF-8'?>
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">
            <m0:getQuote xmlns:m0="http://services.samples">

When the sample is executed, the VFS transport listener picks the file from the in directory and sends it to the back service over HTTP. Then the request XML file is moved to the original directory and the response is saved to the out directory.