Java

Monitor FTP Transfer Progress

Demonstrates the progress properties CurBytesReceived, CurBytesReceivedStr, CurBytesSent, CurBytesSentStr, ProgressMonSize, PercentDoneScale, and AutoGetSizeForProgress.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Percentage progress needs a known total, but FTP does not always report a file's size up front — so AutoGetSizeForProgress issues a SIZE command before a download, and ProgressMonSize supplies an expected size when even that is unavailable (a one-shot value consumed by the next transfer). PercentDoneScale sets the resolution of progress callbacks. The current byte counts are exposed both as 32-bit integers and as strings, the string forms avoiding integer-width limits for very large transfers.

Chilkat Java Downloads

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Ftp2;

public class ChilkatExample {

    public static void main(String[] args) {
        Ftp2 ftp = new Ftp2();

        ftp.setHostname("ftp.example.com");
        ftp.setUsername("myFtpLogin");

        // 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.
        ftp.setPassword("myPassword");

        try {
            ftp.connect();

            // AutoGetSizeForProgress sends a SIZE command before a download so percentage-based progress can
            // be computed.
            ftp.setAutoGetSizeForProgress(true);

            // PercentDoneScale sets the value representing one hundred percent in PercentDone callbacks.
            // 1000 gives tenth-of-a-percent resolution.
            ftp.setPercentDoneScale(1000);

            // ProgressMonSize is a one-shot expected size for the next download when the size is not
            // otherwise known.  It is consumed by the next download and reset to 0.
            ftp.setProgressMonSize(20485760);

            ftp.getFile("public_html/bigfile.zip", "qa_output/bigfile.zip");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // After a transfer, the current byte counts are available as 32-bit numbers or as strings (the
        // string forms avoid integer-size limits).
        System.out.println("Bytes received: " + ftp.getCurBytesReceived());
        System.out.println("Bytes received (str): " + ftp.getCurBytesReceivedStr());
        System.out.println("Bytes sent: " + ftp.getCurBytesSent());
        System.out.println("Bytes sent (str): " + ftp.getCurBytesSentStr());

        try {
            ftp.disconnect();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }
    }
}