Package org.apache.sshd.cli.server.helper

Class ScpCommandTransferEventListener

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.cli.server.helper.ServerEventListenerHelper

org.apache.sshd.cli.server.helper.ScpCommandTransferEventListener

All Implemented Interfaces:

EventListener, NamedResource, SshdEventListener, ScpTransferEventListener

public class ScpCommandTransferEventListener
extends ServerEventListenerHelper
implements ScpTransferEventListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.scp.common.ScpTransferEventListener

ScpTransferEventListener.FileOperation

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface org.apache.sshd.scp.common.ScpTransferEventListener

EMPTY

Constructor Summary

Constructors

Constructor	Description
ScpCommandTransferEventListener(org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
void	endFileEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms, Throwable thrown)
void	endFolderEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms, Throwable thrown)
void	handleFileEventAckInfo(Session session, ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms, ScpAckInfo ackInfo)	Called after ScpTransferEventListener.endFileEvent(Session, FileOperation, Path, long, Set, Throwable) if no exception was thrown and the peer's ACK was successfully read
void	startFileEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms)
void	startFolderEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms)

Methods inherited from class org.apache.sshd.cli.server.helper.ServerEventListenerHelper

getName

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sshd.scp.common.ScpTransferEventListener

handleReceiveCommandAckInfo

Constructor Details

ScpCommandTransferEventListener

public ScpCommandTransferEventListener(org.slf4j.Logger logger)

Method Details

startFileEvent

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

Specified by:

startFileEvent in interface ScpTransferEventListener

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:

IOException - If failed to handle the event

endFileEvent

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

Specified by:

endFileEvent in interface ScpTransferEventListener

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:

IOException - If failed to handle the event

startFolderEvent

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

Specified by:

startFolderEvent in interface ScpTransferEventListener

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:

IOException - If failed to handle the event

endFolderEvent

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

Specified by:

endFolderEvent in interface ScpTransferEventListener

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:

IOException - If failed to handle the event

handleFileEventAckInfo

public void handleFileEventAckInfo(Session session,
 ScpTransferEventListener.FileOperation op,
 Path file,
 long length,
 Set<PosixFilePermission> perms,
 ScpAckInfo ackInfo)
                            throws IOException

Description copied from interface: ScpTransferEventListener

Called after ScpTransferEventListener.endFileEvent(Session, FileOperation, Path, long, Set, Throwable) if no exception was thrown and the peer's ACK was successfully read

Specified by:

handleFileEventAckInfo in interface ScpTransferEventListener

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

ackInfo - The ScpAckInfo received after a file transfer - before validating it

Throws:

IOException - If failed to handle the event