Package com.adaptris.core.ftp

Class FtpConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.NoOpConnection

com.adaptris.core.ftp.FileTransferConnection

com.adaptris.core.ftp.FileTransferConnectionUsingPassword

com.adaptris.core.ftp.FtpConnectionImp

com.adaptris.core.ftp.FtpConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent

@ComponentProfile(summary="Connect to a FTP server using a username and password",
                  tag="connections,ftp")
public class FtpConnection
extends FtpConnectionImp

Class containing configuration for both FTP Consumers and producers.

See Also:

FtpConnectionImp

In the adapter configuration file this class is aliased as ftp-connection which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.ftp.FileTransferConnection

FileTransferConnection.UserInfo

Field Summary

Fields inherited from class com.adaptris.core.ftp.FileTransferConnection

DEFAULT_EXPIRATION, DEFAULT_MAX_CACHE_SIZE

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor	Description
FtpConnection()
FtpConnection(java.lang.String uniqueId)

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptProtocol(java.lang.String s)	Validate the URL Protocol when a URL is used.
protected ApacheFtpClientImpl	createFtpClient(java.lang.String remoteHost, int port, int timeoutSecs)

Methods inherited from class com.adaptris.core.ftp.FtpConnectionImp

create, defaultControlPort, getAdditionalSettings, getDefaultAccount, getFtpDataMode, getServerTimezone, getSocketTimeout, getTransferType, initConnection, setAdditionalSettings, setDefaultAccount, setFtpDataMode, setServerTimezone, setSocketTimeout, setTransferType

Methods inherited from class com.adaptris.core.ftp.FileTransferConnectionUsingPassword

createUserInfo, defaultPassword, getDefaultPassword, setDefaultPassword

Methods inherited from class com.adaptris.core.ftp.FileTransferConnection

additionalDebug, cacheConnection, closeConnection, connect, disconnect, expirationMillis, forceRelativePath, getAdditionalDebug, getCacheConnection, getCacheExpiration, getDefaultControlPort, getDefaultUserName, getDirectoryRoot, getForceRelativePath, getMaxClientCacheSize, getWindowsWorkAround, maxClientCacheSize, setAdditionalDebug, setCacheConnection, setCacheExpiration, setDefaultControlPort, setDefaultUserName, setForceRelativePath, setMaxClientCache, setWindowsWorkAround, windowsWorkaround, withCacheExpiration

Methods inherited from class com.adaptris.core.NoOpConnection

prepareConnection, startConnection, stopConnection

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, connectionErrorHandler, getConnectionErrorHandler, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setUniqueId, setWorkersFirstOnShutdown, start, stop, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpConnection

public FtpConnection()

FtpConnection

public FtpConnection(java.lang.String uniqueId)

Method Detail

acceptProtocol

protected boolean acceptProtocol(java.lang.String s)

Description copied from class: FileTransferConnection

Validate the URL Protocol when a URL is used.

Specified by:

acceptProtocol in class FileTransferConnection

Parameters:

s - the URL Protocol

Returns:

true if the URL protocol is acceptable to the concrete imp.

createFtpClient

protected ApacheFtpClientImpl createFtpClient(java.lang.String remoteHost,
                                              int port,
                                              int timeoutSecs)
                                       throws java.io.IOException

Specified by:

createFtpClient in class FtpConnectionImp

Throws:

java.io.IOException