SftpSubsystem (Apache Mina SSHD

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

All Implemented Interfaces:: Runnable, FileSystemAware, Command, SessionAware

public class SftpSubsystem
extends AbstractLoggingBean
implements Command, Runnable, SessionAware, FileSystemAware

SFTP subsystem

Author:: Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_SFTP_IMPL`
`protected ExitCallback`	`callback`
`static String`	`CLIENT_EXTENSIONS_PROP` Allows controlling reports of which client extensions are supported (and reported via "support" and "support2" server extensions) as a comma-separate list of names.
`protected boolean`	`closed`
`static int`	`DEFAULT_FILE_HANDLE_ROUNDS`
`static int`	`DEFAULT_FILE_HANDLE_SIZE`
`static int`	`DEFAULT_MAX_OPEN_HANDLES`
`static int`	`DEFAULT_MAX_PACKET_LENGTH`
`static List<AbstractOpenSSHExtensionParser.OpenSSHExtension>`	`DEFAULT_OPEN_SSH_EXTENSIONS`
`static List<String>`	`DEFAULT_OPEN_SSH_EXTENSIONS_NAMES`
`static Set<String>`	`DEFAULT_SUPPORTED_CLIENT_EXTENSIONS` The default reported supported client extensions
`static List<String>`	`DEFAULT_UNIX_VIEW`
`protected Path`	`defaultDir`
`protected Environment`	`env`
`protected OutputStream`	`err`
`protected ExecutorService`	`executors`
`protected Map<String,byte[]>`	`extensions`
`static String`	`FILE_HANDLE_SIZE` Size in bytes of the opaque handle value
`static Map<String,FileInfoExtractor<?>>`	`FILEATTRS_RESOLVERS` A `Map` of `FileInfoExtractor`s to be used to complete attributes that are deemed important enough to warrant an extra effort if not accessible via the file system attributes views
`protected int`	`fileHandleSize`
`protected FileSystem`	`fileSystem`
`protected Map<String,Handle>`	`handles`
`static int`	`HIGHER_SFTP_IMPL`
`protected InputStream`	`in`
`static int`	`LOWER_SFTP_IMPL`
`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_PACKET_LENGTH_PROP` Force the use of a max.
`protected int`	`maxFileHandleRounds`
`static int`	`MIN_FILE_HANDLE_ROUNDS`
`static int`	`MIN_FILE_HANDLE_SIZE`
`static String`	`OPENSSH_EXTENSIONS_PROP` Comma-separated list of which `OpenSSH` extensions are reported and what version is reported for each - format: `name=version`.
`protected OutputStream`	`out`
`protected Future<?>`	`pendingFuture`
`protected Random`	`randomizer`
`protected long`	`requestsCount`
`protected ServerSession`	`session`
`static String`	`SFTP_VERSION` Force the use of a given sftp version
`protected boolean`	`shutdownExecutor`
`protected UnsupportedAttributePolicy`	`unsupportedAttributePolicy`
`protected int`	`version`
`protected byte[]`	`workBuf`

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

Constructor Summary

Constructors
Constructor and Description

SftpSubsystem(ExecutorService executorService, boolean shutdownOnExit, UnsupportedAttributePolicy policy)

Constructors
Constructor and Description
`SftpSubsystem(ExecutorService executorService, boolean shutdownOnExit, UnsupportedAttributePolicy policy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Map<String,Object>`	`addMissingAttribute(Path file, Map<String,Object> current, String name, FileInfoExtractor<?> x, LinkOption... options)`
`protected void`	`appendExtensions(Buffer buffer, String supportedVersions)`
`protected void`	`appendNewlineExtension(Buffer buffer, String value)` Appends the "newline" extension to the buffer.
`protected List<AbstractOpenSSHExtensionParser.OpenSSHExtension>`	`appendOpenSSHExtensions(Buffer buffer)`
`protected void`	`appendSupported2Extension(Buffer buffer, Collection<String> extras)` Appends the "supported2" extension to the buffer.
`protected void`	`appendSupportedExtension(Buffer buffer, Collection<String> extras)` Appends the "supported" extension to the buffer.
`protected void`	`appendVendorIdExtension(Buffer buffer, Map<String,?> versionProperties)` Appends the "vendor-id" extension to the buffer.
`protected void`	`appendVersionsExtension(Buffer buffer, String value)` Appends the "versions" extension to the buffer.
`protected String`	`checkVersionCompatibility(Buffer buffer, int id, int proposed, int failureOpcode)` Checks if a proposed version is within supported range.
`protected void`	`createLink(int id, String targetPath, String linkPath, boolean symLink)`
`void`	`destroy()` Destroy the shell.
`protected void`	`doBlock(Buffer buffer, int id)`
`protected void`	`doBlock(int id, String handle, long offset, long length, int mask)`
`protected void`	`doCheckFileHash(Buffer buffer, int id, String targetType)`
`protected void`	`doCheckFileHash(int id, Path file, NamedFactory<? extends Digest> factory, long startOffset, long length, int blockSize, Buffer buffer)`
`protected void`	`doCheckFileHash(int id, String targetType, String target, Collection<String> algos, long startOffset, long length, int blockSize, Buffer buffer)`
`protected void`	`doClose(Buffer buffer, int id)`
`protected void`	`doClose(int id, String handle)`
`protected void`	`doCopyData(Buffer buffer, int id)`
`protected void`	`doCopyData(int id, String readHandle, long readOffset, long readLength, String writeHandle, long writeOffset)`
`protected void`	`doCopyFile(Buffer buffer, int id)`
`protected void`	`doCopyFile(int id, String srcFile, String dstFile, boolean overwriteDestination)`
`protected void`	`doCopyFile(int id, String srcFile, String dstFile, Collection<CopyOption> opts)`
`protected void`	`doExtended(Buffer buffer, int id)`
`protected void`	`doFSetStat(Buffer buffer, int id)`
`protected void`	`doFSetStat(int id, String handle, Map<String,?> attrs)`
`protected void`	`doFStat(Buffer buffer, int id)`
`protected Map<String,Object>`	`doFStat(int id, String handle, int flags)`
`protected void`	`doInit(Buffer buffer, int id)`
`protected void`	`doLink(Buffer buffer, int id)`
`protected void`	`doLink(int id, String targetPath, String linkPath, boolean symLink)`
`protected void`	`doLStat(Buffer buffer, int id)`
`protected Map<String,Object>`	`doLStat(int id, String path, int flags)`
`protected void`	`doMakeDirectory(Buffer buffer, int id)`
`protected void`	`doMakeDirectory(int id, String path, Map<String,?> attrs, LinkOption... options)`
`protected void`	`doMD5Hash(Buffer buffer, int id, String targetType)`
`protected byte[]`	`doMD5Hash(int id, Path path, long startOffset, long length, byte[] quickCheckHash)`
`protected byte[]`	`doMD5Hash(int id, String targetType, String target, long startOffset, long length, byte[] quickCheckHash)`
`protected void`	`doOpen(Buffer buffer, int id)`
`protected String`	`doOpen(int id, String path, int pflags, int access, Map<String,Object> attrs)`
`protected void`	`doOpenDir(Buffer buffer, int id)`
`protected String`	`doOpenDir(int id, String path, LinkOption... options)`
`protected void`	`doOpenSSHFsync(Buffer buffer, int id)`
`protected void`	`doOpenSSHFsync(int id, String handle)`
`protected void`	`doRead(Buffer buffer, 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 int`	`doReadDir(int id, DirectoryHandle dir, Buffer buffer, int maxSize)`
`protected void`	`doReadLink(Buffer buffer, int id)`
`protected String`	`doReadLink(int id, String path)`
`protected void`	`doRealPath(Buffer buffer, int id)`
`protected Pair<Path,Boolean>`	`doRealPathV345(int id, String path, LinkOption... options)`
`protected Pair<Path,Boolean>`	`doRealPathV6(int id, String path, Collection<String> extraPaths, LinkOption... options)`
`protected void`	`doRemove(Buffer buffer, int id)`
`protected void`	`doRemove(int id, String path, LinkOption... options)`
`protected void`	`doRemoveDirectory(Buffer buffer, int id)`
`protected void`	`doRemoveDirectory(int id, String path, LinkOption... options)`
`protected void`	`doRename(Buffer buffer, int id)`
`protected void`	`doRename(int id, String oldPath, String newPath, Collection<CopyOption> opts)`
`protected void`	`doRename(int id, String oldPath, String newPath, int flags)`
`protected void`	`doSetStat(Buffer buffer, int id)`
`protected void`	`doSetStat(int id, String path, Map<String,?> attrs)`
`protected void`	`doSpaceAvailable(Buffer buffer, int id)`
`protected SpaceAvailableExtensionInfo`	`doSpaceAvailable(int id, String path)`
`protected void`	`doStat(Buffer buffer, int id)`
`protected Map<String,Object>`	`doStat(int id, String path, int flags)`
`protected void`	`doSymLink(Buffer buffer, int id)`
`protected void`	`doSymLink(int id, String targetPath, String linkPath)`
`protected void`	`doTextSeek(Buffer buffer, int id)`
`protected void`	`doTextSeek(int id, String handle, long line)`
`protected void`	`doUnblock(Buffer buffer, int id)`
`protected boolean`	`doUnblock(int id, String handle, long offset, long length)`
`protected void`	`doVersionSelect(Buffer buffer, int id)`
`protected void`	`doWrite(Buffer buffer, int id)`
`protected void`	`doWrite(int id, String handle, long offset, int length, byte[] data, int doff, int remaining)`
`protected void`	`executeExtendedCommand(Buffer buffer, int id, String extension)`
`protected String`	`generateFileHandle(Path file)`
`protected Map<String,Object>`	`getAttributes(Path file, int flags, LinkOption... options)`
`protected Map<String,Object>`	`getAttributes(Path file, LinkOption... options)`
`protected String`	`getLongName(Path f, LinkOption... options)`
`protected String`	`getShortName(Path f)`
`protected Collection<String>`	`getSupportedClientExtensions()`
`UnsupportedAttributePolicy`	`getUnsupportedAttributePolicy()`
`int`	`getVersion()`
`protected Map<String,Object>`	`handleReadFileAttributesException(Path file, String view, LinkOption[] options, IOException e)`
`protected Map<String,Object>`	`handleUnknownStatusFileAttributes(Path file, int flags, LinkOption... options)`
`protected void`	`handleUnsupportedAttributes(Collection<String> attributes)`
`protected void`	`handleUserPrincipalLookupServiceException(Class<? extends Principal> principalType, String name, IOException e)`
`protected Path`	`normalize(Path f)`
`protected void`	`process(Buffer buffer)`
`protected Map<String,Object>`	`readAttrs(Buffer buffer)`
`protected Map<String,Object>`	`readFileAttributes(Path file, String view, LinkOption... options)`
`protected Path`	`resolveFile(String remotePath)`
`protected Map<String,Object>`	`resolveFileAttributes(Path file, int flags, LinkOption... options)`
`protected Map<String,Object>`	`resolveMissingFileAttributes(Path file, int flags, Map<String,Object> current, LinkOption... options)` Called by `getAttributes(Path, int, LinkOption...)` in order to complete any attributes that could not be retrieved via the supported file system views.
`protected Object`	`resolveMissingFileAttributeValue(Path file, String name, Object value, FileInfoExtractor<?> x, LinkOption... options)`
`protected Path`	`resolveNormalizedLocation(String remotePath)`
`protected List<AbstractOpenSSHExtensionParser.OpenSSHExtension>`	`resolveOpenSSHExtensions()`
`void`	`run()`
`protected void`	`send(Buffer buffer)`
`protected void`	`sendAttrs(Buffer buffer, int id, Map<String,?> attributes)`
`protected void`	`sendHandle(Buffer buffer, int id, String handle)`
`protected void`	`sendLink(Buffer buffer, int id, String link)`
`protected void`	`sendPath(Buffer buffer, int id, Path f, Map<String,?> attrs)`
`protected void`	`sendStatus(Buffer buffer, int id, Exception e)`
`protected void`	`sendStatus(Buffer buffer, int id, int substatus, String msg)`
`protected void`	`sendStatus(Buffer buffer, int id, int substatus, String msg, String lang)`
`protected void`	`setAttributes(Path file, Map<String,?> attributes)`
`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`	`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 shell.
`protected <H extends Handle> H`	`validateHandle(String handle, Handle h, Class<H> type)`
`protected Boolean`	`validateProposedVersion(Buffer buffer, int id, String proposed)`
`protected Pair<Path,Boolean>`	`validateRealPath(int id, String path, Path f, LinkOption... options)`
`protected void`	`writeAttrs(Buffer buffer, Map<String,?> attributes)`
`protected void`	`writeDirEntry(int id, DirectoryHandle dir, Buffer buffer, int index, Path f, String shortName, LinkOption... options)`

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
- SFTP_VERSION
```
public static final String SFTP_VERSION
```
  Force the use of a given sftp version
  
  See Also:
  
  Constant Field Values
- LOWER_SFTP_IMPL
```
public static final int LOWER_SFTP_IMPL
```
  See Also:
  
  Constant Field Values
- HIGHER_SFTP_IMPL
```
public static final int HIGHER_SFTP_IMPL
```
  See Also:
  
  Constant Field Values
- ALL_SFTP_IMPL
```
public static final String ALL_SFTP_IMPL
```
- MAX_PACKET_LENGTH_PROP
```
public static final String MAX_PACKET_LENGTH_PROP
```
  Force the use of a max. packet length - especially for doReadDir(Buffer, int) and doRead(Buffer, int) methods
  
  See Also:
  
  DEFAULT_MAX_PACKET_LENGTH, Constant Field Values
- DEFAULT_MAX_PACKET_LENGTH
```
public static final int DEFAULT_MAX_PACKET_LENGTH
```
  See Also:
  
  Constant Field Values
- CLIENT_EXTENSIONS_PROP
```
public static final String CLIENT_EXTENSIONS_PROP
```
  Allows controlling reports of which client extensions are supported (and reported via "support" and "support2" server extensions) as a comma-separate list of names. Note: requires overriding the executeExtendedCommand(Buffer, int, String) command accordingly. If empty string is set then no server extensions are reported
  
  See Also:
  
  DEFAULT_SUPPORTED_CLIENT_EXTENSIONS, Constant Field Values
- DEFAULT_SUPPORTED_CLIENT_EXTENSIONS
```
public static final Set<String> DEFAULT_SUPPORTED_CLIENT_EXTENSIONS
```
  The default reported supported client extensions
- OPENSSH_EXTENSIONS_PROP
```
public static final String OPENSSH_EXTENSIONS_PROP
```
  Comma-separated list of which OpenSSH extensions are reported and what version is reported for each - format: name=version. If empty value set, then no such extensions are reported. Otherwise, the DEFAULT_OPEN_SSH_EXTENSIONS are used
  
  See Also:
  
  Constant Field Values
- DEFAULT_OPEN_SSH_EXTENSIONS
```
public static final List<AbstractOpenSSHExtensionParser.OpenSSHExtension> DEFAULT_OPEN_SSH_EXTENSIONS
```
- DEFAULT_OPEN_SSH_EXTENSIONS_NAMES
```
public static final List<String> DEFAULT_OPEN_SSH_EXTENSIONS_NAMES
```
- DEFAULT_UNIX_VIEW
```
public static final List<String> DEFAULT_UNIX_VIEW
```
- FILEATTRS_RESOLVERS
```
public static final Map<String,FileInfoExtractor<?>> FILEATTRS_RESOLVERS
```
  A Map of FileInfoExtractors to be used to complete attributes that are deemed important enough to warrant an extra effort if not accessible via the file system attributes views
- callback
```
protected ExitCallback callback
```
- in
```
protected InputStream in
```
- out
```
protected OutputStream out
```
- err
```
protected OutputStream err
```
- env
```
protected Environment env
```
- randomizer
```
protected Random randomizer
```
- fileHandleSize
```
protected int fileHandleSize
```
- maxFileHandleRounds
```
protected int maxFileHandleRounds
```
- session
```
protected ServerSession session
```
- closed
```
protected boolean closed
```
- executors
```
protected ExecutorService executors
```
- shutdownExecutor
```
protected boolean shutdownExecutor
```
- pendingFuture
```
protected Future<?> pendingFuture
```
- workBuf
```
protected byte[] workBuf
```
- fileSystem
```
protected FileSystem fileSystem
```
- defaultDir
```
protected Path defaultDir
```
- requestsCount
```
protected long requestsCount
```
- version
```
protected int version
```
- extensions
```
protected final Map<String,byte[]> extensions
```
- handles
```
protected final Map<String,Handle> handles
```
- unsupportedAttributePolicy
```
protected final UnsupportedAttributePolicy unsupportedAttributePolicy
```

Constructor Detail
- SftpSubsystem
```
public SftpSubsystem(ExecutorService executorService,
                     boolean shutdownOnExit,
                     UnsupportedAttributePolicy policy)
```
  Parameters:
  
  executorService - The ExecutorService to be used by the SftpSubsystem command when starting execution. If null then a single-threaded ad-hoc service is used.
  
  shutdownOnExit - If true the ExecutorService.shutdownNow() will be called when subsystem terminates - unless it is the ad-hoc service, which will be shutdown regardless
  
  policy - The UnsupportedAttributePolicy to use if failed to access some local file attributes
  
  See Also:
  
  ThreadUtils.newSingleThreadExecutor(String)

Method Detail

getVersion
```
public int getVersion()
```

getUnsupportedAttributePolicy

public final UnsupportedAttributePolicy getUnsupportedAttributePolicy()

setSession
```
public void setSession(ServerSession session)
```
Specified by:

setSession in interface SessionAware

Parameters:

session - The ServerSession in which this shell will be executed.

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

start
```
public void start(Environment env)
           throws IOException
```
Description copied from interface: Command
Starts the shell. 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 Command

Parameters:

env - The Environment

Throws:

IOException - If failed to start

run
```
public void run()
```
Specified by:

run in interface Runnable

process

protected void process(Buffer buffer)
                throws IOException

Throws:: IOException

doExtended

protected void doExtended(Buffer buffer,
                          int id)
                   throws IOException

Throws:: IOException

executeExtendedCommand

protected void executeExtendedCommand(Buffer buffer,
                                      int id,
                                      String extension)
                               throws IOException

Parameters:: buffer - The command Buffer; id - The request id; extension - The extension name
Throws:: IOException - If failed to execute the extension

doSpaceAvailable

protected void doSpaceAvailable(Buffer buffer,
                                int id)
                         throws IOException

Throws:: IOException

doSpaceAvailable

protected SpaceAvailableExtensionInfo doSpaceAvailable(int id,
                                                       String path)
                                                throws IOException

Throws:: IOException

doTextSeek

protected void doTextSeek(Buffer buffer,
                          int id)
                   throws IOException

Throws:: IOException

doTextSeek

protected void doTextSeek(int id,
                          String handle,
                          long line)
                   throws IOException

Throws:: IOException

doOpenSSHFsync

protected void doOpenSSHFsync(Buffer buffer,
                              int id)
                       throws IOException

Throws:: IOException

doOpenSSHFsync

protected void doOpenSSHFsync(int id,
                              String handle)
                       throws IOException

Throws:: IOException

doCheckFileHash

protected void doCheckFileHash(Buffer buffer,
                               int id,
                               String targetType)
                        throws IOException

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

Throws:: Exception

doCheckFileHash

protected void doCheckFileHash(int id,
                               Path file,
                               NamedFactory<? extends Digest> factory,
                               long startOffset,
                               long length,
                               int blockSize,
                               Buffer buffer)
                        throws Exception

Throws:: Exception

doMD5Hash

protected void doMD5Hash(Buffer buffer,
                         int id,
                         String targetType)
                  throws IOException

Throws:: IOException

doMD5Hash

protected byte[] doMD5Hash(int id,
                           String targetType,
                           String target,
                           long startOffset,
                           long length,
                           byte[] quickCheckHash)
                    throws Exception

Throws:: Exception

doMD5Hash

protected byte[] doMD5Hash(int id,
                           Path path,
                           long startOffset,
                           long length,
                           byte[] quickCheckHash)
                    throws Exception

Throws:: Exception

doVersionSelect

protected void doVersionSelect(Buffer buffer,
                               int id)
                        throws IOException

Throws:: IOException

validateProposedVersion
```
protected Boolean validateProposedVersion(Buffer buffer,
                                          int id,
                                          String proposed)
                                   throws IOException
```
Parameters:

buffer - The Buffer holding the request

id - The request id

proposed - The proposed value

Returns:

A Boolean indicating whether to accept/reject the proposal. If null then rejection response has been sent, otherwise and appropriate response is generated

Throws:

IOException - If failed send an independent rejection response

checkVersionCompatibility
```
protected String checkVersionCompatibility(Buffer buffer,
                                           int id,
                                           int proposed,
                                           int failureOpcode)
                                    throws IOException
```
Checks if a proposed version is within supported range. Note: if the user forced a specific value via the SFTP_VERSION property, then it is used to validate the proposed value

Parameters:

buffer - The Buffer containing the request

id - The SSH message ID to be used to send the failure message if required

proposed - The proposed version value

failureOpcode - The failure opcode to send if validation fails

Returns:

A String of comma separated values representing all the supported version - null if validation failed and an appropriate status message was sent

Throws:

IOException - If failed to send the failure status message

doBlock

protected void doBlock(Buffer buffer,
                       int id)
                throws IOException

Throws:: IOException

doBlock

protected void doBlock(int id,
                       String handle,
                       long offset,
                       long length,
                       int mask)
                throws IOException

Throws:: IOException

doUnblock

protected void doUnblock(Buffer buffer,
                         int id)
                  throws IOException

Throws:: IOException

doUnblock

protected boolean doUnblock(int id,
                            String handle,
                            long offset,
                            long length)
                     throws IOException

Throws:: IOException

doLink

protected void doLink(Buffer buffer,
                      int id)
               throws IOException

Throws:: IOException

doLink

protected void doLink(int id,
                      String targetPath,
                      String linkPath,
                      boolean symLink)
               throws IOException

Throws:: IOException

doSymLink

protected void doSymLink(Buffer buffer,
                         int id)
                  throws IOException

Throws:: IOException

doSymLink

protected void doSymLink(int id,
                         String targetPath,
                         String linkPath)
                  throws IOException

Throws:: IOException

createLink

protected void createLink(int id,
                          String targetPath,
                          String linkPath,
                          boolean symLink)
                   throws IOException

Throws:: IOException

doReadLink

protected void doReadLink(Buffer buffer,
                          int id)
                   throws IOException

Throws:: IOException

doReadLink

protected String doReadLink(int id,
                            String path)
                     throws IOException

Throws:: IOException

doRename

protected void doRename(Buffer buffer,
                        int id)
                 throws IOException

Throws:: IOException

doRename

protected void doRename(int id,
                        String oldPath,
                        String newPath,
                        int flags)
                 throws IOException

Throws:: IOException

doRename

protected void doRename(int id,
                        String oldPath,
                        String newPath,
                        Collection<CopyOption> opts)
                 throws IOException

Throws:: IOException

doCopyData

protected void doCopyData(Buffer buffer,
                          int id)
                   throws IOException

Throws:: IOException

doCopyData

protected void doCopyData(int id,
                          String readHandle,
                          long readOffset,
                          long readLength,
                          String writeHandle,
                          long writeOffset)
                   throws IOException

Throws:: IOException

doCopyFile

protected void doCopyFile(Buffer buffer,
                          int id)
                   throws IOException

Throws:: IOException

doCopyFile

protected void doCopyFile(int id,
                          String srcFile,
                          String dstFile,
                          boolean overwriteDestination)
                   throws IOException

Throws:: IOException

doCopyFile

protected void doCopyFile(int id,
                          String srcFile,
                          String dstFile,
                          Collection<CopyOption> opts)
                   throws IOException

Throws:: IOException

doStat

protected void doStat(Buffer buffer,
                      int id)
               throws IOException

Throws:: IOException

doStat

protected Map<String,Object> doStat(int id,
                                    String path,
                                    int flags)
                             throws IOException

Throws:: IOException

doRealPath

protected void doRealPath(Buffer buffer,
                          int id)
                   throws IOException

Throws:: IOException

doRealPathV6

protected Pair<Path,Boolean> doRealPathV6(int id,
                                          String path,
                                          Collection<String> extraPaths,
                                          LinkOption... options)
                                   throws IOException

Throws:: IOException

doRealPathV345

protected Pair<Path,Boolean> doRealPathV345(int id,
                                            String path,
                                            LinkOption... options)
                                     throws IOException

Throws:: IOException

validateRealPath

protected Pair<Path,Boolean> validateRealPath(int id,
                                              String path,
                                              Path f,
                                              LinkOption... options)
                                       throws IOException

Parameters:: id - The request identifier; path - The original path; f - The resolve Path; options - The LinkOptions to use to verify file existence and access
Returns:: A Pair whose left-hand is the absolute normalized Path and right-hand is a Boolean indicating its status
Throws:: IOException - If failed to validate the file
See Also:: IoUtils.checkFileExists(Path, LinkOption...)

doRemoveDirectory

protected void doRemoveDirectory(Buffer buffer,
                                 int id)
                          throws IOException

Throws:: IOException

doRemoveDirectory

protected void doRemoveDirectory(int id,
                                 String path,
                                 LinkOption... options)
                          throws IOException

Throws:: IOException

doMakeDirectory

protected void doMakeDirectory(Buffer buffer,
                               int id)
                        throws IOException

Throws:: IOException

doMakeDirectory

protected void doMakeDirectory(int id,
                               String path,
                               Map<String,?> attrs,
                               LinkOption... options)
                        throws IOException

Throws:: IOException

doRemove

protected void doRemove(Buffer buffer,
                        int id)
                 throws IOException

Throws:: IOException

doRemove

protected void doRemove(int id,
                        String path,
                        LinkOption... options)
                 throws IOException

Throws:: IOException

doReadDir

protected void doReadDir(Buffer buffer,
                         int id)
                  throws IOException

Throws:: IOException

doOpenDir

protected void doOpenDir(Buffer buffer,
                         int id)
                  throws IOException

Throws:: IOException

doOpenDir

protected String doOpenDir(int id,
                           String path,
                           LinkOption... options)
                    throws IOException

Throws:: IOException

doFSetStat

protected void doFSetStat(Buffer buffer,
                          int id)
                   throws IOException

Throws:: IOException

doFSetStat

protected void doFSetStat(int id,
                          String handle,
                          Map<String,?> attrs)
                   throws IOException

Throws:: IOException

doSetStat

protected void doSetStat(Buffer buffer,
                         int id)
                  throws IOException

Throws:: IOException

doSetStat

protected void doSetStat(int id,
                         String path,
                         Map<String,?> attrs)
                  throws IOException

Throws:: IOException

doFStat

protected void doFStat(Buffer buffer,
                       int id)
                throws IOException

Throws:: IOException

doFStat

protected Map<String,Object> doFStat(int id,
                                     String handle,
                                     int flags)
                              throws IOException

Throws:: IOException

doLStat

protected void doLStat(Buffer buffer,
                       int id)
                throws IOException

Throws:: IOException

doLStat

protected Map<String,Object> doLStat(int id,
                                     String path,
                                     int flags)
                              throws IOException

Throws:: IOException

doWrite

protected void doWrite(Buffer buffer,
                       int id)
                throws IOException

Throws:: IOException

doWrite

protected void doWrite(int id,
                       String handle,
                       long offset,
                       int length,
                       byte[] data,
                       int doff,
                       int remaining)
                throws IOException

Throws:: IOException

doRead

protected void doRead(Buffer buffer,
                      int id)
               throws IOException

Throws:: IOException

doRead

protected int doRead(int id,
                     String handle,
                     long offset,
                     int length,
                     byte[] data,
                     int doff)
              throws IOException

Throws:: IOException

doClose

protected void doClose(Buffer buffer,
                       int id)
                throws IOException

Throws:: IOException

doClose

protected void doClose(int id,
                       String handle)
                throws IOException

Throws:: IOException

doOpen

protected void doOpen(Buffer buffer,
                      int id)
               throws IOException

Throws:: IOException

doOpen

protected String doOpen(int id,
                        String path,
                        int pflags,
                        int access,
                        Map<String,Object> attrs)
                 throws IOException

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)

doInit

protected void doInit(Buffer buffer,
                      int id)
               throws IOException

Throws:: IOException

appendExtensions

protected void appendExtensions(Buffer buffer,
                                String supportedVersions)

appendOpenSSHExtensions

protected List<AbstractOpenSSHExtensionParser.OpenSSHExtension> appendOpenSSHExtensions(Buffer buffer)

resolveOpenSSHExtensions

protected List<AbstractOpenSSHExtensionParser.OpenSSHExtension> resolveOpenSSHExtensions()

getSupportedClientExtensions

protected Collection<String> getSupportedClientExtensions()

appendVersionsExtension
```
protected void appendVersionsExtension(Buffer buffer,
                                       String value)
```
Appends the "versions" extension to the buffer. Note: if overriding this method make sure you either do not append anything or use the correct extension name

Parameters:

buffer - The Buffer to append to

value - The recommended value

See Also:

SftpConstants.EXT_VERSIONS

appendNewlineExtension
```
protected void appendNewlineExtension(Buffer buffer,
                                      String value)
```
Appends the "newline" extension to the buffer. Note: if overriding this method make sure you either do not append anything or use the correct extension name

Parameters:

buffer - The Buffer to append to

value - The recommended value

See Also:

SftpConstants.EXT_NEWLINE

appendVendorIdExtension
```
protected void appendVendorIdExtension(Buffer buffer,
                                       Map<String,?> versionProperties)
```
Appends the "vendor-id" extension to the buffer. Note: if overriding this method make sure you either do not append anything or use the correct extension name

Parameters:

buffer - The Buffer to append to

versionProperties - The currently available version properties

See Also:

SftpConstants.EXT_VENDOR_ID, DRAFT 09 - section 4.4

appendSupportedExtension
```
protected void appendSupportedExtension(Buffer buffer,
                                        Collection<String> extras)
```
Appends the "supported" extension to the buffer. Note: if overriding this method make sure you either do not append anything or use the correct extension name

Parameters:

buffer - The Buffer to append to

extras - The extra extensions that are available and can be reported - may be null/empty

appendSupported2Extension
```
protected void appendSupported2Extension(Buffer buffer,
                                         Collection<String> extras)
```
Appends the "supported2" extension to the buffer. Note: if overriding this method make sure you either do not append anything or use the correct extension name

Parameters:

buffer - The Buffer to append to

extras - The extra extensions that are available and can be reported - may be null/empty

See Also:

SftpConstants.EXT_SUPPORTED, DRAFT 13 section 5.4

sendHandle

protected void sendHandle(Buffer buffer,
                          int id,
                          String handle)
                   throws IOException

Throws:: IOException

sendAttrs

protected void sendAttrs(Buffer buffer,
                         int id,
                         Map<String,?> attributes)
                  throws IOException

Throws:: IOException

sendPath

protected void sendPath(Buffer buffer,
                        int id,
                        Path f,
                        Map<String,?> attrs)
                 throws IOException

Throws:: IOException

sendLink

protected void sendLink(Buffer buffer,
                        int id,
                        String link)
                 throws IOException

Throws:: IOException

doReadDir

protected int doReadDir(int id,
                        DirectoryHandle dir,
                        Buffer buffer,
                        int maxSize)
                 throws IOException

Parameters:: id - Request id; dir - The DirectoryHandle; buffer - The Buffer to write the results; maxSize - Max. buffer size
Returns:: Number of written entries
Throws:: IOException - If failed to generate an entry

writeDirEntry

protected void writeDirEntry(int id,
                             DirectoryHandle dir,
                             Buffer buffer,
                             int index,
                             Path f,
                             String shortName,
                             LinkOption... options)
                      throws IOException

Parameters:: id - Request id; dir - The DirectoryHandle; buffer - The Buffer to write the results; index - Zero-based index of the entry to be written; f - The entry Path; shortName - The entry short name; options - The LinkOptions to use for querying the entry-s attributes
Throws:: IOException - If failed to generate the entry data

getLongName

protected String getLongName(Path f,
                             LinkOption... options)
                      throws IOException

Throws:: IOException

getShortName

protected String getShortName(Path f)
                       throws IOException

Throws:: IOException

resolveFileAttributes

protected Map<String,Object> resolveFileAttributes(Path file,
                                                   int flags,
                                                   LinkOption... options)
                                            throws IOException

Throws:: IOException

writeAttrs

protected void writeAttrs(Buffer buffer,
                          Map<String,?> attributes)
                   throws IOException

Throws:: IOException

getAttributes

protected Map<String,Object> getAttributes(Path file,
                                           LinkOption... options)
                                    throws IOException

Throws:: IOException

handleUnknownStatusFileAttributes

protected Map<String,Object> handleUnknownStatusFileAttributes(Path file,
                                                               int flags,
                                                               LinkOption... options)
                                                        throws IOException

Throws:: IOException

getAttributes
```
protected Map<String,Object> getAttributes(Path file,
                                           int flags,
                                           LinkOption... options)
                                    throws IOException
```
Parameters:

file - The Path location for the required attributes

flags - A mask of the original required attributes - ignored by the default implementation

options - The LinkOptions to use in order to access the file if necessary

Returns:

A Map of the retrieved attributes

Throws:

IOException - If failed to access the file

See Also:

resolveMissingFileAttributes(Path, int, Map, LinkOption...)

resolveMissingFileAttributes
```
protected Map<String,Object> resolveMissingFileAttributes(Path file,
                                                          int flags,
                                                          Map<String,Object> current,
                                                          LinkOption... options)
                                                   throws IOException
```
Called by getAttributes(Path, int, LinkOption...) in order to complete any attributes that could not be retrieved via the supported file system views. These attributes are deemed important so an extra effort is made to provide a value for them

Parameters:

file - The Path location for the required attributes

flags - A mask of the original required attributes - ignored by the default implementation

current - The Map of attributes already retrieved - may be null/empty and/or unmodifiable

options - The LinkOptions to use in order to access the file if necessary

Returns:

A Map of the extra attributes whose values need to be updated in the original map. Note: it is allowed to specify values which override existing ones - the default implementation does not override values that have a non-null value

Throws:

IOException - If failed to access the attributes - in which case an error is returned to the SFTP client

See Also:

FILEATTRS_RESOLVERS

resolveMissingFileAttributeValue

protected Object resolveMissingFileAttributeValue(Path file,
                                                  String name,
                                                  Object value,
                                                  FileInfoExtractor<?> x,
                                                  LinkOption... options)
                                           throws IOException

Throws:: IOException

addMissingAttribute

protected Map<String,Object> addMissingAttribute(Path file,
                                                 Map<String,Object> current,
                                                 String name,
                                                 FileInfoExtractor<?> x,
                                                 LinkOption... options)
                                          throws IOException

Throws:: IOException

readFileAttributes

protected Map<String,Object> readFileAttributes(Path file,
                                                String view,
                                                LinkOption... options)
                                         throws IOException

Throws:: IOException

handleReadFileAttributesException

protected Map<String,Object> handleReadFileAttributesException(Path file,
                                                               String view,
                                                               LinkOption[] options,
                                                               IOException e)
                                                        throws IOException

Throws:: IOException

setAttributes

protected void setAttributes(Path file,
                             Map<String,?> attributes)
                      throws IOException

Throws:: IOException

handleUnsupportedAttributes

protected void handleUnsupportedAttributes(Collection<String> attributes)

handleUserPrincipalLookupServiceException

protected void handleUserPrincipalLookupServiceException(Class<? extends Principal> principalType,
                                                         String name,
                                                         IOException e)
                                                  throws IOException

Throws:: IOException

readAttrs

protected Map<String,Object> readAttrs(Buffer buffer)
                                throws IOException

Throws:: IOException

validateHandle

protected <H extends Handle> H validateHandle(String handle,
                                              Handle h,
                                              Class<H> type)
                                       throws IOException

Type Parameters:: H - The generic handle type
Parameters:: handle - The original handle id; h - The resolved Handle instance; type - The expected handle type
Returns:: The cast type
Throws:: FileNotFoundException - If the handle instance is null; InvalidHandleException - If the handle instance is not of the expected type; IOException

sendStatus

protected void sendStatus(Buffer buffer,
                          int id,
                          Exception e)
                   throws IOException

Throws:: IOException

sendStatus

protected void sendStatus(Buffer buffer,
                          int id,
                          int substatus,
                          String msg)
                   throws IOException

Throws:: IOException

sendStatus

protected void sendStatus(Buffer buffer,
                          int id,
                          int substatus,
                          String msg,
                          String lang)
                   throws IOException

Throws:: IOException

send

protected void send(Buffer buffer)
             throws IOException

Throws:: IOException

destroy
```
public void destroy()
```
Description copied from interface: Command

Destroy the shell. This method can be called by the SSH server to destroy the shell because the client has disconnected somehow.

Specified by:

destroy in interface Command

resolveNormalizedLocation

protected Path resolveNormalizedLocation(String remotePath)
                                  throws IOException,
                                         InvalidPathException

Throws:: IOException; InvalidPathException

normalize
```
protected Path normalize(Path f)
```

resolveFile
```
protected Path resolveFile(String remotePath)
                    throws IOException,
                           InvalidPathException
```
Parameters:

remotePath - The remote path - separated by '/'

Returns:

The local Path

Throws:

IOException - If failed to resolve the local path

InvalidPathException - If bad local path specification

Class SftpSubsystem

Field Summary

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

Constructor Summary

Method Summary

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

SFTP_VERSION

LOWER_SFTP_IMPL

HIGHER_SFTP_IMPL

ALL_SFTP_IMPL

MAX_PACKET_LENGTH_PROP

DEFAULT_MAX_PACKET_LENGTH

CLIENT_EXTENSIONS_PROP

DEFAULT_SUPPORTED_CLIENT_EXTENSIONS

OPENSSH_EXTENSIONS_PROP

DEFAULT_OPEN_SSH_EXTENSIONS

DEFAULT_OPEN_SSH_EXTENSIONS_NAMES

DEFAULT_UNIX_VIEW

FILEATTRS_RESOLVERS

callback

in

out

err

env

randomizer

fileHandleSize

maxFileHandleRounds

session

closed

executors

shutdownExecutor

pendingFuture

workBuf

fileSystem

defaultDir

requestsCount

version

extensions

handles

unsupportedAttributePolicy

Constructor Detail

SftpSubsystem

Method Detail

getVersion

getUnsupportedAttributePolicy

setSession

setFileSystem

setExitCallback

setInputStream

setOutputStream

setErrorStream

start

run

process

doExtended

executeExtendedCommand

doSpaceAvailable

doSpaceAvailable

doTextSeek

doTextSeek

doOpenSSHFsync

doOpenSSHFsync

doCheckFileHash

doCheckFileHash

doCheckFileHash

doMD5Hash

doMD5Hash

doMD5Hash

doVersionSelect