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 of SSH_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 via SftpHelper.indicateEndOfNamesList(Buffer, int, PropertyResolver, boolean) call, as indicated by SFTP v6 - section 9.4
static Property<java.time.Duration>	AUTH_TIME	See SftpFileSystemProvider.
static Property<java.lang.Boolean>	AUTO_FOLLOW_LINKS	Whether to automatically follow symbolic links when resolving paths
static Property<java.lang.Boolean>	CHUNK_IF_WINDOW_LESS_THAN_PACKET	Determines the chunking behaviour, if the remote window size is smaller than the packet size.
static 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	See SftpFileSystemProvider.
static Property<java.lang.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<java.lang.Integer>	FILE_HANDLE_SIZE	Size in bytes of the opaque handle value
static 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 of SftpSubsystem.doReadDir(Buffer, int)
static int	MIN_FILE_HANDLE_ROUNDS
static int	MIN_FILE_HANDLE_SIZE
static Property<java.nio.charset.Charset>	NAME_DECODER_CHARSET	See SftpFileSystemProvider.
static Property<java.nio.charset.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<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 which OpenSSH extensions are reported and what version is reported for each - format: name=version.
static Property<java.lang.Integer>	POOL_SIZE	See SftpFileSystem.
static Property<java.lang.Integer>	READ_BUFFER_SIZE	See SftpFileSystemProvider.
static 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.
static Property<java.lang.Integer>	SFTP_VERSION	Force the use of a given sftp version
static Property<java.lang.Integer>	WRITE_BUFFER_SIZE	See SftpFileSystemProvider.
static Property<java.lang.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.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SftpModuleProperties()

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<java.nio.charset.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<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

See SftpFileSystem.

READ_BUFFER_SIZE

public static final Property<java.lang.Integer> READ_BUFFER_SIZE

See SftpFileSystemProvider.

WRITE_BUFFER_SIZE

public static final Property<java.lang.Integer> WRITE_BUFFER_SIZE

See SftpFileSystemProvider.

CONNECT_TIME

public static final Property<java.time.Duration> CONNECT_TIME

See SftpFileSystemProvider.

AUTH_TIME

public static final Property<java.time.Duration> AUTH_TIME

See SftpFileSystemProvider.

NAME_DECODER_CHARSET

public static final Property<java.nio.charset.Charset> NAME_DECODER_CHARSET

See SftpFileSystemProvider.

WRITE_CHUNK_SIZE

public static final Property<java.lang.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<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 via SftpHelper.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 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<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

ACL_SUPPORTED_MASK

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

Property that can be used to set the reported NL value. If not set, then IoUtils.EOL is used

MAX_READDATA_PACKET_LENGTH

public static final Property<java.lang.Integer> MAX_READDATA_PACKET_LENGTH

Force the use of a max. packet length for AbstractSftpSubsystemHelper.doRead(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.

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

See Also:

SftpSubsystem.generateFileHandle(Path), DEFAULT_FILE_HANDLE_ROUNDS

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)

SFTP_VERSION

public static final Property<java.lang.Integer> SFTP_VERSION

Force the use of a given sftp version

CHUNK_IF_WINDOW_LESS_THAN_PACKET

public static final Property<java.lang.Boolean> CHUNK_IF_WINDOW_LESS_THAN_PACKET

Determines the chunking behaviour, if the remote window size is smaller than the packet size. Can be used to establish compatibility with certain clients, that wait until the window size is 0 before adjusting it.

See Also:

SSHD-1123

Constructor Detail

SftpModuleProperties

private SftpModuleProperties()