org.apache.sshd.server.subsystem.sftp

Interface SftpFileSystemAccessor

public interface SftpFileSystemAccessor

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static SftpFileSystemAccessor	DEFAULT

Method Summary

Modifier and Type	Method and Description
default DirectoryStream<Path>	openDirectory(ServerSession session, SftpEventListenerManager subsystem, Path dir, String handle) Called when a new directory stream is requested
default SeekableByteChannel	openFile(ServerSession session, SftpEventListenerManager subsystem, Path file, String handle, Set<? extends OpenOption> options, FileAttribute<?>... attrs) Called whenever a new file is opened
default void	syncFileData(ServerSession session, SftpEventListenerManager subsystem, Path file, String handle, Channel channel) Called when file meta-data re-synchronization is required
default FileLock	tryLock(ServerSession session, SftpEventListenerManager subsystem, Path file, String handle, Channel channel, long position, long size, boolean shared) Called when locking a section of a file is requested

Field Detail

DEFAULT

static final SftpFileSystemAccessor DEFAULT

Method Detail

openFile

default SeekableByteChannel openFile(ServerSession session,
                                     SftpEventListenerManager subsystem,
                                     Path file,
                                     String handle,
                                     Set<? extends OpenOption> options,
                                     FileAttribute<?>... attrs)
                              throws IOException

Called whenever a new file is opened

Parameters:

session - The ServerSession through which the request was received

subsystem - The SFTP subsystem instance that manages the session

file - The requested local file Path

handle - The assigned file handle through which the remote peer references this file. May be null/empty if the request is due to some internal functionality instead of due to peer requesting a handle to a file.

options - The requested OpenOptions

attrs - The requested FileAttributes

Returns:

The opened SeekableByteChannel

Throws:

IOException - If failed to open

tryLock

default FileLock tryLock(ServerSession session,
                         SftpEventListenerManager subsystem,
                         Path file,
                         String handle,
                         Channel channel,
                         long position,
                         long size,
                         boolean shared)
                  throws IOException

Called when locking a section of a file is requested

Parameters:

session - The ServerSession through which the request was received

subsystem - The SFTP subsystem instance that manages the session

file - The requested local file Path

handle - The assigned file handle through which the remote peer references this file

channel - The original Channel that was returned by openFile(ServerSession, SftpEventListenerManager, Path, String, Set, FileAttribute...)

position - The position at which the locked region is to start - must be non-negative

size - The size of the locked region; must be non-negative, and the sum position + size must be non-negative

shared - true to request a shared lock, false to request an exclusive lock

Returns:

A lock object representing the newly-acquired lock, or null if the lock could not be acquired because another program holds an overlapping lock

Throws:

IOException - If failed to honor the request

See Also:

FileChannel.tryLock(long, long, boolean)

syncFileData

default void syncFileData(ServerSession session,
                          SftpEventListenerManager subsystem,
                          Path file,
                          String handle,
                          Channel channel)
                   throws IOException

Called when file meta-data re-synchronization is required

Parameters:

session - The ServerSession through which the request was received

subsystem - The SFTP subsystem instance that manages the session

file - The requested local file Path

handle - The assigned file handle through which the remote peer references this file

channel - The original Channel that was returned by openFile(ServerSession, SftpEventListenerManager, Path, String, Set, FileAttribute...)

Throws:

IOException - If failed to execute the request

See Also:

FileChannel.force(boolean), OpenSSH - section 10

openDirectory

default DirectoryStream<Path> openDirectory(ServerSession session,
                                            SftpEventListenerManager subsystem,
                                            Path dir,
                                            String handle)
                                     throws IOException

Called when a new directory stream is requested

Parameters:

session - The ServerSession through which the request was received

subsystem - The SFTP subsystem instance that manages the session

dir - The requested local directory

handle - The assigned directory handle through which the remote peer references this directory

Returns:

The opened DirectoryStream

Throws:

IOException - If failed to open