org.mule.providers.file
Class FileMessageDispatcher

java.lang.Object
  extended byorg.mule.providers.AbstractMessageDispatcher
      extended byorg.mule.providers.file.FileMessageDispatcher
All Implemented Interfaces:
Disposable, ExceptionListener, UMOConnectable, UMOMessageDispatcher

public class FileMessageDispatcher
extends AbstractMessageDispatcher

FileMessageDispatcher is used to read/write files to the filesystem


Field Summary
 
Fields inherited from class org.mule.providers.AbstractMessageDispatcher
connected, connectionStrategy, disposed, doThreading, endpoint, logger, workManager
 
Fields inherited from interface org.mule.umo.provider.UMOMessageDispatcher
RECEIVE_NO_WAIT, RECEIVE_WAIT_INDEFINITELY
 
Constructor Summary
FileMessageDispatcher(UMOImmutableEndpoint endpoint)
           
 
Method Summary
protected  void doConnect(UMOImmutableEndpoint endpoint)
           
protected  void doDisconnect()
           
protected  void doDispatch(UMOEvent event)
           
protected  void doDispose()
           
protected  UMOMessage doReceive(UMOImmutableEndpoint endpoint, long timeout)
          Will attempt to do a receive from a directory, if the endpointUri resolves to a file name the file will be returned, otherwise the first file in the directory according to the filename filter configured on the connector.
protected  UMOMessage doSend(UMOEvent event)
           
 UMOConnector getConnector()
          Gets the connector for this dispatcher
 Object getDelegateSession()
          There is no associated session for a file connector
 OutputStream getOutputStream(UMOImmutableEndpoint endpoint, UMOMessage message)
          Well get the output stream (if any) for this type of transport.
 
Methods inherited from class org.mule.providers.AbstractMessageDispatcher
connect, disconnect, dispatch, dispose, exceptionThrown, getConnectEventId, getConnectionDescription, isConnected, isDisposed, isTransactionRollback, receive, receive, reconnect, send, useRemoteSync
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileMessageDispatcher

public FileMessageDispatcher(UMOImmutableEndpoint endpoint)
Method Detail

doDispatch

protected void doDispatch(UMOEvent event)
                   throws Exception
Specified by:
doDispatch in class AbstractMessageDispatcher
Throws:
Exception

getOutputStream

public OutputStream getOutputStream(UMOImmutableEndpoint endpoint,
                                    UMOMessage message)
                             throws UMOException
Well get the output stream (if any) for this type of transport. Typically this will be called only when Streaming is being used on an outbound endpoint

Specified by:
getOutputStream in interface UMOMessageDispatcher
Overrides:
getOutputStream in class AbstractMessageDispatcher
Parameters:
endpoint - the endpoint that releates to this Dispatcher
message - the current message being processed
Returns:
the output stream to use for this request or null if the transport does not support streaming
Throws:
UMOException

getDelegateSession

public Object getDelegateSession()
                          throws UMOException
There is no associated session for a file connector

Returns:
the transport specific session or null if there is no session
Throws:
UMOException

doReceive

protected UMOMessage doReceive(UMOImmutableEndpoint endpoint,
                               long timeout)
                        throws Exception
Will attempt to do a receive from a directory, if the endpointUri resolves to a file name the file will be returned, otherwise the first file in the directory according to the filename filter configured on the connector.

Specified by:
doReceive in class AbstractMessageDispatcher
Parameters:
endpoint - an endpoint a path to a file or directory
timeout - this is ignored when doing a receive on this dispatcher
Returns:
a message containing file contents or null if there was notthing to receive
Throws:
Exception

doSend

protected UMOMessage doSend(UMOEvent event)
                     throws Exception
Specified by:
doSend in class AbstractMessageDispatcher
Throws:
Exception

getConnector

public UMOConnector getConnector()
Description copied from interface: UMOMessageDispatcher
Gets the connector for this dispatcher

Specified by:
getConnector in interface UMOMessageDispatcher
Overrides:
getConnector in class AbstractMessageDispatcher

doDispose

protected void doDispose()
Specified by:
doDispose in class AbstractMessageDispatcher

doConnect

protected void doConnect(UMOImmutableEndpoint endpoint)
                  throws Exception
Specified by:
doConnect in class AbstractMessageDispatcher
Throws:
Exception

doDisconnect

protected void doDisconnect()
                     throws Exception
Specified by:
doDisconnect in class AbstractMessageDispatcher
Throws:
Exception


Copyright © 2003-2006 MuleSource Inc.. All Rights Reserved.