Package org.apache.sshd.common.scp

Class AbstractScpTransferEventListenerAdapter

java.lang.Object

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

org.apache.sshd.common.scp.AbstractScpTransferEventListenerAdapter

All Implemented Interfaces:

java.util.EventListener, ScpTransferEventListener, SshdEventListener

public abstract class AbstractScpTransferEventListenerAdapter
extends AbstractLoggingBean
implements ScpTransferEventListener

A no-op implementation of ScpTransferEventListener for those who wish to implement only a small number of methods. By default, all non-overridden methods simply log at TRACE level their invocation parameters

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.scp.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.scp.ScpTransferEventListener

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScpTransferEventListenerAdapter()

Method Summary

Modifier and Type	Method	Description
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)
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)
void	startFileEvent(Session session, ScpTransferEventListener.FileOperation op, java.nio.file.Path file, long length, java.util.Set<java.nio.file.attribute.PosixFilePermission> perms)
void	startFolderEvent(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.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScpTransferEventListenerAdapter

protected AbstractScpTransferEventListenerAdapter()

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:

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:

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:

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:

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:

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:

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:

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:

java.io.IOException - If failed to handle the event