Package org.apache.sshd.sftp
Class SftpModuleProperties
java.lang.Object
org.apache.sshd.sftp.SftpModuleProperties
Configurable properties for sshd-sftp.
-
Field Summary
FieldsModifier and TypeFieldDescriptionComma separate list ofSSH_ACL_CAP_xxx
names - where name can be without the prefix.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.4Whether to automatically follow symbolic links when resolving pathsAllows controlling reports of which client extensions are supported (and reported via "support" and "support2" server extensions) as a comma-separate list of names.Internal allocate buffer size when copying data to/from the channelstatic final int
static final int
Size in bytes of the opaque handle valueMax.static final int
static final int
Properties key for the maximum of available open handles per session.Force the use of a max.Maximum amount of data allocated for listing the contents of a directory in any single invocation ofSftpSubsystem.doReadDir(Buffer, int)
Force the use of a max.static final int
static final int
static final int
static final int
Used to indicate theCharset
(or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.Property that can be used to set the reported NL value.Comma-separated list of whichOpenSSH
extensions are reported and what version is reported for each - format:name=version
.If >= 0, that many channels may be kept open in the channel pool of anSftpFileSystem
even if they are idle; by default 1.A timeout after which idle channels in the pool of anSftpFileSystem
are removed from the pool and closed; by default 10 seconds.The maximum size of the channel pool used by anSftpFileSystem
; by default 8.Property that can be used on theFactoryManager
to control the internal timeout used by the client to open a channel.Force the use of a given sftp versionApparently some SFTP servers may return more data than requested in SFTP read requests.Property used to avoid large buffers whenAbstractSftpClient.write(SftpClient.Handle, long, byte[], int, int)
is invoked with a large buffer size. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
NAME_DECODING_CHARSET
Used to indicate theCharset
(or its name) for decoding referenced files/folders names - extracted from the client session when 1st initialized.- See Also:
-
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
The maximum size of the channel pool used by anSftpFileSystem
; by default 8. The value must be > zero.- See Also:
-
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:
-
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:
-
READ_BUFFER_SIZE
-
WRITE_BUFFER_SIZE
-
CONNECT_TIME
-
AUTH_TIME
-
NAME_DECODER_CHARSET
-
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
Internal allocate buffer size when copying data to/from the channel -
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
Whether to automatically follow symbolic links when resolving paths -
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- See Also:
-
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
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
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:
-
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:
-
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
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
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
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
Maximum amount of data allocated for listing the contents of a directory in any single invocation ofSftpSubsystem.doReadDir(Buffer, int)
-
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 istrue
, such excess data is ignored and a warning is logged. If the flag isfalse
(the default), an exception is thrown. The flag can be set on an SSH session or on theclient channel
of anSftpClient
. -
SFTP_VERSION
Force the use of a given sftp version
-
-
Constructor Details
-
SftpModuleProperties
private SftpModuleProperties()
-