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:

java.io.Closeable, java.lang.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 java.util.concurrent.atomic.AtomicReference<ClientSession>	clientSession
private SftpErrorDataHandler	errorDataHandler
private SftpClientFactory	factory
private java.lang.String	id
private java.util.concurrent.atomic.AtomicBoolean	open
static AttributeRepository.AttributeKey<java.lang.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 SftpVersionSelector	selector
private SftpFileSystem.SftpClientEnriched	sftp
private java.util.List<java.nio.file.FileStore>	stores
static java.util.NavigableSet<java.lang.String>	UNIVERSAL_SUPPORTED_VIEWS
private int	writeBufferSize

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

log

Constructor Summary

Constructors

Modifier	Constructor	Description
	SftpFileSystem(SftpFileSystemProvider provider, java.lang.String id, ClientSession session, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
protected	SftpFileSystem(SftpFileSystemProvider provider, java.lang.String id, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)

Method Summary

Modifier and Type	Method	Description
void	close()
protected SftpPath	create(java.lang.String root, java.util.List<java.lang.String> names)
SftpClient	getClient()
private SftpFileSystem.SftpClientEnriched	getClientInternal()
ClientSession	getClientSession()
SftpPath	getDefaultDir()
java.util.List<java.nio.file.FileStore>	getFileStores()
java.lang.String	getId()
int	getReadBufferSize()
ClientSession	getSession()
SftpErrorDataHandler	getSftpErrorDataHandler()
SftpVersionSelector	getSftpVersionSelector()
java.nio.file.attribute.UserPrincipalLookupService	getUserPrincipalLookupService()
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)
java.util.Set<java.lang.String>	supportedFileAttributeViews()
java.lang.String	toString()

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

appendDedupSep, create, create, getPath, getPathMatcher, getRootDirectories, getSeparator, globToRegex, handleWindowsSeparator, hostFsHasWindowsSeparator, 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 Detail

UNIVERSAL_SUPPORTED_VIEWS

public static final java.util.NavigableSet<java.lang.String> UNIVERSAL_SUPPORTED_VIEWS

OWNED_SESSION

public static final AttributeRepository.AttributeKey<java.lang.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 java.lang.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 java.util.List<java.nio.file.FileStore> stores

open

private final java.util.concurrent.atomic.AtomicBoolean open

clientSession

private java.util.concurrent.atomic.AtomicReference<ClientSession> clientSession

Constructor Detail

SftpFileSystem

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

Throws:

java.io.IOException

SftpFileSystem

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

Method Detail

init

protected void init()
             throws java.io.IOException

Throws:

java.io.IOException

getSftpVersionSelector

public final SftpVersionSelector getSftpVersionSelector()

getSftpErrorDataHandler

public SftpErrorDataHandler getSftpErrorDataHandler()

getId

public final java.lang.String getId()

getVersion

public final int getVersion()

provider

public SftpFileSystemProvider provider()

Overrides:

provider in class BaseFileSystem<SftpPath>

getFileStores

public java.util.List<java.nio.file.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(java.lang.String root,
                          java.util.List<java.lang.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 java.io.IOException

Throws:

java.io.IOException

getClient

public SftpClient getClient()
                     throws java.io.IOException

Throws:

java.io.IOException

getClientInternal

private SftpFileSystem.SftpClientEnriched getClientInternal()
                                                     throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in class java.nio.file.FileSystem

Throws:

java.io.IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in class java.nio.file.FileSystem

supportedFileAttributeViews

public java.util.Set<java.lang.String> supportedFileAttributeViews()

Specified by:

supportedFileAttributeViews in class java.nio.file.FileSystem

getUserPrincipalLookupService

public java.nio.file.attribute.UserPrincipalLookupService getUserPrincipalLookupService()

Specified by:

getUserPrincipalLookupService in class java.nio.file.FileSystem

getDefaultDir

public SftpPath getDefaultDir()

Overrides:

getDefaultDir in class BaseFileSystem<SftpPath>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object