org.apache.sshd.common.scp

Interface ScpTransferEventListener

All Superinterfaces:

EventListener, SshdEventListener

All Known Implementing Classes:

AbstractScpTransferEventListenerAdapter

public interface ScpTransferEventListener
extends SshdEventListener

Can be registered in order to receive events about SCP transfers

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScpTransferEventListener.FileOperation

Field Summary

Fields

Modifier and Type	Field and Description
static ScpTransferEventListener	EMPTY An "empty" implementation to be used instead of nulls

Method Summary

Modifier and Type	Method and Description
default void	endFileEvent(ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms, Throwable thrown)
default void	endFolderEvent(ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms, Throwable thrown)
default void	startFileEvent(ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms)
default void	startFolderEvent(ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms)
static <L extends ScpTransferEventListener> L	validateListener(L listener)

Methods inherited from interface org.apache.sshd.common.util.SshdEventListener

validateListener

Field Detail

EMPTY

static final ScpTransferEventListener EMPTY

An "empty" implementation to be used instead of nulls

Method Detail

startFileEvent

default void startFileEvent(ScpTransferEventListener.FileOperation op,
                            Path file,
                            long length,
                            Set<PosixFilePermission> perms)
                     throws IOException

Parameters:

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:

IOException - If failed to handle the event

endFileEvent

default void endFileEvent(ScpTransferEventListener.FileOperation op,
                          Path file,
                          long length,
                          Set<PosixFilePermission> perms,
                          Throwable thrown)
                   throws IOException

Parameters:

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:

IOException - If failed to handle the event

startFolderEvent

default void startFolderEvent(ScpTransferEventListener.FileOperation op,
                              Path file,
                              Set<PosixFilePermission> perms)
                       throws IOException

Parameters:

op - The ScpTransferEventListener.FileOperation

file - The local referenced folder Path

perms - A Set of PosixFilePermissions to be applied once transfer is complete

Throws:

IOException - If failed to handle the event

endFolderEvent

default void endFolderEvent(ScpTransferEventListener.FileOperation op,
                            Path file,
                            Set<PosixFilePermission> perms,
                            Throwable thrown)
                     throws IOException

Parameters:

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:

IOException - If failed to handle the event

validateListener

static <L extends ScpTransferEventListener> L validateListener(L listener)