SftpSubsystem (Apache Mina SSHD 2.2.0 API)

java.lang.Object
- org.apache.sshd.common.util.logging.AbstractLoggingBean
- - org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper
  - - org.apache.sshd.server.subsystem.sftp.SftpSubsystem

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, FileSystemAware, ExecutorServiceCarrier, ChannelDataReceiver, ChannelSessionAware, AsyncCommand, Command, CommandLifecycle, ServerSessionHolder, SessionAware, SftpEventListenerManager, SftpSubsystemEnvironment
```
public class SftpSubsystem
extends AbstractSftpSubsystemHelper
implements Command, Runnable, SessionAware, FileSystemAware, ExecutorServiceCarrier, AsyncCommand, ChannelSessionAware, ChannelDataReceiver
```
SFTP subsystem

Author:

Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type	Field and Description
`protected Buffer`	`buffer`
`protected ExitCallback`	`callback`
`protected ChannelSession`	`channelSession`
`protected static Buffer`	`CLOSE`
`protected AtomicBoolean`	`closed`
`static int`	`DEFAULT_FILE_HANDLE_ROUNDS`
`static int`	`DEFAULT_FILE_HANDLE_SIZE`
`static int`	`DEFAULT_MAX_OPEN_HANDLES`
`static int`	`DEFAULT_MAX_READDIR_DATA_SIZE`
`protected Path`	`defaultDir`
`protected Environment`	`env`
`protected IoOutputStream`	`err`
`protected CloseableExecutorService`	`executorService`
`protected Map<String,byte[]>`	`extensions`
`static String`	`FILE_HANDLE_SIZE` Size in bytes of the opaque handle value
`protected int`	`fileHandleSize`
`protected FileSystem`	`fileSystem`
`protected Map<String,Handle>`	`handles`
`static String`	`MAX_FILE_HANDLE_RAND_ROUNDS` Max.
`static int`	`MAX_FILE_HANDLE_ROUNDS`
`static int`	`MAX_FILE_HANDLE_SIZE`
`static String`	`MAX_OPEN_HANDLES_PER_SESSION` Properties key for the maximum of available open handles per session.
`static String`	`MAX_READDIR_DATA_SIZE_PROP` Maximum amount of data allocated for listing the contents of a directory in any single invocation of `doReadDir(Buffer, int)`
`protected int`	`maxFileHandleRounds`
`static int`	`MIN_FILE_HANDLE_ROUNDS`
`static int`	`MIN_FILE_HANDLE_SIZE`
`protected IoOutputStream`	`out`
`protected Future<?>`	`pendingFuture`
`protected Random`	`randomizer`
`protected BlockingQueue<Buffer>`	`requests`
`protected AtomicLong`	`requestsCount`
`protected ServerSession`	`serverSession`
`protected int`	`version`
`protected byte[]`	`workBuf`

Fields inherited from class org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper
ACL_SUPPORTED_MASK_PROP, AUTO_FOLLOW_LINKS, CLIENT_EXTENSIONS_PROP, DEFAULT_ACL_SUPPORTED_MASK, DEFAULT_AUTO_FOLLOW_LINKS, DEFAULT_MAX_READDATA_PACKET_LENGTH, DEFAULT_OPEN_SSH_EXTENSIONS, DEFAULT_OPEN_SSH_EXTENSIONS_NAMES, DEFAULT_SUPPORTED_CLIENT_EXTENSIONS, MAX_READDATA_PACKET_LENGTH_PROP, NEWLINE_VALUE, OPENSSH_EXTENSIONS_PROP

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log

Fields inherited from interface org.apache.sshd.server.subsystem.sftp.SftpSubsystemEnvironment
ALL_SFTP_IMPL, HIGHER_SFTP_IMPL, LOWER_SFTP_IMPL, SFTP_VERSION

Constructor Summary

Constructors
Constructor and Description
`SftpSubsystem(CloseableExecutorService executorService, UnsupportedAttributePolicy policy, SftpFileSystemAccessor accessor, SftpErrorStatusDataHandler errorStatusDataHandler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Called to indicate EOF.
`protected void`	`closeAllHandles()`
`protected void`	`createLink(int id, String existingPath, String linkPath, boolean symLink)`
`int`	`data(ChannelSession channel, byte[] buf, int start, int len)` Called when the server receives additional bytes from the client.
`void`	`destroy()` This method is called by the SSH server to destroy the command because the client has disconnected somehow.
`protected void`	`doBlock(int id, String handle, long offset, long length, int mask)`
`protected void`	`doCheckFileHash(int id, String targetType, String target, Collection<String> algos, long startOffset, long length, int blockSize, Buffer buffer)`
`protected void`	`doClose(int id, String handle)`
`protected void`	`doCopyData(int id, String readHandle, long readOffset, long readLength, String writeHandle, long writeOffset)`
`protected void`	`doFSetStat(int id, String handle, Map<String,?> attrs)`
`protected Map<String,Object>`	`doFStat(int id, String handle, int flags)`
`protected void`	`doInit(Buffer buffer, int id)`
`protected byte[]`	`doMD5Hash(int id, String targetType, String target, long startOffset, long length, byte[] quickCheckHash)`
`protected String`	`doOpen(int id, String path, int pflags, int access, Map<String,Object> attrs)`
`protected String`	`doOpenDir(int id, String path, Path p, LinkOption... options)`
`protected void`	`doOpenSSHFsync(int id, String handle)`
`protected void`	`doProcess(Buffer buffer, int length, int type, int id)`
`protected int`	`doRead(int id, String handle, long offset, int length, byte[] data, int doff)`
`protected void`	`doReadDir(Buffer buffer, int id)`
`protected void`	`doTextSeek(int id, String handle, long line)`
`protected void`	`doUnblock(int id, String handle, long offset, long length)`
`protected void`	`doVersionSelect(Buffer buffer, int id, String proposed)`
`protected void`	`doWrite(int id, String handle, long offset, int length, byte[] data, int doff, int remaining)`
`protected String`	`generateFileHandle(Path file)`
`Path`	`getDefaultDirectory()`
`CloseableExecutorService`	`getExecutorService()`
`ServerSession`	`getServerSession()`
`int`	`getVersion()`
`protected Buffer`	`prepareReply(Buffer buffer)`
`void`	`run()`
`protected void`	`send(Buffer buffer)`
`void`	`setChannelSession(ChannelSession session)` Receives the channel in which the command is being executed.
`void`	`setErrorStream(OutputStream err)` Set the error stream that can be used by the shell to write its errors.
`void`	`setExitCallback(ExitCallback callback)` Set the callback that the shell has to call when it is closed.
`void`	`setFileSystem(FileSystem fileSystem)` Set the file system in which this shell will be executed.
`void`	`setInputStream(InputStream in)` Set the input stream that can be used by the shell to read input.
`void`	`setIoErrorStream(IoOutputStream err)` Set the error stream that can be used by the shell to write its errors.
`void`	`setIoInputStream(IoInputStream in)` Set the input stream that can be used by the shell to read input.
`void`	`setIoOutputStream(IoOutputStream out)` Set the output stream that can be used by the shell to write its output.
`void`	`setOutputStream(OutputStream out)` Set the output stream that can be used by the shell to write its output.
`void`	`setSession(ServerSession session)`
`void`	`start(Environment env)` Starts the command execution.

Methods inherited from class org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper
addMissingAttribute, addSftpEventListener, appendAclSupportedExtension, appendExtensions, appendNewlineExtension, appendOpenSSHExtensions, appendSupported2Extension, appendSupportedExtension, appendVendorIdExtension, appendVersionsExtension, checkVersionCompatibility, doBlock, doCheckFileHash, doCheckFileHash, doClose, doCopyData, doCopyFile, doCopyFile, doCopyFile, doExtended, doFSetStat, doFStat, doLink, doLink, doLStat, doLStat, doMakeDirectory, doMakeDirectory, doMD5Hash, doMD5Hash, doOpen, doOpenDir, doOpenSSHFsync, doOpenSSHHardLink, doOpenSSHHardLink, doRead, doReadDir, doReadLink, doReadLink, doRealPath, doRealPathV345, doRealPathV6, doRemove, doRemove, doRemove, doRemoveDirectory, doRemoveDirectory, doRename, doRename, doRename, doSetAttributes, doSetStat, doSetStat, doSpaceAvailable, doSpaceAvailable, doStat, doStat, doSymLink, doSymLink, doTextSeek, doUnblock, doUnsupported, doUnsupportedExtension, doVersionSelect, doWrite, executeExtendedCommand, getAttributes, getAttributes, getErrorStatusDataHandler, getFileSystemAccessor, getLongName, getLongName, getLongName, getPathResolutionLinkOption, getSftpEventListenerProxy, getShortName, getSupportedClientExtensions, getUnsupportedAttributePolicy, handleReadFileAttributesException, handleSetFileAttributeFailure, handleUnknownStatusFileAttributes, handleUnsupportedAttributes, handleUserPrincipalLookupServiceException, normalize, process, readAttrs, readFileAttributes, removeSftpEventListener, resolveAclSupportedCapabilities, resolveFile, resolveFileAttributes, resolveMissingFileAttributes, resolveMissingFileAttributeValue, resolveNewlineValue, resolveNormalizedLocation, resolveOpenSSHExtensions, sendAttrs, sendHandle, sendLink, sendPath, sendStatus, sendStatus, sendStatus, setFileAccessControl, setFileAttribute, setFileAttributes, setFileExtensions, setFileOwnership, setFilePermissions, setFileTime, signalOpenFailure, signalRemovalPreConditionFailure, toGroup, toUser, validateHandle, validateProposedVersion, validateRealPath, writeAttrs, writeDirEntry

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

- Field Detail
  - MAX_OPEN_HANDLES_PER_SESSION
```
public static final String MAX_OPEN_HANDLES_PER_SESSION
```
    Properties key for the maximum of available open handles per session.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_OPEN_HANDLES
```
public static final int DEFAULT_MAX_OPEN_HANDLES
```
    See Also:
    
    Constant Field Values
  - FILE_HANDLE_SIZE
```
public static final String FILE_HANDLE_SIZE
```
    Size in bytes of the opaque handle value
    
    See Also:
    
    DEFAULT_FILE_HANDLE_SIZE, Constant Field Values
  - MIN_FILE_HANDLE_SIZE
```
public static final int MIN_FILE_HANDLE_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FILE_HANDLE_SIZE
```
public static final int DEFAULT_FILE_HANDLE_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_FILE_HANDLE_SIZE
```
public static final int MAX_FILE_HANDLE_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_FILE_HANDLE_RAND_ROUNDS
```
public static final String MAX_FILE_HANDLE_RAND_ROUNDS
```
    Max. rounds to attempt to create a unique file handle - if all handles already in use after these many rounds, then an exception is thrown
    
    See Also:
    
    generateFileHandle(Path), DEFAULT_FILE_HANDLE_ROUNDS, Constant Field Values
  - MIN_FILE_HANDLE_ROUNDS
```
public static final int MIN_FILE_HANDLE_ROUNDS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FILE_HANDLE_ROUNDS
```
public static final int DEFAULT_FILE_HANDLE_ROUNDS
```
    See Also:
    
    Constant Field Values
  - MAX_FILE_HANDLE_ROUNDS
```
public static final int MAX_FILE_HANDLE_ROUNDS
```
    See Also:
    
    Constant Field Values
  - MAX_READDIR_DATA_SIZE_PROP
```
public static final String MAX_READDIR_DATA_SIZE_PROP
```
    Maximum amount of data allocated for listing the contents of a directory in any single invocation of doReadDir(Buffer, int)
    
    See Also:
    
    DEFAULT_MAX_READDIR_DATA_SIZE, Constant Field Values
  - DEFAULT_MAX_READDIR_DATA_SIZE
```
public static final int DEFAULT_MAX_READDIR_DATA_SIZE
```
    See Also:
    
    Constant Field Values
  - CLOSE
```
protected static final Buffer CLOSE
```
  - closed
```
protected final AtomicBoolean closed
```
  - requestsCount
```
protected final AtomicLong requestsCount
```
  - extensions
```
protected final Map<String,byte[]> extensions
```
  - handles
```
protected final Map<String,Handle> handles
```
  - buffer
```
protected final Buffer buffer
```
  - requests
```
protected final BlockingQueue<Buffer> requests
```
  - callback
```
protected ExitCallback callback
```
  - out
```
protected IoOutputStream out
```
  - err
```
protected IoOutputStream err
```
  - env
```
protected Environment env
```
  - randomizer
```
protected Random randomizer
```
  - fileHandleSize
```
protected int fileHandleSize
```
  - maxFileHandleRounds
```
protected int maxFileHandleRounds
```
  - pendingFuture
```
protected Future<?> pendingFuture
```
  - workBuf
```
protected byte[] workBuf
```
  - fileSystem
```
protected FileSystem fileSystem
```
  - defaultDir
```
protected Path defaultDir
```
  - version
```
protected int version
```
  - serverSession
```
protected ServerSession serverSession
```
  - channelSession
```
protected ChannelSession channelSession
```
  - executorService
```
protected CloseableExecutorService executorService
```
- Constructor Detail
  - SftpSubsystem
```
public SftpSubsystem(CloseableExecutorService executorService,
                     UnsupportedAttributePolicy policy,
                     SftpFileSystemAccessor accessor,
                     SftpErrorStatusDataHandler errorStatusDataHandler)
```
    Parameters:
    
    executorService - The CloseableExecutorService to be used by the SftpSubsystem command when starting execution. If null then a single-threaded ad-hoc service is used.
    
    policy - The UnsupportedAttributePolicy to use if failed to access some local file attributes
    
    accessor - The SftpFileSystemAccessor to use for opening files and directories
    
    errorStatusDataHandler - The (never null) SftpErrorStatusDataHandler to use when generating failed commands error messages
    
    See Also:
    
    ThreadUtils.newSingleThreadExecutor(String)
- Method Detail
  - getVersion
```
public int getVersion()
```
    Specified by:
    
    getVersion in interface SftpSubsystemEnvironment
    
    Returns:
    
    The negotiated version
  - getDefaultDirectory
```
public Path getDefaultDirectory()
```
    Specified by:
    
    getDefaultDirectory in interface SftpSubsystemEnvironment
    
    Returns:
    
    The default root directory used to resolve relative paths - a.k.a. the chroot location
  - getExecutorService
```
public CloseableExecutorService getExecutorService()
```
    Specified by:
    
    getExecutorService in interface ExecutorServiceCarrier
    
    Returns:
    
    The CloseableExecutorService to use
  - setSession
```
public void setSession(ServerSession session)
```
    Specified by:
    
    setSession in interface SessionAware
    
    Parameters:
    
    session - The ServerSession in which this shell will be executed.
  - getServerSession
```
public ServerSession getServerSession()
```
    Specified by:
    
    getServerSession in interface ServerSessionHolder
    
    Returns:
    
    The underlying ServerSession used
  - setChannelSession
```
public void setChannelSession(ChannelSession session)
```
    Description copied from interface: ChannelSessionAware
    
    Receives the channel in which the command is being executed.
    
    Specified by:
    
    setChannelSession in interface ChannelSessionAware
    
    Parameters:
    
    session - never null
  - setFileSystem
```
public void setFileSystem(FileSystem fileSystem)
```
    Description copied from interface: FileSystemAware
    
    Set the file system in which this shell will be executed.
    
    Specified by:
    
    setFileSystem in interface FileSystemAware
    
    Parameters:
    
    fileSystem - the file system
  - setExitCallback
```
public void setExitCallback(ExitCallback callback)
```
    Description copied from interface: Command
    
    Set the callback that the shell has to call when it is closed.
    
    Specified by:
    
    setExitCallback in interface Command
    
    Parameters:
    
    callback - The ExitCallback to call when shell is closed
  - setInputStream
```
public void setInputStream(InputStream in)
```
    Description copied from interface: Command
    
    Set the input stream that can be used by the shell to read input.
    
    Specified by:
    
    setInputStream in interface Command
    
    Parameters:
    
    in - The InputStream used by the shell to read input.
  - setOutputStream
```
public void setOutputStream(OutputStream out)
```
    Description copied from interface: Command
    
    Set the output stream that can be used by the shell to write its output.
    
    Specified by:
    
    setOutputStream in interface Command
    
    Parameters:
    
    out - The OutputStream used by the shell to write its output
  - setErrorStream
```
public void setErrorStream(OutputStream err)
```
    Description copied from interface: Command
    
    Set the error stream that can be used by the shell to write its errors.
    
    Specified by:
    
    setErrorStream in interface Command
    
    Parameters:
    
    err - The OutputStream used by the shell to write its errors
  - setIoInputStream
```
public void setIoInputStream(IoInputStream in)
```
    Description copied from interface: AsyncCommand
    
    Set the input stream that can be used by the shell to read input.
    
    Specified by:
    
    setIoInputStream in interface AsyncCommand
    
    Parameters:
    
    in - The IoInputStream used by the shell to read input
  - setIoOutputStream
```
public void setIoOutputStream(IoOutputStream out)
```
    Description copied from interface: AsyncCommand
    
    Set the output stream that can be used by the shell to write its output.
    
    Specified by:
    
    setIoOutputStream in interface AsyncCommand
    
    Parameters:
    
    out - The IoOutputStream used by the shell to write its output
  - setIoErrorStream
```
public void setIoErrorStream(IoOutputStream err)
```
    Description copied from interface: AsyncCommand
    
    Set the error stream that can be used by the shell to write its errors.
    
    Specified by:
    
    setIoErrorStream in interface AsyncCommand
    
    Parameters:
    
    err - The IoOutputStream used by the shell to write its errors
  - start
```
public void start(Environment env)
           throws IOException
```
    Description copied from interface: CommandLifecycle
    Starts the command execution. All streams must have been set before calling this method. The command should implement Runnable, and this method should spawn a new thread like:
```
  Thread(this).start(); 
 
```
    Specified by:
    
    start in interface CommandLifecycle
    
    Parameters:
    
    env - The Environment
    
    Throws:
    
    IOException - If failed to start
  - data
```
public int data(ChannelSession channel,
                byte[] buf,
                int start,
                int len)
         throws IOException
```
    Description copied from interface: ChannelDataReceiver
    
    Called when the server receives additional bytes from the client.
    
    SSH channels use the windowing mechanism to perform flow control, much like TCP does. The server gives the client the initial window size, which represents the number of bytes the client can send to the server. As the server receives data, it can send a message to the client to allow it to send more data.
    
    The return value from this method is used to control this behaviour. Intuitively speaking, the callee returns the number of bytes consumed by this method, by the time this method returns. Picture a one-way long bridge (for example Golden Gate Bridge) with toll plazas on both sides. The window size is the maximum number of cars allowed on the bridge. Here we are on the receiving end, so our job here is to count the number of cars as it leaves the bridge, and if enough of them left, we'll signal the sending end that they can let in more cars. The return value of this method counts the number of cars that are leaving in this batch.
    
    In simple cases, where the callee has consumed the bytes before it returns, the return value must be the same value as the 'len' parameter given.
    
    On the other hand, if the callee is queueing up the received bytes somewhere to be consumed later (for example by another thread), then this method should return 0, for the bytes aren't really consumed yet. And when at some later point the bytes are actually used, then you'll invoke channel.getLocalWindow().consumeAndCheck(len) to let the channel know that bytes are consumed.
    
    This behaviour will result in a better flow control, as the server will not allow the SSH client to overflow its buffer. If instead you always return the value passed in the 'len' parameter, the place where you are queueing up bytes may overflow.
    
    In either case, the callee must account for every bytes it receives in this method. Returning 0 and failing to call back channel.getLocalWindow().consumeAndCheck(len) later will dry up the window size, and eventually the client will stop sending you any data.
    
    In the SSH protocol, this method invocation is triggered by a SSH_MSG_CHANNEL_DATA message.
    
    Specified by:
    
    data in interface ChannelDataReceiver
    
    Parameters:
    
    channel - The caller to which this ChannelDataReceiver is assigned. Never null.
    
    buf - Holds the bytes received. This buffer belongs to the caller, and it might get reused by the caller as soon as this method returns.
    
    start - buf[start] is the first byte that received from the client.
    
    len - the length of the bytes received. Can be zero.
    
    Returns:
    
    The number of bytes consumed, for the purpose of the flow control. For a simple use case, you return the value given by the 'len' parameter. See the method javadoc for more details.
    
    Throws:
    
    IOException - if failed to consume the data
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - close
```
public void close()
           throws IOException
```
    Description copied from interface: ChannelDataReceiver
    
    Called to indicate EOF. The client will no longer send us any more data.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface ChannelDataReceiver
    
    Throws:
    
    IOException - if failed
  - doProcess
```
protected void doProcess(Buffer buffer,
                         int length,
                         int type,
                         int id)
                  throws IOException
```
    Overrides:
    
    doProcess in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - createLink
```
protected void createLink(int id,
                          String existingPath,
                          String linkPath,
                          boolean symLink)
                   throws IOException
```
    Specified by:
    
    createLink in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doTextSeek
```
protected void doTextSeek(int id,
                          String handle,
                          long line)
                   throws IOException
```
    Specified by:
    
    doTextSeek in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doOpenSSHFsync
```
protected void doOpenSSHFsync(int id,
                              String handle)
                       throws IOException
```
    Specified by:
    
    doOpenSSHFsync in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doCheckFileHash
```
protected void doCheckFileHash(int id,
                               String targetType,
                               String target,
                               Collection<String> algos,
                               long startOffset,
                               long length,
                               int blockSize,
                               Buffer buffer)
                        throws Exception
```
    Specified by:
    
    doCheckFileHash in class AbstractSftpSubsystemHelper
    
    Throws:
    
    Exception
  - doMD5Hash
```
protected byte[] doMD5Hash(int id,
                           String targetType,
                           String target,
                           long startOffset,
                           long length,
                           byte[] quickCheckHash)
                    throws Exception
```
    Specified by:
    
    doMD5Hash in class AbstractSftpSubsystemHelper
    
    Throws:
    
    Exception
  - doVersionSelect
```
protected void doVersionSelect(Buffer buffer,
                               int id,
                               String proposed)
                        throws IOException
```
    Specified by:
    
    doVersionSelect in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doBlock
```
protected void doBlock(int id,
                       String handle,
                       long offset,
                       long length,
                       int mask)
                throws IOException
```
    Specified by:
    
    doBlock in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doUnblock
```
protected void doUnblock(int id,
                         String handle,
                         long offset,
                         long length)
                  throws IOException
```
    Specified by:
    
    doUnblock in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doCopyData
```
protected void doCopyData(int id,
                          String readHandle,
                          long readOffset,
                          long readLength,
                          String writeHandle,
                          long writeOffset)
                   throws IOException
```
    Specified by:
    
    doCopyData in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doReadDir
```
protected void doReadDir(Buffer buffer,
                         int id)
                  throws IOException
```
    Specified by:
    
    doReadDir in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doOpenDir
```
protected String doOpenDir(int id,
                           String path,
                           Path p,
                           LinkOption... options)
                    throws IOException
```
    Specified by:
    
    doOpenDir in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doFSetStat
```
protected void doFSetStat(int id,
                          String handle,
                          Map<String,?> attrs)
                   throws IOException
```
    Specified by:
    
    doFSetStat in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doFStat
```
protected Map<String,Object> doFStat(int id,
                                     String handle,
                                     int flags)
                              throws IOException
```
    Specified by:
    
    doFStat in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doWrite
```
protected void doWrite(int id,
                       String handle,
                       long offset,
                       int length,
                       byte[] data,
                       int doff,
                       int remaining)
                throws IOException
```
    Specified by:
    
    doWrite in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doRead
```
protected int doRead(int id,
                     String handle,
                     long offset,
                     int length,
                     byte[] data,
                     int doff)
              throws IOException
```
    Specified by:
    
    doRead in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doClose
```
protected void doClose(int id,
                       String handle)
                throws IOException
```
    Specified by:
    
    doClose in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - doOpen
```
protected String doOpen(int id,
                        String path,
                        int pflags,
                        int access,
                        Map<String,Object> attrs)
                 throws IOException
```
    Specified by:
    
    doOpen in class AbstractSftpSubsystemHelper
    
    Parameters:
    
    id - Request id
    
    path - Path
    
    pflags - Open mode flags - see SSH_FXF_XXX flags
    
    access - Access mode flags - see ACE4_XXX flags
    
    attrs - Requested attributes
    
    Returns:
    
    The assigned (opaque) handle
    
    Throws:
    
    IOException - if failed to execute
  - generateFileHandle
```
protected String generateFileHandle(Path file)
                             throws IOException
```
    Throws:
    
    IOException
  - doInit
```
protected void doInit(Buffer buffer,
                      int id)
               throws IOException
```
    Specified by:
    
    doInit in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - prepareReply
```
protected Buffer prepareReply(Buffer buffer)
```
    Specified by:
    
    prepareReply in class AbstractSftpSubsystemHelper
  - send
```
protected void send(Buffer buffer)
             throws IOException
```
    Specified by:
    
    send in class AbstractSftpSubsystemHelper
    
    Throws:
    
    IOException
  - destroy
```
public void destroy()
```
    Description copied from interface: CommandLifecycle
    
    This method is called by the SSH server to destroy the command because the client has disconnected somehow.
    
    Specified by:
    
    destroy in interface CommandLifecycle
  - closeAllHandles
```
protected void closeAllHandles()
```

Class SftpSubsystem

Field Summary

Fields inherited from class org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

Fields inherited from interface org.apache.sshd.server.subsystem.sftp.SftpSubsystemEnvironment

Constructor Summary

Method Summary

Methods inherited from class org.apache.sshd.server.subsystem.sftp.AbstractSftpSubsystemHelper

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

Methods inherited from class java.lang.Object

Field Detail

MAX_OPEN_HANDLES_PER_SESSION

DEFAULT_MAX_OPEN_HANDLES

FILE_HANDLE_SIZE

MIN_FILE_HANDLE_SIZE

DEFAULT_FILE_HANDLE_SIZE

MAX_FILE_HANDLE_SIZE

MAX_FILE_HANDLE_RAND_ROUNDS

MIN_FILE_HANDLE_ROUNDS

DEFAULT_FILE_HANDLE_ROUNDS

MAX_FILE_HANDLE_ROUNDS

MAX_READDIR_DATA_SIZE_PROP

DEFAULT_MAX_READDIR_DATA_SIZE

CLOSE

closed

requestsCount

extensions

handles

buffer

requests

callback

out

err

env

randomizer

fileHandleSize

maxFileHandleRounds

pendingFuture

workBuf

fileSystem

defaultDir

version

serverSession

channelSession

executorService

Constructor Detail

SftpSubsystem

Method Detail

getVersion

getDefaultDirectory

getExecutorService

setSession

getServerSession

setChannelSession

setFileSystem

setExitCallback

setInputStream

setOutputStream

setErrorStream

setIoInputStream

setIoOutputStream

setIoErrorStream

start

data

run

close

doProcess

createLink

doTextSeek

doOpenSSHFsync

doCheckFileHash

doMD5Hash

doVersionSelect

doBlock

doUnblock

doCopyData

doReadDir

doOpenDir

doFSetStat

doFStat