Use Apache Mina SSHD :: SFTP to implement file transmission function in network applications
Use Apache Mina SSHD :: SFTP to implement file transmission function in network applications
Apache Mina SSHD is an open source Java library for implementing the SSH and SFTP protocols.By integrating Apache Mina Sshd, we can implement secure file transmission functions in our network applications, and users can upload and download files through SFTP (SSH FILE Transfer Protocol) protocol.
SFTP is a file transmission protocol based on the SSH security channel. It provides advanced access and management functions of files, and also ensures the security of transmission.With the SFTP function provided by Apache Mina SSHD, we can easily implement the following tasks: connect to a remote server through the SFTP protocol, browse and manage remote files, upload and download files, etc.
Below is a simple example of using Apache Mina SSHD :: SFTP to demonstrate how to implement file transmission functions in network applications.
The first step is to add Apache Mina SSHD.In the Maven project, we can add the following dependencies to the POM.XML file:
<dependencies>
<dependency>
<groupId>org.apache.sshd</groupId>
<artifactId>sshd-core</artifactId>
<version>2.7.0</version>
</dependency>
</dependencies>
The second step is to create a SFTPUTIL class to process the logic of remote file transmission.The following is the example code of the sftputil class:
import org.apache.sshd.client.SshClient;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.client.subsystem.sftp.SftpClient;
import org.apache.sshd.common.file.SshFile;
import org.apache.sshd.common.util.io.IoUtils;
import java.io.IOException;
public class SftpUtil {
private static final String HOST = "remote_server_host";
private static final int PORT = 22;
private static final String USERNAME = "username";
private static final String PASSWORD = "password";
public static void main(String[] args) {
SshClient client = SshClient.setUpDefaultClient();
client.start();
try (ClientSession session = client.connect(USERNAME, HOST, PORT).verify().getSession()) {
session.addPasswordIdentity(PASSWORD);
session.auth().verify();
try (SftpClient sftpClient = session.createSftpClient()) {
// upload files
sftpClient.put("local_file_path", "remote_file_path");
// download file
sftpClient.get("remote_file_path", "local_file_path");
// Browse and manage remote files
SshFile remoteFile = sftpClient.getFile("remote_file_path");
if (remoteFile.isDirectory()) {
// Remote file is the directory
for (SshFile file : remoteFile.listSshFiles()) {
// Documents in the catalog
System.out.println(file.getName());
}
} else {
// Remote files are ordinary files
System.out.println(remoteFile.getName());
}
}
} catch (IOException e) {
e.printStackTrace();
} finally {
IoUtils.closeQuietly(client);
}
}
}
In the above code, we first created a Sshclient instance and connected to the remote server.We then provide identity verification by adding identity verification information (username and password) in the session.Once the verification is successful, we can create an SFTPClient object for SFTP operation.On the SFTPClient object, we can use the PUT method to upload files, use the get method to download the file, use the getfile method to access remote files, and use the listSshfiles method to list the files in the directory.
Remember to replace Host, Port, Username, and Password to actual value.
By integrated Apache Mina Sshd :: SFTP, we can easily implement secure file transmission functions in our network applications.Whether it is uploading, downloading, or managing remote files, it can be completed through the excellent features provided by Apache Mina SSHD.I hope this article will understand how to use the Apache Mina SSHD :: SFTP to implement the file transmission function in network applications.
