public final Class SftpModuleProperties

Comma separate list of SSH_ACL_CAP_xxx names - where name can be without the prefix. If not defined then AbstractSftpSubsystemHelper#DEFAULT_ACL_SUPPORTED_MASK is used

Used to control whether to append the end-of-list indicator for SSH_FXP_NAME responses via SftpHelper#indicateEndOfNamesList(Buffer, int, PropertyResolver, boolean) call, as indicated by SFTP v6 - section 9.4

See org.apache.sshd.sftp.client.fs.SftpFileSystemProvider.

Whether to automatically follow symbolic links when resolving paths

Allows controlling reports of which client extensions are supported (and reported via "support" and "support2" server extensions) as a comma-separate list of names

See Also

AbstractSftpSubsystemHelper#DEFAULT_SUPPORTED_CLIENT_EXTENSIONS

See org.apache.sshd.sftp.client.fs.SftpFileSystemProvider.

Internal allocate buffer size when copying data to/from the channel

Size in bytes of the opaque handle value

See Also

DEFAULT_FILE_HANDLE_SIZE

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

SftpSubsystem#generateFileHandle(Path), DEFAULT_FILE_HANDLE_ROUNDS

Properties key for the maximum of available open handles per session. By default we impose virtually no limit and rely on the O/S.

Force the use of a max. packet length for AbstractSftpSubsystemHelper#doRead(Buffer, int) protection against malicious packets

Maximum amount of data allocated for listing the contents of a directory in any single invocation of SftpSubsystem#doReadDir(Buffer, int)

Force the use of a max. packet length for AbstractSftpSubsystemHelper#doWrite(Buffer, int) protection against malicious packets

See org.apache.sshd.sftp.client.fs.SftpFileSystemProvider.

Used to indicate the Charset (or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.

See Also

SftpClient#getNameDecodingCharset(), SftpClient#setNameDecodingCharset(Charset)

Property that can be used to set the reported NL value. If not set, then IoUtils#EOL is used

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 AbstractSftpSubsystemHelper#DEFAULT_OPEN_SSH_EXTENSIONS are used

If >= 0, that many channels may be kept open in the channel pool of an org.apache.sshd.sftp.client.fs.SftpFileSystem even if they are idle; by default 1. If >= POOL_SIZE, channels will not expire and will be closed only then the file system is closed, or if the server closes them.

See Also

org.apache.sshd.sftp.client.fs.SftpFileSystem

A timeout after which idle channels in the pool of an org.apache.sshd.sftp.client.fs.SftpFileSystem are removed from the pool and closed; by default 10 seconds. If set to zero, channels in the pool will not expire and will be closed only then the file system is closed, or if the server closes them.

The duration should not be shorter than 1 millisecond. If it is, 1 millisecond will be assumed.

See Also

org.apache.sshd.sftp.client.fs.SftpFileSystem

The maximum size of the channel pool used by an org.apache.sshd.sftp.client.fs.SftpFileSystem; by default 8. The value must be > zero.

See Also

org.apache.sshd.sftp.client.fs.SftpFileSystem

See org.apache.sshd.sftp.client.fs.SftpFileSystemProvider.

Property that can be used on the org.apache.sshd.common.FactoryManager to control the internal timeout used by the client to open a channel.

Force the use of a given sftp version

Apparently some SFTP servers may return more data than requested in SFTP read requests. This is a violation of the SFTP protocol. If this flag is true, such excess data is ignored and a warning is logged. If the flag is false (the default), an exception is thrown. The flag can be set on an SSH session or on the client channel of an SftpClient.

See org.apache.sshd.sftp.client.fs.SftpFileSystemProvider.

Property used to avoid large buffers when org.apache.sshd.sftp.client.impl.AbstractSftpClient#write(SftpClient.Handle, long, byte[], int, int) is invoked with a large buffer size.