com.adaptris.core.ftp

Class SftpConnection

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.SftpConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, StateManagedComponent

Deprecated.

since 3.6.0 use StandardSftpConnection instead.

@ComponentProfile(summary="Deprecated: Use StandardSftpConnection instead",
                  tag="connections,sftp")
 @Deprecated
 @Removal(version="3.9.0",
         message="Use StandardSftpConnection instead")
public class SftpConnection
extends FileTransferConnectionUsingPassword

SFTP Connection class.

Handles URLs in the form sftp://[user:pw]@host[:port]/path/to/directory/root

In the adapter configuration file this class is aliased as sftp-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 and Description
SftpConnection() Deprecated. Default Constructor with the following default values.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptProtocol(java.lang.String s) Deprecated. Validate the URL Protocol when a URL is used.
protected FileTransferClient	create(java.lang.String remoteHost, int port, FileTransferConnection.UserInfo ui) Deprecated. Create an instance of the FileTransferClient for use with the producer or consumer.
int	defaultControlPort() Deprecated.
ConfigBuilder	getConfiguration() Deprecated.
java.lang.String	getKnownHostsFile() Deprecated.
java.lang.Integer	getSocketTimeout() Deprecated.
void	setConfiguration(ConfigBuilder repo) Deprecated. Set the config repository.
void	setKnownHostsFile(java.lang.String k) Deprecated.
void	setSocketTimeout(java.lang.Integer t) Deprecated. The socket timeout in milliseconds for connect / read /write operations.

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

createUserInfo, defaultPassword, getDefaultPassword, initConnection, 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, getLookupName, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setLookupName, 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

SftpConnection

public SftpConnection()

Deprecated.

Default Constructor with the following default values.

• socketTimeout is 0

See Also:

FileTransferConnection.FileTransferConnection()

Method Detail

acceptProtocol

protected boolean acceptProtocol(java.lang.String s)

Deprecated.

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.

create

protected FileTransferClient create(java.lang.String remoteHost,
                                    int port,
                                    FileTransferConnection.UserInfo ui)
                             throws java.io.IOException,
                                    FileTransferException,
                                    PasswordException

Deprecated.

Description copied from class: FileTransferConnection

Create an instance of the FileTransferClient for use with the producer or consumer.

Specified by:

create in class FileTransferConnection

Parameters:

remoteHost - the remote host.

port - the port to connect to

ui - a local UserInfo containing username and password

Returns:

a FileTransferClient object

Throws:

java.io.IOException - wrapping a general comms error.

FileTransferException - if a protocol specific exception occurred.

PasswordException

getSocketTimeout

public java.lang.Integer getSocketTimeout()

Deprecated.

setSocketTimeout

public void setSocketTimeout(java.lang.Integer t)

Deprecated.

The socket timeout in milliseconds for connect / read /write operations.

Parameters:

t - The socketTimeout to set, default is 60000

getKnownHostsFile

public java.lang.String getKnownHostsFile()

Deprecated.

setKnownHostsFile

public void setKnownHostsFile(java.lang.String k)

Deprecated.

defaultControlPort

public int defaultControlPort()

Deprecated.

Specified by:

defaultControlPort in class FileTransferConnection

getConfiguration

public ConfigBuilder getConfiguration()

Deprecated.

Returns:

the configRepository

setConfiguration

public void setConfiguration(ConfigBuilder repo)

Deprecated.

Set the config repository.

Use a config repository to set various SSH based settings (such as PreferredAuthentications or ServerAliveInterval.

Parameters:

repo - the configRepository to set