Merge pull request #17745 from Michaelin007/jschremote

https://jira.baeldung.com/browse/BAEL-8627

Author: Maiklins

libraries-files/pom.xml

@@ -43,12 +43,18 @@
             <version>${itext7-core.version}</version>
             <type>pom</type>
         </dependency>
+        <dependency>
+            <groupId>com.github.mwiede</groupId>
+            <artifactId>jsch</artifactId>
+            <version>${jsch.version}</version>
+        </dependency>
     </dependencies>
 
     <properties>
         <org.ini4j.version>0.5.4</org.ini4j.version>
         <commons-configuration2>2.8.0</commons-configuration2>
         <itext7-core.version>7.2.4</itext7-core.version>
+        <jsch.version>0.2.20</jsch.version>
     </properties>
 
 </project>

libraries-files/src/main/java/com/baeldung/readfileremotely/RemoteServerJsch.java

@@ -0,0 +1,57 @@
+package com.baeldung.readfileremotely;
+
+import com.jcraft.jsch.JSch;
+import com.jcraft.jsch.JSchException;
+import com.jcraft.jsch.Session;
+import com.jcraft.jsch.ChannelSftp;
+import com.jcraft.jsch.SftpException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+
+public class RemoteServerJsch {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(RemoteServerJsch.class);
+    private static final String HOST = "HOST";
+    private static final String USER = "USERNAME";
+    private static final String PRIVATE_KEY = "PATH TO PRIVATE KEY";
+    private static final int PORT = 22;
+
+    public static JSch setUpJsch() throws JSchException {
+        JSch jsch = new JSch();
+        jsch.addIdentity(PRIVATE_KEY);
+        return jsch;
+    }
+
+    public static Session createSession(JSch jsch) throws JSchException {
+        Session session = jsch.getSession(USER, HOST, PORT);
+        session.setConfig("StrictHostKeyChecking", "no");
+        session.connect();
+        return session;
+    }
+
+    public static ChannelSftp createSftpChannel(Session session) throws JSchException {
+        ChannelSftp channelSftp = (ChannelSftp) session.openChannel("sftp");
+        channelSftp.connect();
+        return channelSftp;
+    }
+
+    public static void readFileLineByLine(ChannelSftp channelSftp, String filePath) throws SftpException, IOException {
+        InputStream stream = channelSftp.get(filePath);
+        try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(stream))) {
+            String line;
+            while ((line = bufferedReader.readLine()) != null) {
+                LOGGER.info(line);
+            }
+        }
+    }
+
+    public static void disconnect(ChannelSftp channelSftp, Session session) {
+        channelSftp.disconnect();
+        session.disconnect();
+    }
+}

libraries-files/src/test/java/com/baeldung/readfileremotely/RemoteServerJschLiveTest.java

@@ -0,0 +1,26 @@
+package com.baeldung.readfileremotely;
+
+import com.jcraft.jsch.JSch;
+import com.jcraft.jsch.JSchException;
+import com.jcraft.jsch.Session;
+import com.jcraft.jsch.ChannelSftp;
+import com.jcraft.jsch.SftpException;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+import static com.baeldung.readfileremotely.RemoteServerJsch.*;
+
+class RemoteServerJschLiveTest {
+
+    private static final String REMOTE_DIR = "REMOTE_DIR";
+
+    @Test
+    public void givenJsch_whenListFiles_thenSuccess() throws JSchException, SftpException, IOException {
+        JSch jsch = setUpJsch();
+        Session session = createSession(jsch);
+        ChannelSftp channelSftp = createSftpChannel(session);
+        readFileLineByLine(channelSftp, REMOTE_DIR + "/examplefile.txt");
+        disconnect(channelSftp, session);
+    }
+}