org.mule.providers.ftp
Class FtpMessageDispatcher

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

public class FtpMessageDispatcher
extends AbstractMessageDispatcher


Field Summary
protected  FtpConnector connector
           
 
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
FtpMessageDispatcher(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)
          Make a specific request to the underlying transport
protected  UMOMessage doSend(UMOEvent event)
           
 Object getDelegateSession()
          If the underlying transport has the notion of a client session when writing to it, the session should be obtainable using this method.
 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, getConnector, 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
 

Field Detail

connector

protected final FtpConnector connector
Constructor Detail

FtpMessageDispatcher

public FtpMessageDispatcher(UMOImmutableEndpoint endpoint)
Method Detail

doDispose

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

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

doSend

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

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

doReceive

protected UMOMessage doReceive(UMOImmutableEndpoint endpoint,
                               long timeout)
                        throws Exception
Make a specific request to the underlying transport

Specified by:
doReceive in class AbstractMessageDispatcher
Parameters:
endpoint - the endpoint to use when connecting to the resource
timeout - the maximum time the operation should block before returning. The call should return immediately if there is data available. If no data becomes available before the timeout elapses, null will be returned
Returns:
the result of the request wrapped in a UMOMessage object. Null will be returned if no data was avaialable
Throws:
Exception - if the call to the underlying protocal cuases an exception

getDelegateSession

public Object getDelegateSession()
                          throws UMOException
Description copied from interface: UMOMessageDispatcher
If the underlying transport has the notion of a client session when writing to it, the session should be obtainable using this method. If there is no session a null will be returned

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


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