org.mule.providers.ftp
Class FtpConnector

java.lang.Object
  org.mule.providers.AbstractConnector
      org.mule.providers.ftp.FtpConnector

All Implemented Interfaces:

Disposable, EventListener, ExceptionListener, Initialisable, UMOConnectable, UMOConnector, WorkListener

public class FtpConnector

extends AbstractConnector

Field Summary

static String	DEFAULT_FTP_CONNECTION_FACTORY_CLASS TODO it makes sense to have a type-safe adapter for FTP specifically, but without Java 5's covariant return types the benefits are diminished.
static int	DEFAULT_POLLING_FREQUENCY
static String	PROPERTY_BINARY_TRANSFER
static String	PROPERTY_FILENAME
static String	PROPERTY_OUTPUT_PATTERN
static String	PROPERTY_PASSIVE_MODE
static String	PROPERTY_POLLING_FREQUENCY

Fields inherited from class org.mule.providers.AbstractConnector

connected, connecting, connectionStrategy, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, disposing, exceptionListener, initialised, logger, name, numberOfConcurrentTransactedReceivers, receivers, serviceDescriptor, serviceOverrides, sessionHandler, started, startOnConnect

Fields inherited from interface org.mule.umo.provider.UMOConnector

INT_VALUE_NOT_SET

Constructor Summary

FtpConnector()

Method Summary

UMOMessageReceiver	createReceiver(UMOComponent component, UMOEndpoint endpoint) Create a Message receiver for this connector
void	destroyFtp(UMOEndpointURI uri, org.apache.commons.net.ftp.FTPClient client)
protected void	doConnect() Template method where any connections should be made for the connector
protected void	doDisconnect() Template method where any connected resources used by the connector should be disconnected
protected void	doDispose() Template method to perform any work when destroying the connectoe
protected void	doInitialise()
protected void	doStart() Template method to perform any work when starting the connectoe
protected void	doStop() Template method to perform any work when stopping the connectoe
void	enterActiveOrPassiveMode(org.apache.commons.net.ftp.FTPClient client, UMOImmutableEndpoint endpoint) Passive mode is OFF by default.
String	getConnectionFactoryClass() Getter for property 'connectionFactoryClass'.
FilenameParser	getFilenameParser()
org.apache.commons.net.ftp.FTPClient	getFtp(UMOEndpointURI uri)
protected ObjectPool	getFtpPool(UMOEndpointURI uri)
String	getOutputPattern()
OutputStream	getOutputStream(UMOImmutableEndpoint endpoint, UMOMessage message) Well get the output stream (if any) for this type of transport.
long	getPollingFrequency()
String	getProtocol()
boolean	isBinary() Getter for FTP transfer type.
boolean	isPassive() Getter for FTP passive mode.
boolean	isValidateConnections() Whether to test FTP connection on each take from pool.
void	releaseFtp(UMOEndpointURI uri, org.apache.commons.net.ftp.FTPClient client)
void	setBinary(boolean binary) Setter for FTP transfer type.
void	setConnectionFactoryClass(String connectionFactoryClass) Setter for property 'connectionFactoryClass'.
void	setFilenameParser(FilenameParser filenameParser)
void	setOutputPattern(String outputPattern)
void	setPassive(boolean passive) Setter for FTP passive mode.
void	setPollingFrequency(long pollingFrequency)
void	setupFileType(org.apache.commons.net.ftp.FTPClient client, UMOImmutableEndpoint endpoint) Transfer type is BINARY by default.
void	setValidateConnections(boolean validateConnections) Whether to test FTP connection on each take from pool.

Methods inherited from class org.mule.providers.AbstractConnector

checkDisposed, connect, destroyReceiver, disconnect, dispatch, dispose, disposeDispatchers, disposeReceivers, disposeWorkManagers, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getConnectionStrategy, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcherFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getExceptionListener, getMaxDispatchersActive, getMessageAdapter, getName, getNumberOfConcurrentTransactedReceivers, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getStreamMessageAdapter, getSupportedProtocols, handleException, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, isConnected, isCreateMultipleTransactedReceivers, isDisposed, isDisposing, isEnableMessageEvents, isRemoteSyncEnabled, isStarted, lookupReceiver, receive, receive, registerListener, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, send, setConnectionStrategy, setCreateMultipleTransactedReceivers, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setEnableMessageEvents, setExceptionListener, setMaxDispatchersActive, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setServiceOverrides, setSessionHandler, setSupportedProtocols, startConnector, stopConnector, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_POLLING_FREQUENCY

public static final String PROPERTY_POLLING_FREQUENCY

See Also:

Constant Field Values

PROPERTY_FILENAME

public static final String PROPERTY_FILENAME

See Also:

Constant Field Values

PROPERTY_OUTPUT_PATTERN

public static final String PROPERTY_OUTPUT_PATTERN

See Also:

Constant Field Values

PROPERTY_PASSIVE_MODE

public static final String PROPERTY_PASSIVE_MODE

See Also:

Constant Field Values

PROPERTY_BINARY_TRANSFER

public static final String PROPERTY_BINARY_TRANSFER

See Also:

Constant Field Values

DEFAULT_POLLING_FREQUENCY

public static final int DEFAULT_POLLING_FREQUENCY

See Also:

Constant Field Values

DEFAULT_FTP_CONNECTION_FACTORY_CLASS

public static final String DEFAULT_FTP_CONNECTION_FACTORY_CLASS

TODO it makes sense to have a type-safe adapter for FTP specifically, but without Java 5's covariant return types the benefits are diminished. Keeping it simple for now.

See Also:

Constant Field Values

Constructor Detail

FtpConnector

public FtpConnector()

Method Detail

getProtocol

public String getProtocol()

Returns:

the primary protocol name for endpoints of this connector

createReceiver

public UMOMessageReceiver createReceiver(UMOComponent component,
                                         UMOEndpoint endpoint)
                                  throws Exception

Description copied from class: AbstractConnector

Create a Message receiver for this connector

Overrides:

createReceiver in class AbstractConnector

Parameters:

component - the component that will receive events from this receiver, the listener

endpoint - the endpoint that defies this inbound communication

Returns:

an instance of the message receiver defined in this connectors' TransportServiceDescriptor initialised using the component and endpoint.

Throws:

Exception - if there is a problem creating the receiver. This exception really depends on the underlying transport, thus any exception could be thrown

getPollingFrequency

public long getPollingFrequency()

Returns:

Returns the pollingFrequency.

setPollingFrequency

public void setPollingFrequency(long pollingFrequency)

Parameters:

pollingFrequency - The pollingFrequency to set.

getConnectionFactoryClass

public String getConnectionFactoryClass()

Getter for property 'connectionFactoryClass'.

Returns:

Value for property 'connectionFactoryClass'.

setConnectionFactoryClass

public void setConnectionFactoryClass(String connectionFactoryClass)

Setter for property 'connectionFactoryClass'. Should be an instance of FtpConnectionFactory.

Parameters:

connectionFactoryClass - Value to set for property 'connectionFactoryClass'.

getFtp

public org.apache.commons.net.ftp.FTPClient getFtp(UMOEndpointURI uri)
                                            throws Exception

Throws:

Exception

releaseFtp

public void releaseFtp(UMOEndpointURI uri,
                       org.apache.commons.net.ftp.FTPClient client)
                throws Exception

Throws:

Exception

destroyFtp

public void destroyFtp(UMOEndpointURI uri,
                       org.apache.commons.net.ftp.FTPClient client)
                throws Exception

Throws:

Exception

getFtpPool

protected ObjectPool getFtpPool(UMOEndpointURI uri)

doInitialise

protected void doInitialise()
                     throws InitialisationException

Specified by:

doInitialise in class AbstractConnector

Throws:

InitialisationException

doDispose

protected void doDispose()

Description copied from class: AbstractConnector

Template method to perform any work when destroying the connectoe

Specified by:

doDispose in class AbstractConnector

doConnect

protected void doConnect()
                  throws Exception

Description copied from class: AbstractConnector

Template method where any connections should be made for the connector

Specified by:

doConnect in class AbstractConnector

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractConnector

Template method where any connected resources used by the connector should be disconnected

Specified by:

doDisconnect in class AbstractConnector

Throws:

Exception

doStart

protected void doStart()
                throws UMOException

Description copied from class: AbstractConnector

Template method to perform any work when starting the connectoe

Specified by:

doStart in class AbstractConnector

Throws:

UMOException - if the method fails

doStop

protected void doStop()
               throws UMOException

Description copied from class: AbstractConnector

Template method to perform any work when stopping the connectoe

Specified by:

doStop in class AbstractConnector

Throws:

UMOException - if the method fails

getOutputPattern

public String getOutputPattern()

Returns:

Returns the outputPattern.

setOutputPattern

public void setOutputPattern(String outputPattern)

Parameters:

outputPattern - The outputPattern to set.

getFilenameParser

public FilenameParser getFilenameParser()

Returns:

Returns the filenameParser.

setFilenameParser

public void setFilenameParser(FilenameParser filenameParser)

Parameters:

filenameParser - The filenameParser to set.

isPassive

public boolean isPassive()

Getter for FTP passive mode.

Returns:

true if using FTP passive mode

setPassive

public void setPassive(boolean passive)

Setter for FTP passive mode.

Parameters:

passive - passive mode flag

enterActiveOrPassiveMode

public void enterActiveOrPassiveMode(org.apache.commons.net.ftp.FTPClient client,
                                     UMOImmutableEndpoint endpoint)

Passive mode is OFF by default. The value is taken from the connector settings. In case there are any overriding properties set on the endpoint, those will be used.

See Also:

setPassive(boolean)

isValidateConnections

public boolean isValidateConnections()

Whether to test FTP connection on each take from pool.

setValidateConnections

public void setValidateConnections(boolean validateConnections)

Whether to test FTP connection on each take from pool. This takes care of a failed (or restarted) FTP server at the expense of an additional NOOP command packet being sent, but increases overall availability.

Disable to gain slight performance gain or if you are absolutely sure of the FTP server availability.

The default value is true

isBinary

public boolean isBinary()

Getter for FTP transfer type.

Returns:

true if using FTP binary type

setBinary

public void setBinary(boolean binary)

Setter for FTP transfer type.

Parameters:

binary - binary type flag

setupFileType

public void setupFileType(org.apache.commons.net.ftp.FTPClient client,
                          UMOImmutableEndpoint endpoint)
                   throws Exception

Transfer type is BINARY by default. The value is taken from the connector settings. In case there are any overriding properties set on the endpoint, those will be used.

The alternative type is ASCII.

Throws:

Exception

See Also:

setBinary(boolean)

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 UMOConnector

Overrides:

getOutputStream in class AbstractConnector

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