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:
java.util.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidendFileEvent(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)voidendFolderEvent(Session session, ScpTransferEventListener.FileOperation op, java.nio.file.Path file, java.util.Set<java.nio.file.attribute.PosixFilePermission> perms, java.lang.Throwable thrown)voidhandleFileEventAckInfo(Session session, ScpTransferEventListener.FileOperation op, java.nio.file.Path file, long length, java.util.Set<java.nio.file.attribute.PosixFilePermission> perms, ScpAckInfo ackInfo)Called afterScpTransferEventListener.endFileEvent(Session, FileOperation, Path, long, Set, Throwable)if no exception was thrown and the peer's ACK was successfully readvoidstartFileEvent(Session session, ScpTransferEventListener.FileOperation op, java.nio.file.Path file, long length, java.util.Set<java.nio.file.attribute.PosixFilePermission> perms)voidstartFolderEvent(Session session, ScpTransferEventListener.FileOperation op, java.nio.file.Path file, java.util.Set<java.nio.file.attribute.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
-
-
-
-
Method Detail
-
startFileEvent
public 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
- Specified by:
startFileEventin interfaceScpTransferEventListener- Parameters:
session- The client/serverSessionthrough which the transfer is being executedop- TheScpTransferEventListener.FileOperationfile- The local referenced filePathlength- Size (in bytes) of transferred dataperms- ASetofPosixFilePermissions to be applied once transfer is complete- Throws:
java.io.IOException- If failed to handle the event
-
endFileEvent
public 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
- Specified by:
endFileEventin interfaceScpTransferEventListener- Parameters:
session- The client/serverSessionthrough which the transfer is being executedop- TheScpTransferEventListener.FileOperationfile- The local referenced filePathlength- Size (in bytes) of transferred dataperms- ASetofPosixFilePermissions to be applied once transfer is completethrown- The result of the operation attempt - ifnullthen reception was successful- Throws:
java.io.IOException- If failed to handle the event
-
startFolderEvent
public 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
- Specified by:
startFolderEventin interfaceScpTransferEventListener- Parameters:
session- The client/serverSessionthrough which the transfer is being executedop- TheScpTransferEventListener.FileOperationfile- The local referenced folderPathperms- ASetofPosixFilePermissions to be applied once transfer is complete- Throws:
java.io.IOException- If failed to handle the event
-
endFolderEvent
public 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
- Specified by:
endFolderEventin interfaceScpTransferEventListener- Parameters:
session- The client/serverSessionthrough which the transfer is being executedop- TheScpTransferEventListener.FileOperationfile- The local referenced filePathperms- ASetofPosixFilePermissions to be applied once transfer is completethrown- The result of the operation attempt - ifnullthen reception was successful- Throws:
java.io.IOException- If failed to handle the event
-
handleFileEventAckInfo
public void handleFileEventAckInfo(Session session, ScpTransferEventListener.FileOperation op, java.nio.file.Path file, long length, java.util.Set<java.nio.file.attribute.PosixFilePermission> perms, ScpAckInfo ackInfo) throws java.io.IOException
Description copied from interface:ScpTransferEventListenerCalled afterScpTransferEventListener.endFileEvent(Session, FileOperation, Path, long, Set, Throwable)if no exception was thrown and the peer's ACK was successfully read- Specified by:
handleFileEventAckInfoin interfaceScpTransferEventListener- Parameters:
session- The client/serverSessionthrough which the transfer is being executedop- TheScpTransferEventListener.FileOperationfile- The local referenced filePathlength- Size (in bytes) of transferred dataperms- ASetofPosixFilePermissions to be applied once transfer is completeackInfo- TheScpAckInforeceived after a file transfer - before validating it- Throws:
java.io.IOException- If failed to handle the event
-
-