Class SftpFileSystem

java.lang.Object

java.nio.file.FileSystem

org.apache.sshd.common.file.util.BaseFileSystem<SftpPath>

org.apache.sshd.sftp.client.fs.SftpFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable, ClientSessionHolder, SessionContextHolder, SessionHolder<ClientSession>

Direct Known Subclasses:

SftpFileSystemAutomatic

public class SftpFileSystem
extends BaseFileSystem<SftpPath>
implements SessionHolder<ClientSession>, ClientSessionHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SftpFileSystem.DefaultGroupPrincipal
static class	SftpFileSystem.DefaultUserPrincipal
static class	SftpFileSystem.DefaultUserPrincipalLookupService
private class	SftpFileSystem.DelegatingClient
private class	SftpFileSystem.SftpClientEnriched	SftpClient with support for getting supported file attribute views and the server-side default directory.
private class	SftpFileSystem.Wrapper	The file system hands out only Wrapper instances to prevent the underlying SftpClient from being closed.

Field Summary

Fields

Modifier and Type	Field	Description
private AtomicReference<ClientSession>	clientSession
private final SftpErrorDataHandler	errorDataHandler
private final SftpClientFactory	factory
private final String	id
private final AtomicBoolean	open
static final AttributeRepository.AttributeKey<Boolean>	OWNED_SESSION	An AttributeRepository.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 int	readBufferSize
private final SftpVersionSelector	selector
private SftpFileSystem.SftpClientEnriched	sftp
private final List<FileStore>	stores
static final NavigableSet<String>	UNIVERSAL_SUPPORTED_VIEWS
private int	writeBufferSize

Fields inherited from class BaseFileSystem

log

Constructor Summary

Constructors

Modifier	Constructor	Description
	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	Description
void	close()
protected SftpPath	create(String root, List<String> names)
SftpClient	getClient()
private SftpFileSystem.SftpClientEnriched	getClientInternal()
ClientSession	getClientSession()
SftpPath	getDefaultDir()
List<FileStore>	getFileStores()
final String	getId()
int	getReadBufferSize()
ClientSession	getSession()
SftpErrorDataHandler	getSftpErrorDataHandler()
final SftpVersionSelector	getSftpVersionSelector()
UserPrincipalLookupService	getUserPrincipalLookupService()
final int	getVersion()
int	getWriteBufferSize()
protected void	init()
boolean	isOpen()
SftpFileSystemProvider	provider()
protected ClientSession	sessionForSftpClient()
protected void	setClientSession(ClientSession newSession)
void	setReadBufferSize(int size)
void	setWriteBufferSize(int size)
Set<String>	supportedFileAttributeViews()
String	toString()

Methods inherited from class BaseFileSystem

appendDedupSep, create, create, getPath, getPathMatcher, getRootDirectories, getSeparator, globToRegex, handleWindowsSeparator, hostFsHasWindowsSeparator, isReadOnly, newWatchService

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface SessionHolder

getSessionContext

Field Details

UNIVERSAL_SUPPORTED_VIEWS

public static final NavigableSet<String> UNIVERSAL_SUPPORTED_VIEWS

OWNED_SESSION

public static final AttributeRepository.AttributeKey<Boolean> OWNED_SESSION

An AttributeRepository.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.

id

private final String id

factory

private final SftpClientFactory factory

selector

private final SftpVersionSelector selector

errorDataHandler

private final SftpErrorDataHandler errorDataHandler

sftp

private SftpFileSystem.SftpClientEnriched sftp

readBufferSize

private int readBufferSize

writeBufferSize

private int writeBufferSize

stores

private final List<FileStore> stores

open

private final AtomicBoolean open

clientSession

private AtomicReference<ClientSession> clientSession

Constructor Details

SftpFileSystem

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

Throws:

IOException

SftpFileSystem

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

Method Details

init

protected void init()
             throws IOException

Throws:

IOException

getSftpVersionSelector

public final SftpVersionSelector getSftpVersionSelector()

getSftpErrorDataHandler

public SftpErrorDataHandler getSftpErrorDataHandler()

getId

public final String getId()

getVersion

public final int getVersion()

provider

public SftpFileSystemProvider provider()

Overrides:

provider in class BaseFileSystem<SftpPath>

getFileStores

public List<FileStore> getFileStores()

Overrides:

getFileStores in class BaseFileSystem<SftpPath>

getReadBufferSize

public int getReadBufferSize()

setReadBufferSize

public void setReadBufferSize(int size)

getWriteBufferSize

public int getWriteBufferSize()

setWriteBufferSize

public void setWriteBufferSize(int size)

create

protected SftpPath create(String root,
 List<String> names)

Specified by:

create in class BaseFileSystem<SftpPath>

getClientSession

public ClientSession getClientSession()

Specified by:

getClientSession in interface ClientSessionHolder

Returns:

The underlying ClientSession used

getSession

public ClientSession getSession()

Specified by:

getSession in interface SessionHolder<ClientSession>

setClientSession

protected void setClientSession(ClientSession newSession)

sessionForSftpClient

protected ClientSession sessionForSftpClient()
                                      throws IOException

Throws:

IOException

getClient

public SftpClient getClient()
                     throws IOException

Throws:

IOException

getClientInternal

private SftpFileSystem.SftpClientEnriched getClientInternal()
                                                     throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class FileSystem

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in class FileSystem

supportedFileAttributeViews

public Set<String> supportedFileAttributeViews()

Specified by:

supportedFileAttributeViews in class FileSystem

getUserPrincipalLookupService

public UserPrincipalLookupService getUserPrincipalLookupService()

Specified by:

getUserPrincipalLookupService in class FileSystem

getDefaultDir

public SftpPath getDefaultDir()

Overrides:

getDefaultDir in class BaseFileSystem<SftpPath>

toString

public String toString()

Overrides:

toString in class Object