public interface SftpEventListener extends SshdEventListener
Modifier and Type | Method and Description |
---|---|
default void |
blocked(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
long length,
int mask,
Throwable thrown)
Called after blocking a file section
|
default void |
blocking(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
long length,
int mask)
Called prior to blocking a file section
|
default void |
closed(ServerSession session,
String remoteHandle,
Handle localHandle,
Throwable thrown)
Specified file / directory has been closed
|
default void |
closing(ServerSession session,
String remoteHandle,
Handle localHandle)
Specified file / directory about to be closed
|
default void |
created(ServerSession session,
Path path,
Map<String,?> attrs,
Throwable thrown)
Called after creating a directory
|
default void |
creating(ServerSession session,
Path path,
Map<String,?> attrs)
Called prior to creating a directory
|
default void |
destroying(ServerSession session)
Called when subsystem is destroyed since it was closed
|
default void |
exiting(ServerSession session,
Handle handle)
Called when subsystem is exiting due to being destroyed
|
default void |
initialized(ServerSession session,
int version)
Called when the SFTP protocol has been initialized
|
default void |
linked(ServerSession session,
Path source,
Path target,
boolean symLink,
Throwable thrown)
Called after creating a link
|
default void |
linking(ServerSession session,
Path source,
Path target,
boolean symLink)
Called prior to creating a link
|
default void |
modifiedAttributes(ServerSession session,
Path path,
Map<String,?> attrs,
Throwable thrown)
Called after modifying the attributes of a file / directory
|
default void |
modifyingAttributes(ServerSession session,
Path path,
Map<String,?> attrs)
Called prior to modifying the attributes of a file / directory
|
default void |
moved(ServerSession session,
Path srcPath,
Path dstPath,
Collection<CopyOption> opts,
Throwable thrown)
Called after renaming a file / directory
|
default void |
moving(ServerSession session,
Path srcPath,
Path dstPath,
Collection<CopyOption> opts)
Called prior to renaming a file / directory
|
default void |
open(ServerSession session,
String remoteHandle,
Handle localHandle)
Specified file / directory has been opened
|
default void |
openFailed(ServerSession session,
String remotePath,
Path localPath,
boolean isDirectory,
Throwable thrown)
Specified file / directory could not be opened - Note: this call may occur without
opening(ServerSession, String, Handle) ever having been called |
default void |
opening(ServerSession session,
String remoteHandle,
Handle localHandle)
Specified file / directory is being opened
|
default void |
read(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
byte[] data,
int dataOffset,
int dataLen,
int readLen,
Throwable thrown)
Result of reading from a file
|
default void |
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 response
|
default void |
reading(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
byte[] data,
int dataOffset,
int dataLen)
Preparing to read from a file
|
default void |
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 directory
|
default void |
received(ServerSession session,
int type,
int id)
Called when a SFTP request has been received before it is processed.
|
default void |
receivedExtension(ServerSession session,
String extension,
int id)
Called when a SFTP extension request
SftpConstants.SSH_FXP_EXTENDED has been received before it is
processed. |
default void |
removed(ServerSession session,
Path path,
boolean isDirectory,
Throwable thrown)
Called after a file has been removed
|
default void |
removing(ServerSession session,
Path path,
boolean isDirectory)
Called prior to removing a file
|
default void |
unblocked(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
long length,
Throwable thrown)
Called prior to un-blocking a file section
|
default void |
unblocking(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
long length)
Called prior to un-blocking a file section
|
static <L extends SftpEventListener> |
validateListener(L listener) |
default void |
writing(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
byte[] data,
int dataOffset,
int dataLen)
Preparing to write to file
|
default void |
written(ServerSession session,
String remoteHandle,
FileHandle localHandle,
long offset,
byte[] data,
int dataOffset,
int dataLen,
Throwable thrown)
Finished to writing to file
|
validateListener
default void received(ServerSession session, int type, int id) throws IOException
session
- The ServerSession
through which the request was receivedtype
- The request type; one of the SSH_FXP_*
constants from SftpConstants
id
- The id received with the requestIOException
- If the request shall generate an error response. Throwing an exception for
type =
SftpConstants.SSH_FXP_INIT
closes the session.default void receivedExtension(ServerSession session, String extension, int id) throws IOException
SftpConstants.SSH_FXP_EXTENDED
has been received before it is
processed.session
- The ServerSession
through which the request was receivedextension
- The extension request received; one of the SSH_EXT_*
constants from
SftpConstants
id
- The id received with the requestIOException
- If the request shall generate an error response.default void initialized(ServerSession session, int version) throws IOException
session
- The ServerSession
through which the request was handledversion
- The negotiated SFTP versionIOException
- If failed to handle the calldefault void exiting(ServerSession session, Handle handle) throws IOException
session
- The associated ServerSession
handle
- The file / directory Handle
being closed due to the exitIOException
- If failed to handle the calldefault void destroying(ServerSession session) throws IOException
session
- The associated ServerSession
IOException
- If failed to handle the calldefault void opening(ServerSession session, String remoteHandle, Handle localHandle) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directory Handle
IOException
- If failed to handle the calldefault void open(ServerSession session, String remoteHandle, Handle localHandle) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directory Handle
IOException
- If failed to handle the calldefault void openFailed(ServerSession session, String remotePath, Path localPath, boolean isDirectory, Throwable thrown) throws IOException
opening(ServerSession, String, Handle)
ever having been calledsession
- The ServerSession
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 failureIOException
- If failed to handle the calldefault void readingEntries(ServerSession session, String remoteHandle, DirectoryHandle localHandle) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the directorylocalHandle
- The associated DirectoryHandle
IOException
- If failed to handle the callreadEntries
default void readEntries(ServerSession session, String remoteHandle, DirectoryHandle localHandle, Map<String,Path> entries) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the directorylocalHandle
- The associated DirectoryHandle
entries
- A Map
of the listed entries - key = short name, value = Path
of the
sub-entryIOException
- If failed to handle the calldefault void reading(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
offset
- Offset in file from which to readdata
- Buffer holding the read datadataOffset
- Offset of read data in bufferdataLen
- Requested read lengthIOException
- If failed to handle the calldefault void read(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen, int readLen, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
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 exceptionIOException
- If failed to handle the calldefault void writing(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
offset
- Offset in file to which to writedata
- Buffer holding the written datadataOffset
- Offset of write data in bufferdataLen
- Requested write lengthIOException
- If failed to handle the calldefault void written(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
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 successfulIOException
- If failed to handle the calldefault void blocking(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, int mask) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
offset
- Offset in file for lockinglength
- Section size for lockingmask
- Lock mask flags - see SSH_FXP_BLOCK
messageIOException
- If failed to handle the callblocked(ServerSession, String, FileHandle, long, long, int, Throwable)
default void blocked(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, int mask, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
offset
- Offset in file for lockinglength
- Section size for lockingmask
- Lock mask flags - see SSH_FXP_BLOCK
messagethrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the calldefault void unblocking(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
offset
- Offset in file for un-lockinglength
- Section size for un-lockingIOException
- If failed to handle the calldefault void unblocked(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, long length, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the filelocalHandle
- The associated FileHandle
offset
- Offset in file for un-lockinglength
- Section size for un-lockingthrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the calldefault void closing(ServerSession session, String remoteHandle, Handle localHandle) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directory Handle
IOException
- If failed to handle the calldefault void closed(ServerSession session, String remoteHandle, Handle localHandle, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledremoteHandle
- The (opaque) assigned handle for the file / directorylocalHandle
- The associated file / directory Handle
thrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the calldefault void creating(ServerSession session, Path path, Map<String,?> attrs) throws IOException
session
- The ServerSession
through which the request was handledpath
- Directory Path
to be createdattrs
- Requested associated attributes to setIOException
- If failed to handle the callcreated(ServerSession, Path, Map, Throwable)
default void created(ServerSession session, Path path, Map<String,?> attrs, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledpath
- Directory Path
to be createdattrs
- Requested associated attributes to setthrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the calldefault void moving(ServerSession session, Path srcPath, Path dstPath, Collection<CopyOption> opts) throws IOException
session
- The ServerSession
through which the request was handledsrcPath
- The source Path
dstPath
- The target Path
opts
- The resolved renaming optionsIOException
- If failed to handle the callmoved(ServerSession, Path, Path, Collection, Throwable)
default void moved(ServerSession session, Path srcPath, Path dstPath, Collection<CopyOption> opts, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledsrcPath
- The source Path
dstPath
- The target Path
opts
- The resolved renaming optionsthrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the calldefault void removing(ServerSession session, Path path, boolean isDirectory) throws IOException
session
- The ServerSession
through which the request was handledpath
- The Path
about to be removedisDirectory
- Whether this is a folder or a fileIOException
- If failed to handle the callremoved(ServerSession, Path, boolean, Throwable)
default void removed(ServerSession session, Path path, boolean isDirectory, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledpath
- The Path
to be removedisDirectory
- Whether this was a folder or a filethrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the calldefault void linking(ServerSession session, Path source, Path target, boolean symLink) throws IOException
session
- The ServerSession
through which the request was handledsource
- The source Path
target
- The target Path
symLink
- true
= symbolic linkIOException
- If failed to handle the calllinked(ServerSession, Path, Path, boolean, Throwable)
default void linked(ServerSession session, Path source, Path target, boolean symLink, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledsource
- The source Path
target
- The target Path
symLink
- true
= symbolic linkthrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the calldefault void modifyingAttributes(ServerSession session, Path path, Map<String,?> attrs) throws IOException
session
- The ServerSession
through which the request was handledpath
- The file / directory Path
to be modifiedattrs
- The attributes Map
- names and values depend on the O/S, view, type, etc...IOException
- If failed to handle the callmodifiedAttributes(ServerSession, Path, Map, Throwable)
default void modifiedAttributes(ServerSession session, Path path, Map<String,?> attrs, Throwable thrown) throws IOException
session
- The ServerSession
through which the request was handledpath
- The file / directory Path
to be modifiedattrs
- The attributes Map
- names and values depend on the O/S, view, type, etc...thrown
- If not-null
then the reason for the failure to executeIOException
- If failed to handle the callstatic <L extends SftpEventListener> L validateListener(L listener)
Copyright © 2008–2024 The Apache Software Foundation. All rights reserved.