SftpModuleProperties (Apache Mina SSHD

java.lang.Object
- org.apache.sshd.sftp.SftpModuleProperties

```
public final class SftpModuleProperties
extends Object
```
Configurable properties for sshd-sftp.

Author:

Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type	Field and Description
`static Property<String>`	`ACL_SUPPORTED_MASK` Comma separate list of `SSH_ACL_CAP_xxx` names - where name can be without the prefix.
`static Property<Boolean>`	`APPEND_END_OF_LIST_INDICATOR` 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
`static Property<Duration>`	`AUTH_TIME` See `SftpFileSystemProvider`.
`static Property<Boolean>`	`AUTO_FOLLOW_LINKS` Whether to automatically follow symbolic links when resolving paths
`static Property<String>`	`CLIENT_EXTENSIONS` Allows controlling reports of which client extensions are supported (and reported via "support" and "support2" server extensions) as a comma-separate list of names.
`static Property<Duration>`	`CONNECT_TIME` See `SftpFileSystemProvider`.
`static Property<Integer>`	`COPY_BUF_SIZE` Internal allocate buffer size when copying data to/from the channel
`static int`	`DEFAULT_FILE_HANDLE_ROUNDS`
`static int`	`DEFAULT_FILE_HANDLE_SIZE`
`static Property<Integer>`	`FILE_HANDLE_SIZE` Size in bytes of the opaque handle value
`static Property<Integer>`	`MAX_FILE_HANDLE_RAND_ROUNDS` Max.
`static int`	`MAX_FILE_HANDLE_ROUNDS`
`static int`	`MAX_FILE_HANDLE_SIZE`
`static Property<Integer>`	`MAX_OPEN_HANDLES_PER_SESSION` Properties key for the maximum of available open handles per session.
`static Property<Integer>`	`MAX_READDATA_PACKET_LENGTH` Force the use of a max.
`static Property<Integer>`	`MAX_READDIR_DATA_SIZE` Maximum amount of data allocated for listing the contents of a directory in any single invocation of `SftpSubsystem.doReadDir(Buffer, int)`
`static Property<Integer>`	`MAX_WRITEDATA_PACKET_LENGTH` Force the use of a max.
`static int`	`MIN_FILE_HANDLE_ROUNDS`
`static int`	`MIN_FILE_HANDLE_SIZE`
`static int`	`MIN_READDATA_PACKET_LENGTH`
`static int`	`MIN_WRITEDATA_PACKET_LENGTH`
`static Property<Charset>`	`NAME_DECODER_CHARSET` See `SftpFileSystemProvider`.
`static Property<Charset>`	`NAME_DECODING_CHARSET` Used to indicate the `Charset` (or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.
`static Property<String>`	`NEWLINE_VALUE` Property that can be used to set the reported NL value.
`static Property<String>`	`OPENSSH_EXTENSIONS` Comma-separated list of which `OpenSSH` extensions are reported and what version is reported for each - format: `name=version`.
`static Property<Integer>`	`POOL_CORE_SIZE` If >= 0, that many channels may be kept open in the channel pool of an `SftpFileSystem` even if they are idle; by default 1.
`static Property<Duration>`	`POOL_LIFE_TIME` A timeout after which idle channels in the pool of an `SftpFileSystem` are removed from the pool and closed; by default 10 seconds.
`static Property<Integer>`	`POOL_SIZE` The maximum size of the channel pool used by an `SftpFileSystem`; by default 8.
`static Property<Integer>`	`READ_BUFFER_SIZE` See `SftpFileSystemProvider`.
`static Property<Duration>`	`SFTP_CHANNEL_OPEN_TIMEOUT` Property that can be used on the `FactoryManager` to control the internal timeout used by the client to open a channel.
`static Property<Integer>`	`SFTP_VERSION` Force the use of a given sftp version
`static Property<Boolean>`	`TOLERATE_EXCESS_DATA` Apparently some SFTP servers may return more data than requested in SFTP read requests.
`static Property<Integer>`	`WRITE_BUFFER_SIZE` See `SftpFileSystemProvider`.
`static Property<Integer>`	`WRITE_CHUNK_SIZE` Property used to avoid large buffers when `AbstractSftpClient.write(SftpClient.Handle, long, byte[], int, int)` is invoked with a large buffer size.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME_DECODING_CHARSET
```
public static final Property<Charset> NAME_DECODING_CHARSET
```
    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)
  - SFTP_CHANNEL_OPEN_TIMEOUT
```
public static final Property<Duration> SFTP_CHANNEL_OPEN_TIMEOUT
```
    Property that can be used on the FactoryManager to control the internal timeout used by the client to open a channel.
  - POOL_SIZE
```
public static final Property<Integer> POOL_SIZE
```
    The maximum size of the channel pool used by an SftpFileSystem; by default 8. The value must be > zero.
    
    See Also:
    
    SftpFileSystem
  - POOL_LIFE_TIME
```
public static final Property<Duration> POOL_LIFE_TIME
```
    A timeout after which idle channels in the pool of an 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:
    
    SftpFileSystem
  - POOL_CORE_SIZE
```
public static final Property<Integer> POOL_CORE_SIZE
```
    If >= 0, that many channels may be kept open in the channel pool of an 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:
    
    SftpFileSystem
  - READ_BUFFER_SIZE
```
public static final Property<Integer> READ_BUFFER_SIZE
```
    See SftpFileSystemProvider.
  - WRITE_BUFFER_SIZE
```
public static final Property<Integer> WRITE_BUFFER_SIZE
```
    See SftpFileSystemProvider.
  - CONNECT_TIME
```
public static final Property<Duration> CONNECT_TIME
```
    See SftpFileSystemProvider.
  - AUTH_TIME
```
public static final Property<Duration> AUTH_TIME
```
    See SftpFileSystemProvider.
  - NAME_DECODER_CHARSET
```
public static final Property<Charset> NAME_DECODER_CHARSET
```
    See SftpFileSystemProvider.
  - WRITE_CHUNK_SIZE
```
public static final Property<Integer> WRITE_CHUNK_SIZE
```
    Property used to avoid large buffers when AbstractSftpClient.write(SftpClient.Handle, long, byte[], int, int) is invoked with a large buffer size.
  - COPY_BUF_SIZE
```
public static final Property<Integer> COPY_BUF_SIZE
```
    Internal allocate buffer size when copying data to/from the channel
  - APPEND_END_OF_LIST_INDICATOR
```
public static final Property<Boolean> APPEND_END_OF_LIST_INDICATOR
```
    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
  - AUTO_FOLLOW_LINKS
```
public static final Property<Boolean> AUTO_FOLLOW_LINKS
```
    Whether to automatically follow symbolic links when resolving paths
  - CLIENT_EXTENSIONS
```
public static final Property<String> CLIENT_EXTENSIONS
```
    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 AbstractSftpSubsystemHelper.executeExtendedCommand(Buffer, int, String) command accordingly. If empty string is set then no server extensions are reported
    
    See Also:
    
    AbstractSftpSubsystemHelper.DEFAULT_SUPPORTED_CLIENT_EXTENSIONS
  - OPENSSH_EXTENSIONS
```
public static final Property<String> OPENSSH_EXTENSIONS
```
    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
  - ACL_SUPPORTED_MASK
```
public static final Property<String> ACL_SUPPORTED_MASK
```
    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
  - NEWLINE_VALUE
```
public static final Property<String> NEWLINE_VALUE
```
    Property that can be used to set the reported NL value. If not set, then IoUtils.EOL is used
  - MIN_READDATA_PACKET_LENGTH
```
public static final int MIN_READDATA_PACKET_LENGTH
```
    See Also:
    
    Constant Field Values
  - MAX_READDATA_PACKET_LENGTH
```
public static final Property<Integer> MAX_READDATA_PACKET_LENGTH
```
    Force the use of a max. packet length for AbstractSftpSubsystemHelper.doRead(Buffer, int) protection against malicious packets
  - MIN_WRITEDATA_PACKET_LENGTH
```
public static final int MIN_WRITEDATA_PACKET_LENGTH
```
    See Also:
    
    Constant Field Values
  - MAX_WRITEDATA_PACKET_LENGTH
```
public static final Property<Integer> MAX_WRITEDATA_PACKET_LENGTH
```
    Force the use of a max. packet length for AbstractSftpSubsystemHelper.doWrite(Buffer, int) protection against malicious packets
  - MAX_OPEN_HANDLES_PER_SESSION
```
public static final Property<Integer> MAX_OPEN_HANDLES_PER_SESSION
```
    Properties key for the maximum of available open handles per session. By default we impose virtually no limit and rely on the O/S.
  - 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
  - FILE_HANDLE_SIZE
```
public static final Property<Integer> FILE_HANDLE_SIZE
```
    Size in bytes of the opaque handle value
    
    See Also:
    
    DEFAULT_FILE_HANDLE_SIZE
  - 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_FILE_HANDLE_RAND_ROUNDS
```
public static final Property<Integer> 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:
    
    SftpSubsystem.generateFileHandle(Path), DEFAULT_FILE_HANDLE_ROUNDS
  - MAX_READDIR_DATA_SIZE
```
public static final Property<Integer> MAX_READDIR_DATA_SIZE
```
    Maximum amount of data allocated for listing the contents of a directory in any single invocation of SftpSubsystem.doReadDir(Buffer, int)
  - TOLERATE_EXCESS_DATA
```
public static final Property<Boolean> TOLERATE_EXCESS_DATA
```
    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.
  - SFTP_VERSION
```
public static final Property<Integer> SFTP_VERSION
```
    Force the use of a given sftp version

Class SftpModuleProperties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_DECODING_CHARSET

SFTP_CHANNEL_OPEN_TIMEOUT

POOL_SIZE

POOL_LIFE_TIME

POOL_CORE_SIZE

READ_BUFFER_SIZE

WRITE_BUFFER_SIZE

CONNECT_TIME

AUTH_TIME

NAME_DECODER_CHARSET

WRITE_CHUNK_SIZE

COPY_BUF_SIZE

APPEND_END_OF_LIST_INDICATOR

AUTO_FOLLOW_LINKS

CLIENT_EXTENSIONS

OPENSSH_EXTENSIONS

ACL_SUPPORTED_MASK

NEWLINE_VALUE

MIN_READDATA_PACKET_LENGTH

MAX_READDATA_PACKET_LENGTH

MIN_WRITEDATA_PACKET_LENGTH

MAX_WRITEDATA_PACKET_LENGTH

MAX_OPEN_HANDLES_PER_SESSION

MIN_FILE_HANDLE_SIZE

DEFAULT_FILE_HANDLE_SIZE

MAX_FILE_HANDLE_SIZE

FILE_HANDLE_SIZE

MIN_FILE_HANDLE_ROUNDS

DEFAULT_FILE_HANDLE_ROUNDS

MAX_FILE_HANDLE_ROUNDS

MAX_FILE_HANDLE_RAND_ROUNDS

MAX_READDIR_DATA_SIZE

TOLERATE_EXCESS_DATA

SFTP_VERSION