Package org.apache.sshd.sftp.client.fs

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>

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 final class	SftpFileSystem.Wrapper

Field Summary

Fields

Modifier and Type	Field	Description
private final ClientSession	clientSession
private SftpPath	defaultDir
private final SftpErrorDataHandler	errorDataHandler
private final SftpClientFactory	factory
private final String	id
private final Queue<SftpClient>	pool
private int	readBufferSize
private final SftpVersionSelector	selector
private final List<FileStore>	stores
private final Set<String>	supportedViews
static final NavigableSet<String>	UNIVERSAL_SUPPORTED_VIEWS
private final int	version
private final ThreadLocal<SftpFileSystem.Wrapper>	wrappers
private int	writeBufferSize

Fields inherited from class org.apache.sshd.common.file.util.BaseFileSystem

log

Constructor Summary

Constructors

Constructor	Description
SftpFileSystem(SftpFileSystemProvider provider, String id, ClientSession session, 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()
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()
boolean	isOpen()
SftpFileSystemProvider	provider()
void	setReadBufferSize(int size)
void	setWriteBufferSize(int size)
Set<String>	supportedFileAttributeViews()
String	toString()

Methods inherited from class org.apache.sshd.common.file.util.BaseFileSystem

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

Methods inherited from class java.lang.Object

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

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

getSessionContext

Field Details

UNIVERSAL_SUPPORTED_VIEWS

public static final NavigableSet<String> UNIVERSAL_SUPPORTED_VIEWS

id

private final String id

clientSession

private final ClientSession clientSession

factory

private final SftpClientFactory factory

selector

private final SftpVersionSelector selector

errorDataHandler

private final SftpErrorDataHandler errorDataHandler

pool

private final Queue<SftpClient> pool

wrappers

private final ThreadLocal<SftpFileSystem.Wrapper> wrappers

version

private final int version

supportedViews

private final Set<String> supportedViews

defaultDir

private SftpPath defaultDir

readBufferSize

private int readBufferSize

writeBufferSize

private int writeBufferSize

stores

private final List<FileStore> stores

Constructor Details

SftpFileSystem

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

Throws:

IOException

Method Details

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>

getClient

public SftpClient getClient()
                     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