SFTP Read Text File to String

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

 Chilkat Java Library Downloads for Windows, Linux, and MAC OS X

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[])
  {
    //  Important: It is helpful to send the contents of the
    //  sftp.LastErrorText property when requesting support.

    CkSFtp sftp = new CkSFtp();

    //  Any string automatically begins a fully-functional 30-day trial.
    boolean success;
    success = sftp.UnlockComponent("Anything for 30-day trial");
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
    }

    //  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.
    int port;
    String hostname;
    hostname = "www.my-ssh-server.com";
    port = 22;
    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 (handle == null ) {
        System.out.println(sftp.lastErrorText());
        return;
    }

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

    //  bFollowLinks is ignored because we are passing a handle
    //  and not a remote filename.
    //  There are atlernative 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";
    int offset32;
    offset32 = 0;
    String fileContents;
    fileContents = sftp.readFileText32(handle,offset32,numBytes,charset);
    if (fileContents == null ) {
        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.");
  }
}