Package org.apache.sshd.sftp.client
Interface SimpleSftpClient
- All Superinterfaces:
AutoCloseable,Channel,Closeable
- All Known Implementing Classes:
SimpleSftpClientImpl
A simplified synchronous API for obtaining SFTP sessions.
-
Method Summary
Modifier and TypeMethodDescriptiondefault SftpClientCreates an SFTP session using the provided credentialsdefault SftpClientCreates an SFTP session using the provided credentialsdefault SftpClientCreates an SFTP session on the default port and logs in using the provided credentialsdefault SftpClientCreates an SFTP session on the default port and logs in using the provided credentialsdefault SftpClientsftpLogin(InetAddress host, int port, String username, String password) Creates an SFTP session using the provided credentialsdefault SftpClientsftpLogin(InetAddress host, int port, String username, KeyPair identity) Creates an SFTP session using the provided credentialsdefault SftpClientsftpLogin(InetAddress host, String username, String password) Creates an SFTP session on the default port and logs in using the provided credentialsdefault SftpClientsftpLogin(InetAddress host, String username, KeyPair identity) Creates an SFTP session on the default port and logs in using the provided credentialssftpLogin(SocketAddress target, String username, String password) Creates an SFTP session using the provided credentialssftpLogin(SocketAddress target, String username, KeyPair identity) Creates an SFTP session using the provided credentials
-
Method Details
-
sftpLogin
Creates an SFTP session on the default port and logs in using the provided credentials- Parameters:
host- The target host name or addressusername- Usernamepassword- 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 addressport- The target portusername- Usernamepassword- Password- Returns:
- Created
SftpClient- Note: closing the client also closes its underlying session - Throws:
IOException- If failed to login or authenticate
-
sftpLogin
Creates an SFTP session on the default port and logs in using the provided credentials- Parameters:
host- The target host name or addressusername- Usernameidentity- TheKeyPairidentity- 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 addressport- The target portusername- Usernameidentity- TheKeyPairidentity- Returns:
- Created
SftpClient- Note: closing the client also closes its underlying session - Throws:
IOException- If failed to login or authenticate
-
sftpLogin
Creates an SFTP session on the default port and logs in using the provided credentials- Parameters:
host- The target hostInetAddressusername- Usernamepassword- 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 hostInetAddressport- The target portusername- Usernamepassword- 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 hostInetAddressusername- Usernameidentity- TheKeyPairidentity- 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 hostInetAddressport- The target portusername- Usernameidentity- TheKeyPairidentity- Returns:
- Created
SftpClient- Note: closing the client also closes its underlying session - Throws:
IOException- If failed to login or authenticate
-
sftpLogin
Creates an SFTP session using the provided credentials- Parameters:
target- The targetSocketAddressusername- Usernamepassword- Password- Returns:
- Created
SftpClient- Note: closing the client also closes its underlying session - Throws:
IOException- If failed to login or authenticate
-
sftpLogin
Creates an SFTP session using the provided credentials- Parameters:
target- The targetSocketAddressusername- Usernameidentity- TheKeyPairidentity- Returns:
- Created
SftpClient- Note: closing the client also closes its underlying session - Throws:
IOException- If failed to login or authenticate
-