Java

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. 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 assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkSFtp sftp = new CkSFtp();

    // Set some timeouts, in milliseconds:
    sftp.put_ConnectTimeoutMs(5000);
    sftp.put_IdleTimeoutMs(10000);

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    String hostname = "sftp.example.com";
    int port = 22;
    success = sftp.Connect(hostname,port);
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw("myLogin","myPassword");
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Assuming we know the file size won't be too large, we get the size as a 32-bit integer.
    // For SFTP, the remote file path is always either a path relative to the HOME directory of the user account, or an absolute path on the server.
    boolean bFollowLinks = true;
    boolean bIsHandle = false;
    int fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle);
    if (fileSize < 0) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    System.out.println("file size = " + fileSize);

    // If the file size might be too large for a 32-bit signed integer, then get the size as a decimal string.
    // You can convert the string to a 64-bit integer in your programming language.
    String fileSizeStr = sftp.getFileSizeStr("someDir/someFile.dat",bFollowLinks,bIsHandle);
    if (sftp.get_LastMethodSuccess() == false) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    System.out.println("file size = " + fileSizeStr);

    // You can alternatively get the size with an open file handle.
    String handle = sftp.openFile("someDir/someFile.dat","readOnly","openExisting");
    if (sftp.get_LastMethodSuccess() != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    // Get the size using the handle.
    bIsHandle = true;
    fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle);
    if (fileSize < 0) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    System.out.println("file size = " + fileSize);

    // -----------------------------------------------------------------------------
    // Don't forget to close the file handle.
    // Otherwise open handles will accumulate on the server until eventually a limit
    // is reached and the server will fail on a call to OpenFile.
    // -----------------------------------------------------------------------------

    // Close the file.
    success = sftp.CloseHandle(handle);
    if (success != true) {
        System.out.println(sftp.lastErrorText());
        return;
        }
  }
}