Android™

SFTP Read Directory Listing

See more SFTP Examples

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

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean success = false;

    // 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;
    success = sftp.Connect(hostname,port);
    if (success == false) {
        Log.i(TAG, 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 == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success == false) {
        Log.i(TAG, 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() == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    // Download the directory listing:

    CkSFtpDir dirListing = new CkSFtpDir();
    success = sftp.ReadDirListing(handle,dirListing);
    if (success == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    // Close the handle for the directory listing.
    success = sftp.CloseHandle(handle);
    if (success == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

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

        success = dirListing.FileAt(i,fileObj);
        if (success == false) {
            Log.i(TAG, dirListing.lastErrorText());
            return;
            }

        Log.i(TAG, fileObj.filename());
        Log.i(TAG, fileObj.fileType());
        Log.i(TAG, "Size in bytes: " + String.valueOf(fileObj.get_Size32()));
        Log.i(TAG, "----");

        i = i + 1;
        }

    Log.i(TAG, "Success.");

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}