Package org.apache.sshd.sftp.client.impl

Class SimpleSftpClientImpl

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.sftp.client.impl.SimpleSftpClientImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, SimpleSftpClient

public class SimpleSftpClientImpl
extends org.apache.sshd.common.util.logging.AbstractLoggingBean
implements SimpleSftpClient

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
SimpleSftpClientImpl()
SimpleSftpClientImpl(org.apache.sshd.client.simple.SimpleClient client)
SimpleSftpClientImpl(org.apache.sshd.client.simple.SimpleClient client, SftpClientFactory sftpClientFactory)

Method Summary

Modifier and Type	Method	Description
void	close()
protected SftpClient	createSftpClient(org.apache.sshd.client.session.ClientSession session)
protected SftpClient	createSftpClient(org.apache.sshd.common.util.io.functors.IOFunction<? super org.apache.sshd.client.simple.SimpleClient,? extends org.apache.sshd.client.session.ClientSession> sessionProvider)
org.apache.sshd.client.simple.SimpleClient	getClient()
SftpClientFactory	getSftpClientFactory()
boolean	isOpen()
void	setClient(org.apache.sshd.client.simple.SimpleClient client)
void	setSftpClientFactory(SftpClientFactory sftpClientFactory)
SftpClient	sftpLogin(SocketAddress target, String username, String password)	Creates an SFTP session using the provided credentials
SftpClient	sftpLogin(SocketAddress target, String username, KeyPair identity)	Creates an SFTP session using the provided credentials

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.sftp.client.SimpleSftpClient

sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin

Constructor Details

SimpleSftpClientImpl

public SimpleSftpClientImpl()

SimpleSftpClientImpl

public SimpleSftpClientImpl(org.apache.sshd.client.simple.SimpleClient client)

SimpleSftpClientImpl

public SimpleSftpClientImpl(org.apache.sshd.client.simple.SimpleClient client,
 SftpClientFactory sftpClientFactory)

Method Details

getClient

public org.apache.sshd.client.simple.SimpleClient getClient()

setClient

public void setClient(org.apache.sshd.client.simple.SimpleClient client)

getSftpClientFactory

public SftpClientFactory getSftpClientFactory()

setSftpClientFactory

public void setSftpClientFactory(SftpClientFactory sftpClientFactory)

sftpLogin

public SftpClient sftpLogin(SocketAddress target,
 String username,
 String password)
                     throws IOException

Description copied from interface: SimpleSftpClient

Creates an SFTP session using the provided credentials

Specified by:

sftpLogin in interface SimpleSftpClient

Parameters:

target - The target SocketAddress

username - Username

password - Password

Returns:

Created SftpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

sftpLogin

public SftpClient sftpLogin(SocketAddress target,
 String username,
 KeyPair identity)
                     throws IOException

Description copied from interface: SimpleSftpClient

Creates an SFTP session using the provided credentials

Specified by:

sftpLogin in interface SimpleSftpClient

Parameters:

target - The target SocketAddress

username - Username

identity - The KeyPair identity

Returns:

Created SftpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

createSftpClient

protected SftpClient createSftpClient(org.apache.sshd.common.util.io.functors.IOFunction<? super org.apache.sshd.client.simple.SimpleClient,? extends org.apache.sshd.client.session.ClientSession> sessionProvider)
                               throws IOException

Throws:

IOException

createSftpClient

protected SftpClient createSftpClient(org.apache.sshd.client.session.ClientSession session)
                               throws IOException

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException