Class SftpModuleProperties


  • public final class SftpModuleProperties
    extends java.lang.Object
    Configurable properties for sshd-sftp.
    • Field Detail

      • SFTP_CHANNEL_OPEN_TIMEOUT

        public static final Property<java.time.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<java.lang.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<java.time.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<java.lang.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
      • COPY_BUF_SIZE

        public static final Property<java.lang.Integer> COPY_BUF_SIZE
        Internal allocate buffer size when copying data to/from the channel
      • AUTO_FOLLOW_LINKS

        public static final Property<java.lang.Boolean> AUTO_FOLLOW_LINKS
        Whether to automatically follow symbolic links when resolving paths
      • OPENSSH_EXTENSIONS

        public static final Property<java.lang.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
      • NEWLINE_VALUE

        public static final Property<java.lang.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
      • MIN_WRITEDATA_PACKET_LENGTH

        public static final int MIN_WRITEDATA_PACKET_LENGTH
        See Also:
        Constant Field Values
      • MAX_OPEN_HANDLES_PER_SESSION

        public static final Property<java.lang.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.
      • DEFAULT_FILE_HANDLE_SIZE

        public static final int DEFAULT_FILE_HANDLE_SIZE
        See Also:
        Constant Field Values
      • FILE_HANDLE_SIZE

        public static final Property<java.lang.Integer> FILE_HANDLE_SIZE
        Size in bytes of the opaque handle value
        See Also:
        DEFAULT_FILE_HANDLE_SIZE
      • DEFAULT_FILE_HANDLE_ROUNDS

        public static final int DEFAULT_FILE_HANDLE_ROUNDS
        See Also:
        Constant Field Values
      • MAX_READDIR_DATA_SIZE

        public static final Property<java.lang.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<java.lang.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<java.lang.Integer> SFTP_VERSION
        Force the use of a given sftp version
    • Constructor Detail

      • SftpModuleProperties

        private SftpModuleProperties()