Java

SFTP Read Text File

See more SFTP Examples

Demonstrates how to open a text file on the SSH server and read text. Java

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[])
  {
    boolean success = false;

    // 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;
    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 for reading.
    String handle;
    handle = sftp.openFile("myTest.txt","readOnly","openExisting");
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Assume the file we are reading contains the following text:
    // abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
    // (in ANSI format -- i.e. one byte per char).

    // Read 26 bytes:
    String sText;
    sText = sftp.readFileText(handle,26,"ansi");
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Should print "abcdefghijklmnopqrstuvwxyz"
    System.out.println(sText);

    // Read the next 10 bytes.
    sText = sftp.readFileText(handle,10,"ansi");
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Should print "1234567890"
    System.out.println(sText);

    // Read the next 26 bytes.
    sText = sftp.readFileText(handle,26,"ansi");
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    System.out.println(sText);

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

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