Interface ScpTransferEventListener

    • Method Detail

      • startFileEvent

        default void startFileEvent​(Session session,
                                    ScpTransferEventListener.FileOperation op,
                                    java.nio.file.Path file,
                                    long length,
                                    java.util.Set<java.nio.file.attribute.PosixFilePermission> perms)
                             throws java.io.IOException
        Parameters:
        session - The client/server Session through which the transfer is being executed
        op - The ScpTransferEventListener.FileOperation
        file - The local referenced file Path
        length - Size (in bytes) of transferred data
        perms - A Set of PosixFilePermissions to be applied once transfer is complete
        Throws:
        java.io.IOException - If failed to handle the event
      • endFileEvent

        default void endFileEvent​(Session session,
                                  ScpTransferEventListener.FileOperation op,
                                  java.nio.file.Path file,
                                  long length,
                                  java.util.Set<java.nio.file.attribute.PosixFilePermission> perms,
                                  java.lang.Throwable thrown)
                           throws java.io.IOException
        Parameters:
        session - The client/server Session through which the transfer is being executed
        op - The ScpTransferEventListener.FileOperation
        file - The local referenced file Path
        length - Size (in bytes) of transferred data
        perms - A Set of PosixFilePermissions to be applied once transfer is complete
        thrown - The result of the operation attempt - if null then reception was successful
        Throws:
        java.io.IOException - If failed to handle the event
      • startFolderEvent

        default void startFolderEvent​(Session session,
                                      ScpTransferEventListener.FileOperation op,
                                      java.nio.file.Path file,
                                      java.util.Set<java.nio.file.attribute.PosixFilePermission> perms)
                               throws java.io.IOException
        Parameters:
        session - The client/server Session through which the transfer is being executed
        op - The ScpTransferEventListener.FileOperation
        file - The local referenced folder Path
        perms - A Set of PosixFilePermissions to be applied once transfer is complete
        Throws:
        java.io.IOException - If failed to handle the event
      • endFolderEvent

        default void endFolderEvent​(Session session,
                                    ScpTransferEventListener.FileOperation op,
                                    java.nio.file.Path file,
                                    java.util.Set<java.nio.file.attribute.PosixFilePermission> perms,
                                    java.lang.Throwable thrown)
                             throws java.io.IOException
        Parameters:
        session - The client/server Session through which the transfer is being executed
        op - The ScpTransferEventListener.FileOperation
        file - The local referenced file Path
        perms - A Set of PosixFilePermissions to be applied once transfer is complete
        thrown - The result of the operation attempt - if null then reception was successful
        Throws:
        java.io.IOException - If failed to handle the event