Get Received SSH Text Up To a Substring

See more SSH Examples

Demonstrates the Chilkat Ssh.GetReceivedTextS method, which searches the receive buffer for a literal, case-sensitive substring. The arguments are the channel number, the substring, and the charset. If found, everything through and including the first occurrence is returned and removed; if not found, an empty string is returned successfully and the buffer is left unchanged.

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

    //  Demonstrates the Ssh.GetReceivedTextS method, which searches the receive buffer for a literal
    //  substring.  The 1st argument is the channel number, the 2nd is the substring, and the 3rd is
    //  the charset.  If found, everything through and including the first occurrence is returned and
    //  removed from the buffer.

    CkSsh ssh = new CkSsh();

    int sshPort = 22;
    success = ssh.Connect("ssh.example.com",sshPort);
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    String password = "mySshPassword";

    success = ssh.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    int channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    //  Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
    //  raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
    //  echo typed commands back, and skips interactive login scripts.  The output is therefore
    //  clean and easily parseable -- but because no prompt is ever sent, code must not wait for
    //  one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
    success = ssh.SendReqShell(channelNum);
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    success = ssh.ChannelSendString(channelNum,"echo BEGIN; ls /tmp; echo END_MARKER\n","utf-8");
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    int pollTimeoutMs = 1000;
    int result = ssh.ChannelReadAndPoll(channelNum,pollTimeoutMs);
    if (result == -1) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    //  Return everything up through the marker.  If the marker is not present, an empty string is
    //  returned successfully and the buffer is left unchanged.
    String upToMarker = ssh.getReceivedTextS(channelNum,"END_MARKER","utf-8");
    if (ssh.get_LastMethodSuccess() == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    Log.i(TAG, upToMarker);

    ssh.Disconnect();

  }

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