org.mule.providers.file
Class FileMessageDispatcher

java.lang.Object
  org.mule.providers.AbstractMessageDispatcher
      org.mule.providers.file.FileMessageDispatcher

All Implemented Interfaces:

org.mule.umo.lifecycle.Disposable, ExceptionListener, org.mule.umo.provider.UMOConnectable, org.mule.umo.provider.UMOMessageDispatcher

public class FileMessageDispatcher

extends org.mule.providers.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(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)

Method Summary

protected void	doConnect(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)
protected void	doDisconnect()
protected void	doDispatch(org.mule.umo.UMOEvent event)
protected void	doDispose()
protected org.mule.umo.UMOMessage	doReceive(org.mule.umo.endpoint.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 org.mule.umo.UMOMessage	doSend(org.mule.umo.UMOEvent event)
org.mule.umo.provider.UMOConnector	getConnector()
Object	getDelegateSession() There is no associated session for a file connector
OutputStream	getOutputStream(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint, org.mule.umo.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(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)

Method Detail

doDispatch

protected void doDispatch(org.mule.umo.UMOEvent event)
                   throws Exception

Throws:

Exception

getOutputStream

public OutputStream getOutputStream(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint,
                                    org.mule.umo.UMOMessage message)
                             throws org.mule.umo.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

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:

org.mule.umo.UMOException

getDelegateSession

public Object getDelegateSession()
                          throws org.mule.umo.UMOException

There is no associated session for a file connector

Returns:

Throws:

org.mule.umo.UMOException

doReceive

protected org.mule.umo.UMOMessage doReceive(org.mule.umo.endpoint.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.

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 org.mule.umo.UMOMessage doSend(org.mule.umo.UMOEvent event)
                                  throws Exception

Throws:

Exception

getConnector

public org.mule.umo.provider.UMOConnector getConnector()

doDispose

protected void doDispose()

doConnect

protected void doConnect(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)
                  throws Exception

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Throws:

Exception