org.apache.sshd.server.subsystem.sftp

Interface SftpSubsystemEnvironment

All Superinterfaces:

ServerSessionHolder, SessionContextHolder, SessionHolder<ServerSession>

All Known Subinterfaces:

SftpSubsystemProxy

All Known Implementing Classes:

AbstractSftpSubsystemHelper, SftpSubsystem

public interface SftpSubsystemEnvironment
extends SessionHolder<ServerSession>, ServerSessionHolder

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_SFTP_IMPL
static int	HIGHER_SFTP_IMPL
static int	LOWER_SFTP_IMPL
static String	SFTP_VERSION Force the use of a given sftp version
static List<Integer>	SUPPORTED_SFTP_VERSIONS

Method Summary

Modifier and Type	Method and Description
Path	getDefaultDirectory()
SftpFileSystemAccessor	getFileSystemAccessor()
default ServerSession	getSession()
UnsupportedAttributePolicy	getUnsupportedAttributePolicy()
int	getVersion()

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Methods inherited from interface org.apache.sshd.server.session.ServerSessionHolder

getServerSession

Field Detail

SFTP_VERSION

static final String SFTP_VERSION

Force the use of a given sftp version

See Also:

Constant Field Values

LOWER_SFTP_IMPL

static final int LOWER_SFTP_IMPL

See Also:

Constant Field Values

HIGHER_SFTP_IMPL

static final int HIGHER_SFTP_IMPL

See Also:

Constant Field Values

SUPPORTED_SFTP_VERSIONS

static final List<Integer> SUPPORTED_SFTP_VERSIONS

ALL_SFTP_IMPL

static final String ALL_SFTP_IMPL

Method Detail

getSession

default ServerSession getSession()

Specified by:

getSession in interface SessionHolder<ServerSession>

getVersion

int getVersion()

Returns:

The negotiated version

getFileSystemAccessor

SftpFileSystemAccessor getFileSystemAccessor()

Returns:

The SftpFileSystemAccessor used to access effective server-side paths

getUnsupportedAttributePolicy

UnsupportedAttributePolicy getUnsupportedAttributePolicy()

Returns:

The selected behavior in case some unsupported attributes are requested

getDefaultDirectory

Path getDefaultDirectory()

Returns:

The default root directory used to resolve relative paths - a.k.a. the chroot location