(Java) SCP Download Text File to String Variable

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable.

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkSsh ssh = new CkSsh();

    // Hostname may be an IP address or hostname:
    String hostname = "www.some-ssh-server.com";
    int port = 22;

    // Connect to an SSH server:
    boolean success = ssh.Connect(hostname,port);
    if (success != true) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    // Wait a max of 5 seconds when reading responses..
    ssh.put_IdleTimeoutMs(5000);

    // Authenticate using login/password:
    success = ssh.AuthenticatePw("myLogin","myPassword");
    if (success != true) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    // Once the SSH object is connected and authenticated, we use it
    // in our SCP object.
    CkScp scp = new CkScp();

    success = scp.UseSsh(ssh);
    if (success != true) {
        System.out.println(scp.lastErrorText());
        return;
        }

    // This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
    String remotePath = "repository/xml/hamlet.xml";

    // The byte representation of the remote text file (i.e. the charset) must be
    // indicated to allow the receiving software to correctly interpret the incoming
    // bytes as the correct chars.
    // See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
    String charset = "utf-8";

    String fileContents = scp.downloadString(remotePath,charset);
    if (scp.get_LastMethodSuccess() != true) {
        System.out.println(scp.lastErrorText());
        return;
        }

    System.out.println("Received file:");
    System.out.println(fileContents);

    System.out.println("SCP download string success.");

    // Disconnect
    ssh.Disconnect();
  }
}