Android™

Get an SSH Tunnel's Current State (Diagnostics)

Demonstrates the Chilkat SshTunnel.GetCurrentState method, which returns an XML snapshot describing the tunnel manager, SSH channels, and current tunnel clients. It takes no arguments and is intended for diagnostics and monitoring.

Background: Because the tunnel forwards traffic on a background thread, there is no natural place in your code to observe what it is doing at a given moment. GetCurrentState provides that visibility — byte counts, active channels, and connected clients — as structured XML suited to logging or a monitoring dashboard. It is a read-only snapshot and does not affect the tunnel.

Chilkat Android™ Downloads

Download Chilkat for Android™

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;

    //  Demonstrates the SshTunnel.GetCurrentState method, which returns an XML snapshot describing the
    //  tunnel manager, SSH channels, and current tunnel clients.  It takes no arguments and is
    //  intended for diagnostics and monitoring.

    CkSshTunnel tunnel = new CkSshTunnel();

    //  The tunnel forwards accepted local connections to this destination through the SSH server.
    tunnel.put_DestHostname("db.internal.example.com");
    tunnel.put_DestPort(5432);

    //  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
    //  does not authenticate yet.
    int sshPort = 22;
    success = tunnel.Connect("ssh.example.com",sshPort);
    if (success == false) {
        Log.i(TAG, tunnel.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 = tunnel.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        Log.i(TAG, tunnel.lastErrorText());
        return;
        }

    //  Begin accepting so there is live tunnel state to inspect.
    int listenPort = 1080;
    success = tunnel.BeginAccepting(listenPort);
    if (success == false) {
        Log.i(TAG, tunnel.lastErrorText());
        return;
        }

    //  Get a diagnostic snapshot of the tunnel's current state as XML.
    String stateXml = tunnel.getCurrentState();
    if (tunnel.get_LastMethodSuccess() == false) {
        Log.i(TAG, tunnel.lastErrorText());
        return;
        }

    Log.i(TAG, stateXml);

    boolean waitForThreadExit = true;
    success = tunnel.CloseTunnel(waitForThreadExit);
    if (success == false) {
        Log.i(TAG, tunnel.lastErrorText());
        return;
        }


  }

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