(Android™) SFTP Read Text File to String

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

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// 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);

    // 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) {
        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 != true) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

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

    // Open a file on the server:
    String handle;
    handle = sftp.openFile("hamlet.xml","readOnly","openExisting");
    if (sftp.get_LastMethodSuccess() != true) {
        Log.i(TAG, 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) {
        Log.i(TAG, 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) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }
    else {
        Log.i(TAG, "Received file:");
        Log.i(TAG, fileContents);
        }

    // Close the file.
    success = sftp.CloseHandle(handle);
    if (success != true) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    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."
  }
}