(Java) SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris 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 assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkSFtp sftp = new CkSFtp();

    // Set some timeouts, in milliseconds:
    sftp.put_ConnectTimeoutMs(5000);
    sftp.put_IdleTimeoutMs(15000);

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    String hostname = "sftp.example.com";
    int port = 22;
    boolean success = sftp.Connect(hostname,port);
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw("myLogin","myPassword");
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Open a file on the server:
    String handle;
    handle = sftp.openFile("hamlet.xml","readOnly","openExisting");
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Get the total size of this file (in bytes)
    boolean bFollowLinks = false;
    boolean bIsHandle = true;
    int numBytes;

    // bFollowLinks is ignored because we are passing a handle
    // and not a remote filename.
    // There are alternative methods for handling file sizes
    // greater than 32-bit.  (See the reference documentation.)
    numBytes = sftp.GetFileSize32(handle,bFollowLinks,bIsHandle);
    if (numBytes < 0) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // The charset indicates the character encoding of the text
    // file on the SSH server.   Setting the charset correctly
    // allows the Chilkat SFTP component to correctly interpret
    // the bytes that represent the characters.
    String charset;
    charset = "ansi";
    String fileContents;
    fileContents = sftp.readFileText(handle,numBytes,charset);
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }
    else {
        System.out.println("Received file:");
        System.out.println(fileContents);
        }

    // Close the file.
    success = sftp.CloseHandle(handle);
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    System.out.println("Success.");
  }
}