Java

Write Bytes to a Remote SFTP File (BinData)

Demonstrates the Chilkat SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote file identified by an open handle. The first argument is the handle and the second is the BinData.

Note: This example uses a relative local path, which is resolved against the application's current working directory. Absolute local paths may also be used. Supply the path appropriate to your own environment.

Background: This is the binary counterpart to WriteFileText — the right choice for images, archives, or any non-text content, where a charset conversion would corrupt the data. Combined with an appropriate OpenFile disposition it can create, overwrite, or append; here the file is created/truncated first so the result is exactly the BinData contents.

Chilkat Java Downloads

Download Chilkat for Java

Chilkat2 Java

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

public class ChilkatExample {

    public static void main(String[] args) {
        // Demonstrates the SFtp.WriteFileBd method, which appends all bytes in a BinData to the remote
        // file identified by an open handle.  The 1st argument is the handle and the 2nd is the BinData.

        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/image.png", "writeOnly", "createTruncate");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Put the bytes to write into a BinData.  (Here they are loaded from a local file, but the
        // bytes could come from anywhere.)
        BinData bd = new BinData();
        try {
            bd.loadFile("qa_data/image.png");

            // Append the BinData bytes to the open remote file.
            sftp.writeFileBd(handle, bd);

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

        System.out.println("Wrote " + bd.getNumBytes() + " bytes.");

        sftp.disconnect();
    }
}