Package org.apache.sshd.sftp
Class SftpModuleProperties
- java.lang.Object
-
- org.apache.sshd.sftp.SftpModuleProperties
-
public final class SftpModuleProperties extends java.lang.Object
Configurable properties for sshd-sftp.
-
-
Field Summary
Fields Modifier and Type Field Description static Property<java.lang.String>
ACL_SUPPORTED_MASK
Comma separate list ofSSH_ACL_CAP_xxx
names - where name can be without the prefix.static Property<java.lang.Boolean>
APPEND_END_OF_LIST_INDICATOR
Used to control whether to append the end-of-list indicator for SSH_FXP_NAME responses viaSftpHelper.indicateEndOfNamesList(Buffer, int, PropertyResolver, boolean)
call, as indicated by SFTP v6 - section 9.4static Property<java.time.Duration>
AUTH_TIME
static Property<java.lang.Boolean>
AUTO_FOLLOW_LINKS
Whether to automatically follow symbolic links when resolving pathsstatic Property<java.lang.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<java.time.Duration>
CONNECT_TIME
static Property<java.lang.Integer>
COPY_BUF_SIZE
Internal allocate buffer size when copying data to/from the channelstatic int
DEFAULT_FILE_HANDLE_ROUNDS
static int
DEFAULT_FILE_HANDLE_SIZE
static Property<java.lang.Integer>
FILE_HANDLE_SIZE
Size in bytes of the opaque handle valuestatic Property<java.lang.Integer>
MAX_FILE_HANDLE_RAND_ROUNDS
Max.static int
MAX_FILE_HANDLE_ROUNDS
static int
MAX_FILE_HANDLE_SIZE
static Property<java.lang.Integer>
MAX_OPEN_HANDLES_PER_SESSION
Properties key for the maximum of available open handles per session.static Property<java.lang.Integer>
MAX_READDATA_PACKET_LENGTH
Force the use of a max.static Property<java.lang.Integer>
MAX_READDIR_DATA_SIZE
Maximum amount of data allocated for listing the contents of a directory in any single invocation ofSftpSubsystem.doReadDir(Buffer, int)
static Property<java.lang.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<java.nio.charset.Charset>
NAME_DECODER_CHARSET
static Property<java.nio.charset.Charset>
NAME_DECODING_CHARSET
Used to indicate theCharset
(or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.static Property<java.lang.String>
NEWLINE_VALUE
Property that can be used to set the reported NL value.static Property<java.lang.String>
OPENSSH_EXTENSIONS
Comma-separated list of whichOpenSSH
extensions are reported and what version is reported for each - format:name=version
.static Property<java.lang.Integer>
POOL_CORE_SIZE
If >= 0, that many channels may be kept open in the channel pool of anSftpFileSystem
even if they are idle; by default 1.static Property<java.time.Duration>
POOL_LIFE_TIME
A timeout after which idle channels in the pool of anSftpFileSystem
are removed from the pool and closed; by default 10 seconds.static Property<java.lang.Integer>
POOL_SIZE
The maximum size of the channel pool used by anSftpFileSystem
; by default 8.static Property<java.lang.Integer>
READ_BUFFER_SIZE
static Property<java.time.Duration>
SFTP_CHANNEL_OPEN_TIMEOUT
Property that can be used on theFactoryManager
to control the internal timeout used by the client to open a channel.static Property<java.lang.Integer>
SFTP_VERSION
Force the use of a given sftp versionstatic Property<java.lang.Integer>
WRITE_BUFFER_SIZE
static Property<java.lang.Integer>
WRITE_CHUNK_SIZE
Property used to avoid large buffers whenAbstractSftpClient.write(SftpClient.Handle, long, byte[], int, int)
is invoked with a large buffer size.
-
Constructor Summary
Constructors Modifier Constructor Description private
SftpModuleProperties()
-
-
-
Field Detail
-
NAME_DECODING_CHARSET
public static final Property<java.nio.charset.Charset> NAME_DECODING_CHARSET
Used to indicate theCharset
(or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.
-
SFTP_CHANNEL_OPEN_TIMEOUT
public static final Property<java.time.Duration> SFTP_CHANNEL_OPEN_TIMEOUT
Property that can be used on theFactoryManager
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 anSftpFileSystem
; 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 anSftpFileSystem
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 anSftpFileSystem
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<java.lang.Integer> READ_BUFFER_SIZE
-
WRITE_BUFFER_SIZE
public static final Property<java.lang.Integer> WRITE_BUFFER_SIZE
-
CONNECT_TIME
public static final Property<java.time.Duration> CONNECT_TIME
-
AUTH_TIME
public static final Property<java.time.Duration> AUTH_TIME
-
NAME_DECODER_CHARSET
public static final Property<java.nio.charset.Charset> NAME_DECODER_CHARSET
-
WRITE_CHUNK_SIZE
public static final Property<java.lang.Integer> WRITE_CHUNK_SIZE
Property used to avoid large buffers whenAbstractSftpClient.write(SftpClient.Handle, long, byte[], int, int)
is invoked with a large buffer size.
-
COPY_BUF_SIZE
public static final Property<java.lang.Integer> COPY_BUF_SIZE
Internal allocate buffer size when copying data to/from the channel
-
APPEND_END_OF_LIST_INDICATOR
public static final Property<java.lang.Boolean> APPEND_END_OF_LIST_INDICATOR
Used to control whether to append the end-of-list indicator for SSH_FXP_NAME responses viaSftpHelper.indicateEndOfNamesList(Buffer, int, PropertyResolver, boolean)
call, as indicated by SFTP v6 - section 9.4
-
AUTO_FOLLOW_LINKS
public static final Property<java.lang.Boolean> AUTO_FOLLOW_LINKS
Whether to automatically follow symbolic links when resolving paths
-
CLIENT_EXTENSIONS
public static final Property<java.lang.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 theAbstractSftpSubsystemHelper.executeExtendedCommand(Buffer, int, String)
command accordingly. If empty string is set then no server extensions are reported
-
OPENSSH_EXTENSIONS
public static final Property<java.lang.String> OPENSSH_EXTENSIONS
Comma-separated list of whichOpenSSH
extensions are reported and what version is reported for each - format:name=version
. If empty value set, then no such extensions are reported. Otherwise, theAbstractSftpSubsystemHelper.DEFAULT_OPEN_SSH_EXTENSIONS
are used
-
ACL_SUPPORTED_MASK
public static final Property<java.lang.String> ACL_SUPPORTED_MASK
Comma separate list ofSSH_ACL_CAP_xxx
names - where name can be without the prefix. If not defined thenAbstractSftpSubsystemHelper.DEFAULT_ACL_SUPPORTED_MASK
is 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, thenIoUtils.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<java.lang.Integer> MAX_READDATA_PACKET_LENGTH
Force the use of a max. packet length forAbstractSftpSubsystemHelper.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<java.lang.Integer> MAX_WRITEDATA_PACKET_LENGTH
Force the use of a max. packet length forAbstractSftpSubsystemHelper.doWrite(Buffer, int)
protection against malicious packets
-
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.
-
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<java.lang.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<java.lang.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
-
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 ofSftpSubsystem.doReadDir(Buffer, int)
-
SFTP_VERSION
public static final Property<java.lang.Integer> SFTP_VERSION
Force the use of a given sftp version
-
-