com.adaptris.core.ftp

Class SftpKeyAuthConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.NoOpConnection

com.adaptris.core.ftp.FileTransferConnection

com.adaptris.core.ftp.SftpKeyAuthConnection

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 SftpKeyAuthConnection
extends FileTransferConnection

SFTP Connection class using public/private key authentication

This connection implementation allows you to use a public / private key pair to authenticate against the sftp server. It deviates from a standard SftpConnection. Rather than specifying a default password for accessing the server, you specify a setPrivateKeyFilename(String) and setPrivateKeyPassword(String) which contains your private key credentials which are then supplied to the server.

It has the following behavioural changes from a standard SftpConnection :

• If the private key is not accepted by the target server, then an exception will be thrown.
• If no private key password is specified then it is assumed to be a 0 length string.
• Multiple private keys are supported, provided you specify a ConfigBuilder implementation that allows it.
• Specifying the username+password in the destination (e.g. sftp://lchan:myPassword@1.2.3.4:22//opt/sftp), will override the username used to login but no other credentials. The only valid authentication is via the specified private key.
• The private key and known_hosts file are expected to be in OpenSSH format

The password associated with setPrivateKeyPassword(String) may be encoded using any of the standard Password mechanisms and it will be decoded when the private key is first accessed.

In the adapter configuration file this class is aliased as sftp-key-auth-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
SftpKeyAuthConnection() Deprecated.

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.
protected FileTransferConnection.UserInfo	createUserInfo() Deprecated.
int	defaultControlPort() Deprecated.
ConfigBuilder	getConfiguration() Deprecated.
java.lang.String	getKnownHostsFile() Deprecated.
java.lang.String	getPrivateKeyFilename() Deprecated.
java.lang.String	getPrivateKeyPassword() Deprecated. The password for the private key (if it has one)
java.lang.Integer	getSocketTimeout() Deprecated.
void	setConfiguration(ConfigBuilder repo) Deprecated. Set the config repository.
void	setKnownHostsFile(java.lang.String k) Deprecated.
void	setPrivateKeyFilename(java.lang.String privateKeyFilename) Deprecated. The name of the file where the private key is held
void	setPrivateKeyPassword(java.lang.String privateKeyPassword) Deprecated. The password for the private key (if it has one)
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.FileTransferConnection

additionalDebug, cacheConnection, closeConnection, connect, disconnect, expirationMillis, forceRelativePath, getAdditionalDebug, getCacheConnection, getCacheExpiration, getDefaultControlPort, getDefaultUserName, getDirectoryRoot, getForceRelativePath, getMaxClientCacheSize, getWindowsWorkAround, initConnection, 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

SftpKeyAuthConnection

public SftpKeyAuthConnection()

Deprecated.

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

getPrivateKeyFilename

public java.lang.String getPrivateKeyFilename()

Deprecated.

setPrivateKeyFilename

public void setPrivateKeyFilename(java.lang.String privateKeyFilename)

Deprecated.

The name of the file where the private key is held

Parameters:

privateKeyFilename - name of file holding the private key

getPrivateKeyPassword

public java.lang.String getPrivateKeyPassword()

Deprecated.

The password for the private key (if it has one)

Returns:

private key password

setPrivateKeyPassword

public void setPrivateKeyPassword(java.lang.String privateKeyPassword)

Deprecated.

The password for the private key (if it has one)

Parameters:

privateKeyPassword -

createUserInfo

protected FileTransferConnection.UserInfo createUserInfo()
                                                  throws FileTransferException

Deprecated.

Specified by:

createUserInfo in class FileTransferConnection

Throws:

FileTransferException

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