org.mule.transport.ftp

Class FtpMessageRequester

java.lang.Object

org.mule.transport.AbstractTransportMessageHandler

org.mule.transport.AbstractMessageRequester

org.mule.transport.ftp.FtpMessageRequester

All Implemented Interfaces:

Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, Connectable, MessageRequester, MessageRequesting

public class FtpMessageRequester
extends AbstractMessageRequester

Field Summary

Fields

Modifier and Type	Field and Description
protected FtpConnector	connector

Fields inherited from class org.mule.transport.AbstractTransportMessageHandler

connected, defaultMessageInfoMapping, endpoint, lifecycleManager, logger, muleMessageFactory, retryTemplate

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.api.transport.MessageRequesting

REQUEST_NO_WAIT, REQUEST_WAIT_INDEFINITELY

Constructor Summary

Constructors

Constructor and Description
FtpMessageRequester(InboundEndpoint endpoint)

Method Summary

Methods

Modifier and Type	Method and Description
protected FtpMuleMessageFactory	createMuleMessageFactory(org.apache.commons.net.ftp.FTPClient client)
protected void	doConnect()
protected void	doDisconnect()
protected void	doDispose()
protected MuleMessage	doRequest(long timeout) Make a specific request to the underlying transport
protected org.apache.commons.net.ftp.FTPFile	findFileToProcess(org.apache.commons.net.ftp.FTPClient client)
protected FilenameFilter	getFilenameFilter()
protected void	initializeMessageFactory() Subclasses can override this method to create a custom MuleMessageFactory instead of re-using the instance from the connector.
protected boolean	isValid(org.apache.commons.net.ftp.FTPFile file, FilenameFilter filenameFilter)
protected org.apache.commons.net.ftp.FTPFile[]	listFiles(org.apache.commons.net.ftp.FTPClient client)
protected void	postProcess(org.apache.commons.net.ftp.FTPClient client, org.apache.commons.net.ftp.FTPFile file, MuleMessage message)
protected org.apache.commons.net.ftp.FTPFile	prepareFile(org.apache.commons.net.ftp.FTPClient client, org.apache.commons.net.ftp.FTPFile file)

Methods inherited from class org.mule.transport.AbstractMessageRequester

applyInboundTransformers, createLifecycleManager, getEndpoint, getRequesterName, getWorkManager, initialise, request

Methods inherited from class org.mule.transport.AbstractTransportMessageHandler

activate, connect, connectHandler, createMuleMessage, createMuleMessage, createMuleMessage, createMuleMessageFactory, createNullMuleMessage, disconnect, dispose, disposeAndLogException, doInitialise, doStart, doStartHandler, doStop, getConnectEventId, getConnectionDescription, getConnector, getLifecycleState, initializeRetryPolicy, isConnected, isDoThreading, isStarted, isStarting, isStopped, isStopping, passivate, setEndpoint, start, stop, toString, 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.MessageRequester

activate, createMuleMessage, createMuleMessage, getConnector, passivate, validate

Methods inherited from interface org.mule.api.transport.Connectable

connect, disconnect, getConnectionDescription, isConnected, validateConnection

Methods inherited from interface org.mule.api.lifecycle.Startable

start

Methods inherited from interface org.mule.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.api.lifecycle.LifecycleStateEnabled

getLifecycleState

Field Detail

connector

protected final FtpConnector connector

Constructor Detail

FtpMessageRequester

public FtpMessageRequester(InboundEndpoint endpoint)

Method Detail

doDispose

protected void doDispose()

Overrides:

doDispose in class AbstractTransportMessageHandler

doConnect

protected void doConnect()
                  throws Exception

Overrides:

doConnect in class AbstractTransportMessageHandler

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Overrides:

doDisconnect in class AbstractTransportMessageHandler

Throws:

Exception

doRequest

protected MuleMessage doRequest(long timeout)
                         throws Exception

Make a specific request to the underlying transport

Specified by:

doRequest in class AbstractMessageRequester

Parameters:

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 MuleMessage object. null will be returned if no data was avaialable

Throws:

Exception - if the call to the underlying protocol cuases an exception

postProcess

protected void postProcess(org.apache.commons.net.ftp.FTPClient client,
               org.apache.commons.net.ftp.FTPFile file,
               MuleMessage message)
                    throws Exception

Throws:

Exception

initializeMessageFactory

protected void initializeMessageFactory()
                                 throws InitialisationException

Description copied from class: AbstractTransportMessageHandler

Subclasses can override this method to create a custom MuleMessageFactory instead of re-using the instance from the connector.

Overrides:

initializeMessageFactory in class AbstractTransportMessageHandler

Throws:

InitialisationException

createMuleMessageFactory

protected FtpMuleMessageFactory createMuleMessageFactory(org.apache.commons.net.ftp.FTPClient client)
                                                  throws CreateException

Throws:

CreateException

prepareFile

protected org.apache.commons.net.ftp.FTPFile prepareFile(org.apache.commons.net.ftp.FTPClient client,
                                             org.apache.commons.net.ftp.FTPFile file)
                                                  throws IOException

Throws:

IOException

findFileToProcess

protected org.apache.commons.net.ftp.FTPFile findFileToProcess(org.apache.commons.net.ftp.FTPClient client)
                                                        throws Exception

Throws:

Exception

isValid

protected boolean isValid(org.apache.commons.net.ftp.FTPFile file,
              FilenameFilter filenameFilter)

listFiles

protected org.apache.commons.net.ftp.FTPFile[] listFiles(org.apache.commons.net.ftp.FTPClient client)
                                                  throws IOException

Throws:

IOException

getFilenameFilter

protected FilenameFilter getFilenameFilter()