Package org.apache.sshd.sftp.server
Class AbstractSftpEventListenerAdapter
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.sftp.server.AbstractSftpEventListenerAdapter
- All Implemented Interfaces:
EventListener
,SshdEventListener
,SftpEventListener
public abstract class AbstractSftpEventListenerAdapter
extends AbstractLoggingBean
implements SftpEventListener
A no-op implementation of
SftpEventListener
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-
Field Summary
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
blocked
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, int mask, Throwable thrown) Called after blocking a file sectionvoid
blocking
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, int mask) Called prior to blocking a file sectionvoid
closed
(ServerSession session, String remoteHandle, Handle localHandle, Throwable thrown) Specified file / directory has been closedvoid
closing
(ServerSession session, String remoteHandle, Handle localHandle) Specified file / directory about to be closedvoid
Called after creating a directoryvoid
creating
(ServerSession session, Path path, Map<String, ?> attrs) Called prior to creating a directoryvoid
destroying
(ServerSession session) Called when subsystem is destroyed since it was closedvoid
exiting
(ServerSession session, Handle handle) Called when subsystem is exiting due to being destroyedvoid
initialized
(ServerSession session, int version) Called when the SFTP protocol has been initializedvoid
linked
(ServerSession session, Path source, Path target, boolean symLink, Throwable thrown) Called after creating a linkvoid
linking
(ServerSession session, Path source, Path target, boolean symLink) Called prior to creating a linkvoid
modifiedAttributes
(ServerSession session, Path path, Map<String, ?> attrs, Throwable thrown) Called after modifying the attributes of a file / directoryvoid
modifyingAttributes
(ServerSession session, Path path, Map<String, ?> attrs) Called prior to modifying the attributes of a file / directoryvoid
moved
(ServerSession session, Path srcPath, Path dstPath, Collection<CopyOption> opts, Throwable thrown) Called after renaming a file / directoryvoid
moving
(ServerSession session, Path srcPath, Path dstPath, Collection<CopyOption> opts) Called prior to renaming a file / directoryvoid
open
(ServerSession session, String remoteHandle, Handle localHandle) Specified file / directory has been openedvoid
openFailed
(ServerSession session, String remotePath, Path localPath, boolean isDirectory, Throwable thrown) Specified file / directory could not be opened - Note: this call may occur withoutSftpEventListener.opening(ServerSession, String, Handle)
ever having been calledvoid
opening
(ServerSession session, String remoteHandle, Handle localHandle) Specified file / directory is being openedvoid
read
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen, int readLen, Throwable thrown) Result of reading from a filevoid
readEntries
(ServerSession session, String remoteHandle, DirectoryHandle localHandle, Map<String, Path> entries) Result of reading entries from a directory - Note: it may be a partial result if the directory contains more entries than can be accommodated in the responsevoid
reading
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) Preparing to read from a filevoid
readingEntries
(ServerSession session, String remoteHandle, DirectoryHandle localHandle) About to read entries from a directory - Note: might not be the 1st time it is called for the directory in case several iterations are required in order to go through all the entries in the directoryvoid
receivedExtension
(ServerSession session, String extension, int id) Called when a SFTP extension requestSftpConstants.SSH_FXP_EXTENDED
has been received before it is processed.void
removed
(ServerSession session, Path path, boolean isDirectory, Throwable thrown) Called after a file has been removedvoid
removing
(ServerSession session, Path path, boolean isDirectory) Called prior to removing a filevoid
unblocked
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, Throwable thrown) Called prior to un-blocking a file sectionvoid
unblocking
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length) Called prior to un-blocking a file sectionvoid
writing
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) Preparing to write to filevoid
written
(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen, Throwable thrown) Finished to writing to fileMethods 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.sftp.server.SftpEventListener
received
-
Constructor Details
-
AbstractSftpEventListenerAdapter
protected AbstractSftpEventListenerAdapter()
-
-
Method Details
-
receivedExtension
Description copied from interface:SftpEventListener
Called when a SFTP extension requestSftpConstants.SSH_FXP_EXTENDED
has been received before it is processed.- Specified by:
receivedExtension
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was receivedextension
- The extension request received; one of theSSH_EXT_*
constants fromSftpConstants
id
- The id received with the request- Throws:
IOException
- If the request shall generate an error response.
-
initialized
Description copied from interface:SftpEventListener
Called when the SFTP protocol has been initialized- Specified by:
initialized
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledversion
- The negotiated SFTP version- Throws:
IOException
- If failed to handle the call
-
destroying
Description copied from interface:SftpEventListener
Called when subsystem is destroyed since it was closed- Specified by:
destroying
in interfaceSftpEventListener
- Parameters:
session
- The associatedServerSession
- Throws:
IOException
- If failed to handle the call
-
opening
public void opening(ServerSession session, String remoteHandle, Handle localHandle) throws IOException Description copied from interface:SftpEventListener
Specified file / directory is being opened- Specified by:
opening
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directoryHandle
- Throws:
IOException
- If failed to handle the call
-
openFailed
public void openFailed(ServerSession session, String remotePath, Path localPath, boolean isDirectory, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Specified file / directory could not be opened - Note: this call may occur withoutSftpEventListener.opening(ServerSession, String, Handle)
ever having been called- Specified by:
openFailed
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremotePath
- The path that was specified in the commandlocalPath
- The matching resolved local pathisDirectory
- Whether this was a folder or a filethrown
- Non-null
reason for the failure- Throws:
IOException
- If failed to handle the call
-
open
Description copied from interface:SftpEventListener
Specified file / directory has been opened- Specified by:
open
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directoryHandle
- Throws:
IOException
- If failed to handle the call
-
readingEntries
public void readingEntries(ServerSession session, String remoteHandle, DirectoryHandle localHandle) throws IOException Description copied from interface:SftpEventListener
About to read entries from a directory - Note: might not be the 1st time it is called for the directory in case several iterations are required in order to go through all the entries in the directory- Specified by:
readingEntries
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the directorylocalHandle
- The associatedDirectoryHandle
- Throws:
IOException
- If failed to handle the call- See Also:
-
readEntries
public void readEntries(ServerSession session, String remoteHandle, DirectoryHandle localHandle, Map<String, Path> entries) throws IOExceptionDescription copied from interface:SftpEventListener
Result of reading entries from a directory - Note: it may be a partial result if the directory contains more entries than can be accommodated in the response- Specified by:
readEntries
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the directorylocalHandle
- The associatedDirectoryHandle
entries
- AMap
of the listed entries - key = short name, value =Path
of the sub-entry- Throws:
IOException
- If failed to handle the call
-
reading
public void reading(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) throws IOException Description copied from interface:SftpEventListener
Preparing to read from a file- Specified by:
reading
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file from which to readdata
- Buffer holding the read datadataOffset
- Offset of read data in bufferdataLen
- Requested read length- Throws:
IOException
- If failed to handle the call
-
read
public void read(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen, int readLen, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Result of reading from a file- Specified by:
read
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file from which to readdata
- Buffer holding the read datadataOffset
- Offset of read data in bufferdataLen
- Requested read lengthreadLen
- Actual read length - negative if thrown exception providedthrown
- Non-null
if read failed due to this exception- Throws:
IOException
- If failed to handle the call
-
writing
public void writing(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) throws IOException Description copied from interface:SftpEventListener
Preparing to write to file- Specified by:
writing
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file to which to writedata
- Buffer holding the written datadataOffset
- Offset of write data in bufferdataLen
- Requested write length- Throws:
IOException
- If failed to handle the call
-
written
public void written(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Finished to writing to file- Specified by:
written
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file to which to writedata
- Buffer holding the written datadataOffset
- Offset of write data in bufferdataLen
- Requested write lengththrown
- The reason for failing to write -null
if successful- Throws:
IOException
- If failed to handle the call
-
blocking
public void blocking(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, int mask) throws IOException Description copied from interface:SftpEventListener
Called prior to blocking a file section- Specified by:
blocking
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file for lockinglength
- Section size for lockingmask
- Lock mask flags - seeSSH_FXP_BLOCK
message- Throws:
IOException
- If failed to handle the call- See Also:
-
blocked
public void blocked(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, int mask, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Called after blocking a file section- Specified by:
blocked
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file for lockinglength
- Section size for lockingmask
- Lock mask flags - seeSSH_FXP_BLOCK
messagethrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
unblocking
public void unblocking(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length) throws IOException Description copied from interface:SftpEventListener
Called prior to un-blocking a file section- Specified by:
unblocking
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file for un-lockinglength
- Section size for un-locking- Throws:
IOException
- If failed to handle the call
-
unblocked
public void unblocked(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Called prior to un-blocking a file section- Specified by:
unblocked
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associatedFileHandle
offset
- Offset in file for un-lockinglength
- Section size for un-lockingthrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
closing
public void closing(ServerSession session, String remoteHandle, Handle localHandle) throws IOException Description copied from interface:SftpEventListener
Specified file / directory about to be closed- Specified by:
closing
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directoryHandle
- Throws:
IOException
- If failed to handle the call
-
closed
public void closed(ServerSession session, String remoteHandle, Handle localHandle, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Specified file / directory has been closed- Specified by:
closed
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directoryHandle
thrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
creating
Description copied from interface:SftpEventListener
Called prior to creating a directory- Specified by:
creating
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledpath
- DirectoryPath
to be createdattrs
- Requested associated attributes to set- Throws:
IOException
- If failed to handle the call- See Also:
-
created
public void created(ServerSession session, Path path, Map<String, ?> attrs, Throwable thrown) throws IOExceptionDescription copied from interface:SftpEventListener
Called after creating a directory- Specified by:
created
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledpath
- DirectoryPath
to be createdattrs
- Requested associated attributes to setthrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
moving
public void moving(ServerSession session, Path srcPath, Path dstPath, Collection<CopyOption> opts) throws IOException Description copied from interface:SftpEventListener
Called prior to renaming a file / directory- Specified by:
moving
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledsrcPath
- The sourcePath
dstPath
- The targetPath
opts
- The resolved renaming options- Throws:
IOException
- If failed to handle the call- See Also:
-
moved
public void moved(ServerSession session, Path srcPath, Path dstPath, Collection<CopyOption> opts, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Called after renaming a file / directory- Specified by:
moved
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledsrcPath
- The sourcePath
dstPath
- The targetPath
opts
- The resolved renaming optionsthrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
removing
Description copied from interface:SftpEventListener
Called prior to removing a file- Specified by:
removing
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledpath
- ThePath
about to be removedisDirectory
- Whether this is a folder or a file- Throws:
IOException
- If failed to handle the call- See Also:
-
removed
public void removed(ServerSession session, Path path, boolean isDirectory, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Called after a file has been removed- Specified by:
removed
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledpath
- ThePath
to be removedisDirectory
- Whether this was a folder or a filethrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
linking
public void linking(ServerSession session, Path source, Path target, boolean symLink) throws IOException Description copied from interface:SftpEventListener
Called prior to creating a link- Specified by:
linking
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledsource
- The sourcePath
target
- The targetPath
symLink
-true
= symbolic link- Throws:
IOException
- If failed to handle the call- See Also:
-
linked
public void linked(ServerSession session, Path source, Path target, boolean symLink, Throwable thrown) throws IOException Description copied from interface:SftpEventListener
Called after creating a link- Specified by:
linked
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledsource
- The sourcePath
target
- The targetPath
symLink
-true
= symbolic linkthrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
modifyingAttributes
public void modifyingAttributes(ServerSession session, Path path, Map<String, ?> attrs) throws IOExceptionDescription copied from interface:SftpEventListener
Called prior to modifying the attributes of a file / directory- Specified by:
modifyingAttributes
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledpath
- The file / directoryPath
to be modifiedattrs
- The attributesMap
- names and values depend on the O/S, view, type, etc...- Throws:
IOException
- If failed to handle the call- See Also:
-
modifiedAttributes
public void modifiedAttributes(ServerSession session, Path path, Map<String, ?> attrs, Throwable thrown) throws IOExceptionDescription copied from interface:SftpEventListener
Called after modifying the attributes of a file / directory- Specified by:
modifiedAttributes
in interfaceSftpEventListener
- Parameters:
session
- TheServerSession
through which the request was handledpath
- The file / directoryPath
to be modifiedattrs
- The attributesMap
- names and values depend on the O/S, view, type, etc...thrown
- If not-null
then the reason for the failure to execute- Throws:
IOException
- If failed to handle the call
-
exiting
Description copied from interface:SftpEventListener
Called when subsystem is exiting due to being destroyed- Specified by:
exiting
in interfaceSftpEventListener
- Parameters:
session
- The associatedServerSession
handle
- The file / directoryHandle
being closed due to the exit- Throws:
IOException
- If failed to handle the call
-