Java

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Scp;
import com.chilkatsoft.chilkat2.Ssh;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Ssh ssh = new Ssh();

        // Hostname may be an IP address or hostname:
        String hostname = "www.some-ssh-server.com";
        int port = 22;

        // Connect to an SSH server:
        try {
            ssh.connect(hostname, port);

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

            // Authenticate using login/password:
            ssh.authenticatePw("myLogin", "myPassword");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Once the SSH object is connected and authenticated, we use it
        // in our SCP object.
        Scp scp = new Scp();

        try {
            scp.useSsh(ssh);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).
        String remotePath = "repository/xml/hamlet.xml";

        // The byte representation of the remote text file (i.e. the charset) must be
        // indicated to allow the receiving software to correctly interpret the incoming
        // bytes as the correct chars.
        // See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
        String charset = "utf-8";

        String fileContents;
        try {
            fileContents = scp.downloadString(remotePath, charset);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Received file:");
        System.out.println(fileContents);

        System.out.println("SCP download string success.");

        // Disconnect
        ssh.disconnect();
    }
}