org.mule.extension.ftp.internal.connection

Class FtpConnectionProvider

java.lang.Object

org.mule.extension.file.common.api.FileSystemProvider<FtpFileSystem>

org.mule.extension.ftp.internal.connection.FtpConnectionProvider

All Implemented Interfaces:

org.mule.runtime.api.connection.ConnectionProvider<FtpFileSystem>, org.mule.runtime.api.connection.PoolingConnectionProvider<FtpFileSystem>, org.mule.runtime.api.connection.PoolingListener<FtpFileSystem>

@DisplayName(value="FTP Connection")
 @Summary(value="Connection to connect against an FTP server")
public class FtpConnectionProvider
extends org.mule.extension.file.common.api.FileSystemProvider<FtpFileSystem>
implements org.mule.runtime.api.connection.PoolingConnectionProvider<FtpFileSystem>

Connects to an FTP server

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_CODE_MASK

Constructor Summary

Constructors

Constructor and Description
FtpConnectionProvider()

Method Summary

Modifier and Type	Method and Description
FtpFileSystem	connect() Creates and returns a new instance of FtpFileSystem
protected org.apache.commons.net.ftp.FTPClient	createClient()
void	disconnect(FtpFileSystem ftpFileSystem) Invokes the FtpFileSystem.disconnect() method on the given ftpFileSystem
protected Integer	getConnectionTimeout()
protected TimeUnit	getConnectionTimeoutUnit()
protected Integer	getResponseTimeout()
protected TimeUnit	getResponseTimeoutUnit()
String	getWorkingDir()
void	onBorrow(FtpFileSystem connection)
void	setConnectionTimeout(Integer connectionTimeout)
void	setConnectionTimeoutUnit(TimeUnit connectionTimeoutUnit)
void	setResponseTimeout(Integer responseTimeout)
void	setResponseTimeoutUnit(TimeUnit responseTimeoutUnit)
org.mule.runtime.api.connection.ConnectionValidationResult	validate(FtpFileSystem ftpFileSystem) Validates the connection by delegating into FtpFileSystem.validateConnection()

Methods inherited from class org.mule.extension.file.common.api.FileSystemProvider

getConfigName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.connection.PoolingListener

onReturn

Field Detail

ERROR_CODE_MASK

public static final String ERROR_CODE_MASK

See Also:

Constant Field Values

Constructor Detail

FtpConnectionProvider

public FtpConnectionProvider()

Method Detail

disconnect

public void disconnect(FtpFileSystem ftpFileSystem)

Invokes the FtpFileSystem.disconnect() method on the given ftpFileSystem

Specified by:

disconnect in interface org.mule.runtime.api.connection.ConnectionProvider<FtpFileSystem>

Parameters:

ftpFileSystem - a FtpFileSystem instance

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate(FtpFileSystem ftpFileSystem)

Validates the connection by delegating into FtpFileSystem.validateConnection()

Specified by:

validate in interface org.mule.runtime.api.connection.ConnectionProvider<FtpFileSystem>

Parameters:

ftpFileSystem - the connection to validate

Returns:

a ConnectionValidationResult

getWorkingDir

public String getWorkingDir()

Specified by:

getWorkingDir in class org.mule.extension.file.common.api.FileSystemProvider<FtpFileSystem>

connect

public FtpFileSystem connect()
                      throws org.mule.runtime.api.connection.ConnectionException

Creates and returns a new instance of FtpFileSystem

Specified by:

connect in interface org.mule.runtime.api.connection.ConnectionProvider<FtpFileSystem>

Returns:

a FtpFileSystem

Throws:

org.mule.runtime.api.connection.ConnectionException

createClient

protected org.apache.commons.net.ftp.FTPClient createClient()

onBorrow

public void onBorrow(FtpFileSystem connection)

Specified by:

onBorrow in interface org.mule.runtime.api.connection.PoolingListener<FtpFileSystem>

getConnectionTimeout

protected Integer getConnectionTimeout()

getConnectionTimeoutUnit

protected TimeUnit getConnectionTimeoutUnit()

getResponseTimeout

protected Integer getResponseTimeout()

getResponseTimeoutUnit

protected TimeUnit getResponseTimeoutUnit()

setConnectionTimeout

public void setConnectionTimeout(Integer connectionTimeout)

setConnectionTimeoutUnit

public void setConnectionTimeoutUnit(TimeUnit connectionTimeoutUnit)

setResponseTimeout

public void setResponseTimeout(Integer responseTimeout)

setResponseTimeoutUnit

public void setResponseTimeoutUnit(TimeUnit responseTimeoutUnit)