Package org.apache.sshd.sftp

Class SftpModuleProperties

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 Details

    • NAME_DECODING_CHARSET

      public static final org.apache.sshd.common.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:

    • SFTP_CHANNEL_OPEN_TIMEOUT

      public static final org.apache.sshd.common.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

      @Deprecated public static final org.apache.sshd.common.Property<Integer> POOL_SIZE
      Deprecated.
      since 2.17.0 this has no effect since there is no pool anymore
      The maximum size of the channel pool used by an SftpFileSystem; by default 8. The value must be > zero.
      See Also:

    • POOL_LIFE_TIME

      @Deprecated public static final org.apache.sshd.common.Property<Duration> POOL_LIFE_TIME
      Deprecated.
      since 2.17.0 this has no effect since there is no pool anymore
      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:

    • POOL_CORE_SIZE

      @Deprecated public static final org.apache.sshd.common.Property<Integer> POOL_CORE_SIZE
      Deprecated.
      since 2.17.0 this has no effect since there is no pool anymore
      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:

    • READ_BUFFER_SIZE

      public static final org.apache.sshd.common.Property<Integer> READ_BUFFER_SIZE
      See SftpFileSystemProvider.

    • WRITE_BUFFER_SIZE

      public static final org.apache.sshd.common.Property<Integer> WRITE_BUFFER_SIZE
      See SftpFileSystemProvider.

    • CONNECT_TIME

      public static final org.apache.sshd.common.Property<Duration> CONNECT_TIME
      See SftpFileSystemProvider.

    • AUTH_TIME

      public static final org.apache.sshd.common.Property<Duration> AUTH_TIME
      See SftpFileSystemProvider.

    • NAME_DECODER_CHARSET

      public static final org.apache.sshd.common.Property<Charset> NAME_DECODER_CHARSET
      See SftpFileSystemProvider.

    • WRITE_CHUNK_SIZE

      public static final org.apache.sshd.common.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 org.apache.sshd.common.Property<Integer> COPY_BUF_SIZE
      Internal allocate buffer size when copying data to/from the channel

    • APPEND_END_OF_LIST_INDICATOR

      public static final org.apache.sshd.common.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

    • CLIENT_EXTENSIONS

      public static final org.apache.sshd.common.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:

    • OPENSSH_EXTENSIONS

      public static final org.apache.sshd.common.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 org.apache.sshd.common.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 org.apache.sshd.common.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:

    • MAX_READDATA_PACKET_LENGTH

      public static final org.apache.sshd.common.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:

    • MAX_WRITEDATA_PACKET_LENGTH

      public static final org.apache.sshd.common.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 org.apache.sshd.common.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:

    • DEFAULT_FILE_HANDLE_SIZE

      public static final int DEFAULT_FILE_HANDLE_SIZE
      See Also:

    • MAX_FILE_HANDLE_SIZE

      public static final int MAX_FILE_HANDLE_SIZE
      See Also:

    • FILE_HANDLE_SIZE

      public static final org.apache.sshd.common.Property<Integer> FILE_HANDLE_SIZE
      Size in bytes of the opaque handle value
      See Also:

    • MIN_FILE_HANDLE_ROUNDS

      public static final int MIN_FILE_HANDLE_ROUNDS
      See Also:

    • DEFAULT_FILE_HANDLE_ROUNDS

      public static final int DEFAULT_FILE_HANDLE_ROUNDS
      See Also:

    • MAX_FILE_HANDLE_ROUNDS

      public static final int MAX_FILE_HANDLE_ROUNDS
      See Also:

    • MAX_FILE_HANDLE_RAND_ROUNDS

      public static final org.apache.sshd.common.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:

    • MAX_READDIR_DATA_SIZE

      public static final org.apache.sshd.common.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 org.apache.sshd.common.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 org.apache.sshd.common.Property<Integer> SFTP_VERSION
      Force the use of a given sftp version