org.mule.transport.file
Class FileMessageReceiver

java.lang.Object
  extended by org.mule.transport.AbstractConnectable
      extended by org.mule.transport.AbstractMessageReceiver
          extended by org.mule.transport.AbstractPollingMessageReceiver
              extended by org.mule.transport.file.FileMessageReceiver
All Implemented Interfaces:
ExceptionListener, Disposable, Initialisable, Startable, Stoppable, Connectable, MessageReceiver

public class FileMessageReceiver
extends AbstractPollingMessageReceiver

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


Field Summary
static String COMPARATOR_CLASS_NAME_PROPERTY
           
static String COMPARATOR_REVERSE_ORDER_PROPERTY
           
 
Fields inherited from class org.mule.transport.AbstractPollingMessageReceiver
DEFAULT_POLL_FREQUENCY, DEFAULT_POLL_TIMEUNIT, DEFAULT_STARTUP_DELAY, schedules
 
Fields inherited from class org.mule.transport.AbstractMessageReceiver
receiverKey, responseEndpoint, service
 
Fields inherited from class org.mule.transport.AbstractConnectable
connected, connector, disposed, endpoint, logger, retryTemplate, started, startOnConnect
 
Fields inherited from interface org.mule.api.lifecycle.Initialisable
PHASE_NAME
 
Fields inherited from interface org.mule.api.lifecycle.Disposable
PHASE_NAME
 
Fields inherited from interface org.mule.api.lifecycle.Startable
PHASE_NAME
 
Fields inherited from interface org.mule.api.lifecycle.Stoppable
PHASE_NAME
 
Constructor Summary
FileMessageReceiver(Connector connector, Service service, InboundEndpoint 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  Comparator getComparator()
           
 void poll()
           
 void processFile(File sourceFile)
           
protected  boolean rollbackFileMove(File sourceFile, String destinationFilePath)
          Exception tolerant roll back method
 
Methods inherited from class org.mule.transport.AbstractPollingMessageReceiver
createWork, doStart, doStop, getFrequency, getTimeUnit, schedule, setFrequency, setTimeUnit, unschedule
 
Methods inherited from class org.mule.transport.AbstractMessageReceiver
dispose, getConnectEventId, getConnectionDescription, getEndpoint, getEndpointURI, getListener, getReceiverKey, getService, getWorkManager, handleUnacceptedFilter, initialise, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setEndpoint, setExceptionDetails, setListener, setReceiverKey, setService, toString
 
Methods inherited from class org.mule.transport.AbstractConnectable
activate, connect, disconnect, disposeAndLogException, doInitialise, exceptionThrown, getConnectEventId, getConnector, handleException, isConnected, isDoThreading, isStarted, passivate, setEndpoint, start, stop, validate, validateConnection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.mule.api.transport.Connectable
connect, disconnect, isConnected, validateConnection
 
Methods inherited from interface org.mule.api.lifecycle.Startable
start
 
Methods inherited from interface org.mule.api.lifecycle.Stoppable
stop
 

Field Detail

COMPARATOR_CLASS_NAME_PROPERTY

public static final String COMPARATOR_CLASS_NAME_PROPERTY
See Also:
Constant Field Values

COMPARATOR_REVERSE_ORDER_PROPERTY

public static final String COMPARATOR_REVERSE_ORDER_PROPERTY
See Also:
Constant Field Values
Constructor Detail

FileMessageReceiver

public FileMessageReceiver(Connector connector,
                           Service service,
                           InboundEndpoint endpoint,
                           String readDir,
                           String moveDir,
                           String moveToPattern,
                           long frequency)
                    throws CreateException
Throws:
CreateException
Method Detail

doConnect

protected void doConnect()
                  throws Exception
Overrides:
doConnect in class AbstractConnectable
Throws:
Exception

doDisconnect

protected void doDisconnect()
                     throws Exception
Overrides:
doDisconnect in class AbstractConnectable
Throws:
Exception

doDispose

protected void doDispose()
Overrides:
doDispose in class AbstractConnectable

poll

public void poll()
Specified by:
poll in class AbstractPollingMessageReceiver

processFile

public void processFile(File sourceFile)
                 throws MuleException
Throws:
MuleException

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

rollbackFileMove

protected boolean rollbackFileMove(File sourceFile,
                                   String destinationFilePath)
Exception tolerant roll back method


getComparator

protected Comparator getComparator()
                            throws Exception
Throws:
Exception


Copyright © 2003-2009 MuleSource, Inc.. All Rights Reserved.