Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.fs.SftpFileSystem

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	SftpFileSystem.DefaultGroupPrincipal
public static class	SftpFileSystem.DefaultUserPrincipal
public static class	SftpFileSystem.DefaultUserPrincipalLookupService
protected static class	SftpFileSystem.SftpClientHandle The `SftpClientPool` stores `SftpClient`s not directly but via handles in its channel pool.
protected class	SftpFileSystem.SftpClientPool A pool of `SftpClient`s.
private class	SftpFileSystem.Wrapper

Modifier and Type	Field and Description
private AtomicReference<ClientSession>	clientSession
private SftpPath	defaultDir
private final SftpErrorDataHandler	errorDataHandler
private final SftpClientFactory	factory
private final String	id
private final AtomicBoolean	open
public static final AttributeRepository.AttributeKey<Boolean>	OWNED_SESSION An `AttributeKey` that can be set to `Boolean#TRUE` on the `ClientSession` to tell the `SftpFileSystem` that it owns that session and should close it when the `SftpFileSystem` itself is closed.
private SftpFileSystem.SftpClientPool	pool
private int	readBufferSize
private final SftpVersionSelector	selector
private final List<FileStore>	stores
private Set<String>	supportedViews
public static final NavigableSet<String>	UNIVERSAL_SUPPORTED_VIEWS
private int	version
private int	writeBufferSize

Modifier and Type

Field and Description

private AtomicReference<ClientSession>

clientSession

private SftpPath

defaultDir

private final SftpErrorDataHandler

errorDataHandler

private final SftpClientFactory

factory

private final String

private final AtomicBoolean

open

public static final AttributeRepository.AttributeKey<Boolean>

OWNED_SESSION

An AttributeKey that can be set to Boolean#TRUE on the ClientSession to tell the SftpFileSystem that it owns that session and should close it when the SftpFileSystem itself is closed.

private SftpFileSystem.SftpClientPool

pool

private int

readBufferSize

private final SftpVersionSelector

selector

private final List<FileStore>

stores

private Set<String>

supportedViews

public static final NavigableSet<String>

UNIVERSAL_SUPPORTED_VIEWS

private int

version

private int

writeBufferSize

Access	Constructor and Description
public	SftpFileSystem(SftpFileSystemProvider provider, String id, ClientSession session, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
protected	SftpFileSystem(SftpFileSystemProvider provider, String id, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)

Access

Constructor and Description

public

SftpFileSystem(SftpFileSystemProvider provider, String id, ClientSession session, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)

protected

SftpFileSystem(SftpFileSystemProvider provider, String id, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.nio.file.FileSystem.close. Implements java.io.Closeable.close. Closes this file system.
protected SftpPath	create(String root, List<String> names) Implements abstract org.apache.sshd.common.file.util.BaseFileSystem.create.
public SftpClient	getClient()
public ClientSession	getClientSession() Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.
public SftpPath	getDefaultDir() Overrides org.apache.sshd.common.file.util.BaseFileSystem.getDefaultDir.
public List<FileStore>	getFileStores() Overrides org.apache.sshd.common.file.util.BaseFileSystem.getFileStores. Returns an object to iterate over the underlying file stores.
public final String	getId()
public int	getReadBufferSize()
public ClientSession	getSession() Implements org.apache.sshd.common.session.SessionHolder.getSession.
public SftpErrorDataHandler	getSftpErrorDataHandler()
public final SftpVersionSelector	getSftpVersionSelector()
public UserPrincipalLookupService	getUserPrincipalLookupService() Implements abstract java.nio.file.FileSystem.getUserPrincipalLookupService. Returns the `UserPrincipalLookupService` for this file system (optional operation).
public final int	getVersion()
public int	getWriteBufferSize()
protected void	init()
public boolean	isOpen() Implements abstract java.nio.file.FileSystem.isOpen. Tells whether or not this file system is open.
public SftpFileSystemProvider	provider() Overrides org.apache.sshd.common.file.util.BaseFileSystem.provider. Returns the provider that created this file system.
protected ClientSession	sessionForSftpClient()
protected void	setClientSession(ClientSession newSession)
public void	setReadBufferSize(int size)
public void	setWriteBufferSize(int size)
public Set<String>	supportedFileAttributeViews() Implements abstract java.nio.file.FileSystem.supportedFileAttributeViews. Returns the set of the `names` of the file attribute views supported by this `FileSystem`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.sshd.common.file.util.BaseFileSystem:: appendDedupSep create create getPath getPathMatcher getRootDirectories getSeparator globToRegex handleWindowsSeparator hostFsHasWindowsSeparator isReadOnly newWatchService

public Class SftpFileSystem

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary