Package org.apache.synapse.transport.vfs

Class VFSTransportListener

  • All Implemented Interfaces:
    org.apache.axis2.transport.base.ManagementSupport, org.apache.axis2.transport.TransportListener
    public class VFSTransportListener
extends org.apache.axis2.transport.base.AbstractPollingTransportListener<PollTableEntry>
implements org.apache.axis2.transport.base.ManagementSupport
    The "vfs" transport is a polling based transport - i.e. it gets kicked off at specified periodic durations, and would iterate through a list of directories or files specified according to poll durations. When scanning a directory, it will match its contents against a given regex to find the set of input files. For compressed files, the contents could be matched against a regex to find individual files. Each of these files thus found would be submitted as an Axis2 "message" into the Axis2 engine. The processed files would be deleted or renamed as specified in the configuration Supported VFS example URIs file:///directory/filename.ext file:////somehost/someshare/afile.txt jar:../lib/classes.jar!/META-INF/manifest.mf zip:http://somehost/downloads/somefile.zip jar:zip:outer.zip!/nested.jar!/somedir jar:zip:outer.zip!/nested.jar!/some%21dir tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile gz:/my/gz/file.gz http://somehost:8080/downloads/somefile.jar http://myusername@somehost/index.html webdav://somehost:8080/dist ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz[?passive=true] sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz smb://somehost/home axis2.xml - transport definition enable|disable ? services.xml - service attachment required parameters .. .. optional parameters .. .. .. .. .. .. .. FTP testing URIs ftp://ftpuser:password@asankha/somefile.csv?passive=true ftp://vfs:apache@vfs.netfirms.com/somepath/somefile.xml?passive=true

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String DELETE  
      static String MOVE  
      static String NONE  
      static String TRANSPORT_NAME  

      • Fields inherited from class org.apache.axis2.transport.base.AbstractTransportListener

        cfgCtx, config, isNonBlocking, log, metrics, state, useAxis2ThreadPool

      • Fields inherited from interface org.apache.axis2.transport.TransportListener

        HOST_ADDRESS, PARAM_PORT

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected PollTableEntry createEndpoint()  
      void destroy()  
      protected void doInit()  
      boolean isFileSystemClosed()  
      protected void poll​(PollTableEntry entry)  
      void setFileSystemClosed​(boolean fileSystemClosed)  
      protected void stopEndpoint​(PollTableEntry endpoint)  

      • Methods inherited from class org.apache.axis2.transport.base.AbstractPollingTransportListener

        maintenenceShutdown, onPollCompletion, pause, processFailure, resume, startEndpoint

      • Methods inherited from class org.apache.axis2.transport.base.AbstractTransportListenerEx

        getEndpoints, getEPRsForService, init, start, startListeningForService, stop, stopListeningForService

      • Methods inherited from class org.apache.axis2.transport.base.AbstractTransportListener

        createMessageContext, disableTransportForService, getActiveThreadCount, getAvgSizeReceived, getAvgSizeSent, getBytesReceived, getBytesSent, getConfigurationContext, getEPRForService, getEPRsForService, getFaultsReceiving, getFaultsSending, getLastResetTime, getMaxSizeReceived, getMaxSizeSent, getMessagesReceived, getMessagesSent, getMetricsCollector, getMetricsWindow, getMinSizeReceived, getMinSizeSent, getQueueSize, getResponseCodeTable, getSessionContext, getTimeoutsReceiving, getTimeoutsSending, getTransportInDescription, getTransportName, handleException, handleIncomingMessage, logException, resetStatistics

      • Methods inherited from interface org.apache.axis2.transport.base.ManagementSupport

        getActiveThreadCount, getAvgSizeReceived, getAvgSizeSent, getBytesReceived, getBytesSent, getFaultsReceiving, getFaultsSending, getLastResetTime, getMaxSizeReceived, getMaxSizeSent, getMessagesReceived, getMessagesSent, getMetricsWindow, getMinSizeReceived, getMinSizeSent, getQueueSize, getResponseCodeTable, getTimeoutsReceiving, getTimeoutsSending, maintenenceShutdown, pause, resetStatistics, resume

    • Constructor Detail

      • VFSTransportListener

        public VFSTransportListener()

    • Method Detail

      • doInit

        protected void doInit()
               throws org.apache.axis2.AxisFault
        Overrides:
        doInit in class org.apache.axis2.transport.base.AbstractPollingTransportListener<PollTableEntry>
        Throws:
        org.apache.axis2.AxisFault

      • poll

        protected void poll​(PollTableEntry entry)
        Specified by:
        poll in class org.apache.axis2.transport.base.AbstractPollingTransportListener<PollTableEntry>

      • destroy

        public void destroy()
        Specified by:
        destroy in interface org.apache.axis2.transport.TransportListener
        Overrides:
        destroy in class org.apache.axis2.transport.base.AbstractPollingTransportListener<PollTableEntry>

      • createEndpoint

        protected PollTableEntry createEndpoint()
        Specified by:
        createEndpoint in class org.apache.axis2.transport.base.AbstractTransportListenerEx<PollTableEntry>

      • stopEndpoint

        protected void stopEndpoint​(PollTableEntry endpoint)
        Overrides:
        stopEndpoint in class org.apache.axis2.transport.base.AbstractPollingTransportListener<PollTableEntry>

      • isFileSystemClosed

        public boolean isFileSystemClosed()

      • setFileSystemClosed

        public void setFileSystemClosed​(boolean fileSystemClosed)