Java

Delete a Remote File on an SFTP Server

Demonstrates the Chilkat SFtp.RemoveFile method, which deletes a remote file. The only argument is the file path.

Background: Deletion is immediate and permanent — SFTP has no trash or undo — so a job that removes files should be certain of the path first. Whether deletion is even allowed depends on the account's permissions on the file and its containing directory, since on Unix-like systems the right to remove a file comes from write permission on the directory, not the file itself.

Chilkat Java Downloads

Download Chilkat for Java

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;

    //  Demonstrates the SFtp.RemoveFile method, which deletes a remote file.  The only argument is
    //  the file path.

    CkSFtp sftp = new CkSFtp();

    //  Connect, authenticate, and initialize the SFTP subsystem.
    int port = 22;
    success = sftp.Connect("sftp.example.com",port);
    if (success == false) {
        System.out.println(sftp.lastErrorText());
        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";

    success = sftp.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    success = sftp.InitializeSftp();
    if (success == false) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    //  Delete a remote file.
    success = sftp.RemoveFile("subdir/obsolete.txt");
    if (success == false) {
        System.out.println(sftp.lastErrorText());
        return;
        }

    System.out.println("File removed.");

    sftp.Disconnect();
  }
}