org.mule.providers.file
Class FileMessageReceiver

java.lang.Object
  org.mule.providers.AbstractMessageReceiver
      org.mule.providers.AbstractPollingMessageReceiver
          org.mule.providers.file.FileMessageReceiver

All Implemented Interfaces:

Runnable, javax.resource.spi.work.Work, org.mule.umo.lifecycle.Disposable, org.mule.umo.lifecycle.Lifecycle, org.mule.umo.lifecycle.Startable, org.mule.umo.lifecycle.Stoppable, org.mule.umo.provider.UMOConnectable, org.mule.umo.provider.UMOMessageReceiver

public class FileMessageReceiver
extends org.mule.providers.AbstractPollingMessageReceiver

FileMessageReceiver is a polling listener that reads files from a directory.

Field Summary

Fields inherited from class org.mule.providers.AbstractPollingMessageReceiver

DEFAULT_POLL_FREQUENCY, frequency, schedules, STARTUP_DELAY

Fields inherited from class org.mule.providers.AbstractMessageReceiver

component, connected, connecting, connectionStrategy, connector, disposing, endpoint, logger, receiverKey, stopped

Constructor Summary

FileMessageReceiver(org.mule.umo.provider.UMOConnector connector, org.mule.umo.UMOComponent component, org.mule.umo.endpoint.UMOEndpoint endpoint, String readDir, String moveDir, String moveToPattern, long frequency)

Method Summary

protected boolean	attemptFileLock(File sourceFile) Try to acquire a lock on a file and release it immediately.
protected void	doConnect()
protected void	doDisconnect()
protected void	doDispose()
protected boolean	moveFile(File sourceFile, File destinationFile) Try to move a file by renaming with backup attempt by copying/deleting via NIO
void	poll()
void	processFile(File sourceFile)
protected boolean	rollbackFileMove(File sourceFile, String destinationFilePath) Exception tolerant roll back method

Methods inherited from class org.mule.providers.AbstractPollingMessageReceiver

doStart, doStop, getFrequency, release, run, setFrequency

Methods inherited from class org.mule.providers.AbstractMessageReceiver

applyResponseTransformer, connect, disconnect, dispose, getComponent, getConnectEventId, getConnectionDescription, getConnector, getEndpoint, getEndpointURI, getListener, getReceiverKey, getWorkManager, handleException, handleUnacceptedFilter, isConnected, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setComponent, setConnector, setEndpoint, setExceptionDetails, setListener, setReceiverKey, setWorkManager, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileMessageReceiver

public FileMessageReceiver(org.mule.umo.provider.UMOConnector connector,
                           org.mule.umo.UMOComponent component,
                           org.mule.umo.endpoint.UMOEndpoint endpoint,
                           String readDir,
                           String moveDir,
                           String moveToPattern,
                           long frequency)
                    throws org.mule.umo.lifecycle.InitialisationException

Throws:

org.mule.umo.lifecycle.InitialisationException

Method Detail

doConnect

protected void doConnect()
                  throws Exception

Specified by:

doConnect in class org.mule.providers.AbstractMessageReceiver

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Specified by:

doDisconnect in class org.mule.providers.AbstractMessageReceiver

Throws:

Exception

doDispose

protected void doDispose()

Specified by:

doDispose in class org.mule.providers.AbstractMessageReceiver

poll

public void poll()

Specified by:

poll in class org.mule.providers.AbstractPollingMessageReceiver

processFile

public void processFile(File sourceFile)
                 throws org.mule.umo.UMOException

Throws:

org.mule.umo.UMOException

attemptFileLock

protected boolean attemptFileLock(File sourceFile)

Try to acquire a lock on a file and release it immediately. Usually used as a quick check to see if another process is still holding onto the file, e.g. a large file (more than 100MB) is still being written to.

Parameters:

sourceFile - file to check

Returns:

true if the file can be locked

moveFile

protected boolean moveFile(File sourceFile,
                           File destinationFile)

Try to move a file by renaming with backup attempt by copying/deleting via NIO

rollbackFileMove

protected boolean rollbackFileMove(File sourceFile,
                                   String destinationFilePath)

Exception tolerant roll back method