org.apache.sshd.client.simple

Interface SimpleSftpClient

All Superinterfaces:

AutoCloseable, Channel, Closeable, SimpleClientConfigurator

All Known Subinterfaces:

SimpleClient

All Known Implementing Classes:

AbstractSimpleClient, AbstractSimpleClientSessionCreator

public interface SimpleSftpClient
extends SimpleClientConfigurator, Channel

A simplified synchronous API for obtaining SFTP sessions.

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from interface org.apache.sshd.client.simple.SimpleClientConfigurator

DEFAULT_AUTHENTICATION_TIMEOUT, DEFAULT_CONNECT_TIMEOUT, DEFAULT_PORT

Method Summary

Modifier and Type	Method and Description
default SftpClient	sftpLogin(InetAddress host, int port, String username, KeyPair identity) Creates an SFTP session using the provided credentials
default SftpClient	sftpLogin(InetAddress host, int port, String username, String password) Creates an SFTP session using the provided credentials
default SftpClient	sftpLogin(InetAddress host, String username, KeyPair identity) Creates an SFTP session on the default port and logs in using the provided credentials
default SftpClient	sftpLogin(InetAddress host, String username, String password) Creates an SFTP session on the default port and logs in using the provided credentials
SftpClient	sftpLogin(SocketAddress target, String username, KeyPair identity) Creates an SFTP session using the provided credentials
SftpClient	sftpLogin(SocketAddress target, String username, String password) Creates an SFTP session using the provided credentials
default SftpClient	sftpLogin(String host, int port, String username, KeyPair identity) Creates an SFTP session using the provided credentials
default SftpClient	sftpLogin(String host, int port, String username, String password) Creates an SFTP session using the provided credentials
default SftpClient	sftpLogin(String host, String username, KeyPair identity) Creates an SFTP session on the default port and logs in using the provided credentials
default SftpClient	sftpLogin(String host, String username, String password) Creates an SFTP session on the default port and logs in using the provided credentials

Methods inherited from interface org.apache.sshd.client.simple.SimpleClientConfigurator

getAuthenticationTimeout, getConnectTimeout, setAuthenticationTimeout, setConnectTimeout

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Method Detail

sftpLogin

default SftpClient sftpLogin(String host,
                             String username,
                             String password)
                      throws IOException

Creates an SFTP session on the default port and logs in using the provided credentials

Parameters:

host - The target host name or address

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

default SftpClient sftpLogin(String host,
                             int port,
                             String username,
                             String password)
                      throws IOException

Creates an SFTP session using the provided credentials

Parameters:

host - The target host name or address

port - The target port

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

default SftpClient sftpLogin(String host,
                             String username,
                             KeyPair identity)
                      throws IOException

Creates an SFTP session on the default port and logs in using the provided credentials

Parameters:

host - The target host name or address

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

sftpLogin

default SftpClient sftpLogin(String host,
                             int port,
                             String username,
                             KeyPair identity)
                      throws IOException

Creates an SFTP session using the provided credentials

Parameters:

host - The target host name or address

port - The target port

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

sftpLogin

default SftpClient sftpLogin(InetAddress host,
                             String username,
                             String password)
                      throws IOException

Creates an SFTP session on the default port and logs in using the provided credentials

Parameters:

host - The target host InetAddress

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

default SftpClient sftpLogin(InetAddress host,
                             int port,
                             String username,
                             String password)
                      throws IOException

Creates an SFTP session using the provided credentials

Parameters:

host - The target host InetAddress

port - The target port

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

default SftpClient sftpLogin(InetAddress host,
                             String username,
                             KeyPair identity)
                      throws IOException

Creates an SFTP session on the default port and logs in using the provided credentials

Parameters:

host - The target host InetAddress

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

sftpLogin

default SftpClient sftpLogin(InetAddress host,
                             int port,
                             String username,
                             KeyPair identity)
                      throws IOException

Creates an SFTP session using the provided credentials

Parameters:

host - The target host InetAddress

port - The target port

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

sftpLogin

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

Creates an SFTP session using the provided credentials

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

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

Creates an SFTP session using the provided credentials

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