(Java) SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files.

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 requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Important: It is helpful to send the contents of the
    // sftp.LastErrorText property when requesting support.

    CkSFtp sftp = new CkSFtp();

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

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    String hostname = "www.my-sftp-server.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 directory on the server...
    // Paths starting with a slash are "absolute", and are relative 
    // to the root of the file system. Names starting with any other 
    // character are relative to the user's default directory (home directory).
    // A path component of ".." refers to the parent directory, 
    // and "." refers to the current directory. 
    String handle = sftp.openDir(".");
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Download the directory listing:
    CkSFtpDir dirListing = sftp.ReadDir(handle);
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

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

    // Iterate over the files.
    int i = 0;
    int n = dirListing.get_NumFilesAndDirs();
    while (i < n) {
        CkSFtpFile fileObj = dirListing.GetFileObject(i);

        System.out.println(fileObj.filename());
        System.out.println(fileObj.fileType());
        System.out.println("Size in bytes: " + fileObj.get_Size32());
        System.out.println("----");

        i = i+1;
        }

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