org.apache.sshd.common.scp

Interface ScpTransferEventListener

All Superinterfaces:

EventListener

public interface ScpTransferEventListener
extends EventListener

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
void	endFileEvent(ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms, Throwable thrown)
void	endFolderEvent(ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms, Throwable thrown)
void	startFileEvent(ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms)
void	startFolderEvent(ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms)

Field Detail

EMPTY

static final ScpTransferEventListener EMPTY

An "empty" implementation to be used instead of nulls

Method Detail

startFileEvent

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

Parameters:

op - The ScpTransferEventListener.FileOperation

file - The local referenced file Path

length - Size (in bytes) of transfered data

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

endFileEvent

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

Parameters:

op - The ScpTransferEventListener.FileOperation

file - The local referenced file Path

length - Size (in bytes) of transfered 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

startFolderEvent

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

Parameters:

op - The ScpTransferEventListener.FileOperation

file - The local referenced folder Path

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

endFolderEvent

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

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