Java

Write Text to a Remote SFTP File (Sequential)

Demonstrates the Chilkat SFtp.WriteFileText method, which encodes text using a charset and writes it at the current sequential write position of an open handle. The arguments are the handle, the charset, and the text.

Background: Chilkat tracks a write position per handle, so successive WriteFileText calls append naturally — the pattern for building a file a piece at a time, such as writing rows to a report. Opening with openOrCreate starts writing at the current end of the file. The charset determines the bytes actually stored, which matters whenever the text contains non-ASCII characters.

Chilkat Java Downloads

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.SFtp;

public class ChilkatExample {

    public static void main(String[] args) {
        // Demonstrates the SFtp.WriteFileText method, which encodes text and writes it at the current
        // sequential write position of an open handle.  The 1st argument is the handle, the 2nd is the
        // charset, and the 3rd is the text.

        SFtp sftp = new SFtp();

        // Connect, authenticate, and initialize the SFTP subsystem.
        int port = 22;
        try {
            sftp.connect("sftp.example.com", port);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            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";

        String handle;
        try {
            sftp.authenticatePw("mySshLogin", password);

            sftp.initializeSftp();

            // Open (creating/truncating) the remote file for writing.
            handle = sftp.openFile("subdir/notes.txt", "writeOnly", "createTruncate");

            // Write text as UTF-8.  Successive writes continue from where the previous write ended.
            sftp.writeFileText(handle, "utf-8", "First line.\n");

            sftp.writeFileText(handle, "utf-8", "Second line.\n");

            sftp.closeHandle(handle);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Wrote text file.");

        sftp.disconnect();
    }
}