com.ssh.sft
Interface Policies.Remove

All Known Subinterfaces:
Policies.All, Policies.Move, Policies.MoveDir, Policies.RemoveDir
All Known Implementing Classes:
AbstractPolicy
Enclosing interface:
Policies

public static interface Policies.Remove

The policy interface for removing files.


Method Summary
 boolean remove(File file)
          Invoked when a file is about to be removed.
 void report(File File, int errorCode, String msg)
          Invoked when an informative message related to the operation wants to be passed to the application.
 

Method Detail

remove

public boolean remove(File file)
               throws AbortedException
Invoked when a file is about to be removed.

Parameters:
file - The file to be removed
Returns:
true if the file may be removed, false otherwise
Throws:
AbortedException - if the entire ongoing operation should be aborted

report

public void report(File File,
                   int errorCode,
                   String msg)
            throws AbortedException
Invoked when an informative message related to the operation wants to be passed to the application.

Parameters:
File - the path to the file.
errorCode - the SftException.getErrorCode() value.
msg - message to be passed to the application.
Throws:
AbortedException