Java

Setting Environment Variables for SCP Transfers

See more SCP Examples

Demonstrates how to set remote environment variables for an SCP transfer.

Note 1: This example requires Chilkat v9.5.0.79 or greater.

Note 2: Setting environment variables for SCP is only supported by some SSH servers.

Java

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[])
  {
    boolean success = false;

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkSsh ssh = new CkSsh();

    // First connect to an SSH server.
    success = ssh.Connect("example.com",22);
    if (success != true) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    // Wait a max of 5 seconds when reading responses..
    ssh.put_IdleTimeoutMs(5000);

    // Authenticate..
    success = ssh.AuthenticatePw("myLogin","myPassword");
    if (success != true) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    // After the SSH object is connected and authenticated, we use it
    // as the underlying transport in our SCP object.
    CkScp scp = new CkScp();

    success = scp.UseSsh(ssh);
    if (success != true) {
        System.out.println(scp.lastErrorText());
        return;
        }

    // Specify the environment variables to be set in JSON as follows.
    // This example sets two environment variables.  One is named "LCS_PASSWORD" and the other "MY_TEST_NAME".
    CkJsonObject jsonEnvVars = new CkJsonObject();
    jsonEnvVars.put_EmitCompact(false);
    jsonEnvVars.UpdateString("LCS_PASSWORD","secret");
    jsonEnvVars.UpdateString("MY_TEST_NAME","abc");
    String strEnvVars = jsonEnvVars.emit();

    System.out.println(strEnvVars);

    // Setting the SendEnv property causes Chilkat to set each environment variable on the SSH server
    // prior to doing the upload or download.
    scp.put_SendEnv(strEnvVars);

    // Do the upload..
    String remotePath = "starfish.jpg";
    String localPath = "qa_data/jpg/starfish.jpg";
    success = scp.UploadFile(localPath,remotePath);
    if (success != true) {
        System.out.println(scp.lastErrorText());
        return;
        }

    System.out.println("SCP upload file success.");

    // Disconnect
    ssh.Disconnect();
  }
}