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

Class SftpFileSystemProvider

java.lang.Object

java.nio.file.spi.FileSystemProvider

org.apache.sshd.sftp.client.fs.SftpFileSystemProvider

public class SftpFileSystemProvider
extends FileSystemProvider

A registered FileSystemProvider that registers the "sftp://" scheme so that URLs with this protocol are handled as remote SFTP Path-s - e.g., "sftp://user:password@host/remote/file/path"

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	log
static Set<Class<? extends FileAttributeView>>	UNIVERSAL_SUPPORTED_VIEWS
static String	VERSION_PARAM	URI parameter that can be used to specify a special version selection.

Constructor Summary

Constructors

Constructor	Description
SftpFileSystemProvider()
SftpFileSystemProvider(SshClient client)
SftpFileSystemProvider(SshClient client, SftpClientFactory factory, SftpVersionSelector selector)
SftpFileSystemProvider(SshClient client, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
SftpFileSystemProvider(SshClient client, SftpVersionSelector selector)
SftpFileSystemProvider(SshClient client, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
SftpFileSystemProvider(SftpVersionSelector selector)

Method Summary

Modifier and Type	Method	Description
protected int	attributesToPermissions(Path path, Collection<PosixFilePermission> perms)
void	checkAccess(Path path, AccessMode... modes)
void	copy(Path source, Path target, CopyOption... options)
void	createDirectory(Path dir, FileAttribute<?>... attrs)
static URI	createFileSystemURI(String host, int port, String username, String password)
static URI	createFileSystemURI(String host, int port, String username, String password, Map<String,?> params)
void	createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)
void	delete(Path path)
static String	encodeCredentials(String username, String password)
SshClient	getClientInstance()
<V extends FileAttributeView> V	getFileAttributeView(Path path, Class<V> type, LinkOption... options)
FileStore	getFileStore(Path path)
SftpFileSystem	getFileSystem(String id)
FileSystem	getFileSystem(URI uri)
static String	getFileSystemIdentifier(String host, int port, String username)
static String	getFileSystemIdentifier(URI uri)	Uses the host, port and username to create a unique identifier
static String	getFileSystemIdentifier(ClientSession session)	Uses the remote host address, port and current username to create a unique identifier
static String	getOctalPermissions(int perms)
static String	getOctalPermissions(Collection<PosixFilePermission> perms)
Path	getPath(URI uri)
static String	getRWXPermissions(int perms)
String	getScheme()
SftpClientFactory	getSftpClientFactory()
SftpErrorDataHandler	getSftpErrorDataHandler()
SftpFileSystemClientSessionInitializer	getSftpFileSystemClientSessionInitializer()
SftpVersionSelector	getSftpVersionSelector()
boolean	isHidden(Path path)
boolean	isSameFile(Path path1, Path path2)
boolean	isSupportedFileAttributeView(Path path, Class<? extends FileAttributeView> type)
boolean	isSupportedFileAttributeView(SftpFileSystem fs, Class<? extends FileAttributeView> type)
void	move(Path source, Path target, CopyOption... options)
FileChannel	newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)
DirectoryStream<Path>	newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter)
FileChannel	newFileChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)
SftpFileSystem	newFileSystem(URI uri, Map<String,?> env)
SftpFileSystem	newFileSystem(ClientSession session)
InputStream	newInputStream(Path path, OpenOption... options)
OutputStream	newOutputStream(Path path, OpenOption... options)
static MutableBasicCredentials	parseCredentials(String userInfo)
static MutableBasicCredentials	parseCredentials(URI uri)	Attempts to parse the user information from the URI
static Map<String,Object>	parseURIParameters(String params)
static Map<String,Object>	parseURIParameters(URI uri)
static Set<PosixFilePermission>	permissionsToAttributes(int perms)
protected NavigableMap<String,Object>	readAclViewAttributes(SftpPath path, String view, String attrs, LinkOption... options)
<A extends BasicFileAttributes> A	readAttributes(Path path, Class<A> type, LinkOption... options)
Map<String,Object>	readAttributes(Path path, String view, String attrs, LinkOption... options)
Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options)
protected Map<String,Object>	readCustomViewAttributes(SftpPath path, String view, String attrs, LinkOption... options)
protected NavigableMap<String,Object>	readPosixViewAttributes(SftpPath path, String view, String attrs, LinkOption... options)
SftpClient.Attributes	readRemoteAttributes(SftpPath path, LinkOption... options)
Path	readSymbolicLink(Path link)
SftpFileSystem	removeFileSystem(String id)
static Map<String,Object>	resolveFileSystemParameters(Map<String,?> env, Map<String,Object> uriParams)
protected SftpClient.Attributes	resolveRemoteFileAttributes(SftpPath path, LinkOption... options)
protected SftpErrorDataHandler	resolveSftpErrorDataHandler(URI uri, SftpErrorDataHandler errorHandler, PropertyResolver resolver)
protected SftpVersionSelector	resolveSftpVersionSelector(URI uri, SftpVersionSelector defaultSelector, PropertyResolver resolver)
void	setAttribute(Path path, String attribute, Object value, LinkOption... options)
void	setAttribute(Path path, String view, String attr, Object value, LinkOption... options)
void	setSftpFileSystemClientSessionInitializer(SftpFileSystemClientSessionInitializer initializer)
SftpPath	toSftpPath(Path path)

Methods inherited from class java.nio.file.spi.FileSystemProvider

createLink, deleteIfExists, installedProviders, newAsynchronousFileChannel, newFileSystem

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_PARAM

public static final String VERSION_PARAM

URI parameter that can be used to specify a special version selection. Options are:

• max - select maximum available version for the client
• min - select minimum available version for the client
• current - whatever version is reported by the server
• nnn - select only the specified version
• a,b,c - select one of the specified versions (if available) in preference order

See Also:

Constant Field Values

UNIVERSAL_SUPPORTED_VIEWS

public static final Set<Class<? extends FileAttributeView>> UNIVERSAL_SUPPORTED_VIEWS

log

protected final org.slf4j.Logger log

Constructor Detail

SftpFileSystemProvider

public SftpFileSystemProvider()

SftpFileSystemProvider

public SftpFileSystemProvider(SftpVersionSelector selector)

SftpFileSystemProvider

public SftpFileSystemProvider(SshClient client)

SftpFileSystemProvider

public SftpFileSystemProvider(SshClient client,
                              SftpVersionSelector selector)

SftpFileSystemProvider

public SftpFileSystemProvider(SshClient client,
                              SftpVersionSelector selector,
                              SftpErrorDataHandler errorDataHandler)

SftpFileSystemProvider

public SftpFileSystemProvider(SshClient client,
                              SftpClientFactory factory,
                              SftpVersionSelector selector)

SftpFileSystemProvider

public SftpFileSystemProvider(SshClient client,
                              SftpClientFactory factory,
                              SftpVersionSelector selector,
                              SftpErrorDataHandler errorDataHandler)

Parameters:

client - The SshClient to use - if null then a default one will be setup and started. Otherwise, it is assumed that the client has already been started

factory - The SftpClientFactory to use to generate SFTP client instances

selector - The SftpVersionSelector to use in order to negotiate the SFTP version

errorDataHandler - The SftpErrorDataHandler to handle incoming data through the error stream - if null the data is silently ignored

See Also:

SshClient.setUpDefaultClient()

Method Detail

getScheme

public String getScheme()

Specified by:

getScheme in class FileSystemProvider

getSftpVersionSelector

public final SftpVersionSelector getSftpVersionSelector()

getSftpErrorDataHandler

public SftpErrorDataHandler getSftpErrorDataHandler()

getClientInstance

public final SshClient getClientInstance()

getSftpClientFactory

public SftpClientFactory getSftpClientFactory()

getSftpFileSystemClientSessionInitializer

public SftpFileSystemClientSessionInitializer getSftpFileSystemClientSessionInitializer()

setSftpFileSystemClientSessionInitializer

public void setSftpFileSystemClientSessionInitializer(SftpFileSystemClientSessionInitializer initializer)

newFileSystem

public SftpFileSystem newFileSystem(URI uri,
                                    Map<String,?> env)
                             throws IOException

Specified by:

newFileSystem in class FileSystemProvider

Throws:

IOException

resolveSftpVersionSelector

protected SftpVersionSelector resolveSftpVersionSelector(URI uri,
                                                         SftpVersionSelector defaultSelector,
                                                         PropertyResolver resolver)

resolveSftpErrorDataHandler

protected SftpErrorDataHandler resolveSftpErrorDataHandler(URI uri,
                                                           SftpErrorDataHandler errorHandler,
                                                           PropertyResolver resolver)

resolveFileSystemParameters

public static Map<String,Object> resolveFileSystemParameters(Map<String,?> env,
                                                                   Map<String,Object> uriParams)

parseCredentials

public static MutableBasicCredentials parseCredentials(URI uri)

Attempts to parse the user information from the URI

Parameters:

uri - The URI value - ignored if null or does not contain any user info.

Returns:

The parsed credentials - null if none available

parseCredentials

public static MutableBasicCredentials parseCredentials(String userInfo)

parseURIParameters

public static Map<String,Object> parseURIParameters(URI uri)

parseURIParameters

public static Map<String,Object> parseURIParameters(String params)

newFileSystem

public SftpFileSystem newFileSystem(ClientSession session)
                             throws IOException

Throws:

IOException

getFileSystem

public FileSystem getFileSystem(URI uri)

Specified by:

getFileSystem in class FileSystemProvider

removeFileSystem

public SftpFileSystem removeFileSystem(String id)

Parameters:

id - File system identifier - ignored if null/empty

Returns:

The removed SftpFileSystem - null if no match

getFileSystem

public SftpFileSystem getFileSystem(String id)

Parameters:

id - File system identifier - ignored if null/empty

Returns:

The cached SftpFileSystem - null if no match

getPath

public Path getPath(URI uri)

Specified by:

getPath in class FileSystemProvider

newByteChannel

public FileChannel newByteChannel(Path path,
                                  Set<? extends OpenOption> options,
                                  FileAttribute<?>... attrs)
                           throws IOException

Specified by:

newByteChannel in class FileSystemProvider

Throws:

IOException

newFileChannel

public FileChannel newFileChannel(Path path,
                                  Set<? extends OpenOption> options,
                                  FileAttribute<?>... attrs)
                           throws IOException

Overrides:

newFileChannel in class FileSystemProvider

Throws:

IOException

newInputStream

public InputStream newInputStream(Path path,
                                  OpenOption... options)
                           throws IOException

Overrides:

newInputStream in class FileSystemProvider

Throws:

IOException

newOutputStream

public OutputStream newOutputStream(Path path,
                                    OpenOption... options)
                             throws IOException

Overrides:

newOutputStream in class FileSystemProvider

Throws:

IOException

newDirectoryStream

public DirectoryStream<Path> newDirectoryStream(Path dir,
                                                DirectoryStream.Filter<? super Path> filter)
                                         throws IOException

Specified by:

newDirectoryStream in class FileSystemProvider

Throws:

IOException

createDirectory

public void createDirectory(Path dir,
                            FileAttribute<?>... attrs)
                     throws IOException

Specified by:

createDirectory in class FileSystemProvider

Throws:

IOException

delete

public void delete(Path path)
            throws IOException

Specified by:

delete in class FileSystemProvider

Throws:

IOException

copy

public void copy(Path source,
                 Path target,
                 CopyOption... options)
          throws IOException

Specified by:

copy in class FileSystemProvider

Throws:

IOException

move

public void move(Path source,
                 Path target,
                 CopyOption... options)
          throws IOException

Specified by:

move in class FileSystemProvider

Throws:

IOException

isSameFile

public boolean isSameFile(Path path1,
                          Path path2)
                   throws IOException

Specified by:

isSameFile in class FileSystemProvider

Throws:

IOException

isHidden

public boolean isHidden(Path path)
                 throws IOException

Specified by:

isHidden in class FileSystemProvider

Throws:

IOException

getFileStore

public FileStore getFileStore(Path path)
                       throws IOException

Specified by:

getFileStore in class FileSystemProvider

Throws:

IOException

createSymbolicLink

public void createSymbolicLink(Path link,
                               Path target,
                               FileAttribute<?>... attrs)
                        throws IOException

Overrides:

createSymbolicLink in class FileSystemProvider

Throws:

IOException

readSymbolicLink

public Path readSymbolicLink(Path link)
                      throws IOException

Overrides:

readSymbolicLink in class FileSystemProvider

Throws:

IOException

checkAccess

public void checkAccess(Path path,
                        AccessMode... modes)
                 throws IOException

Specified by:

checkAccess in class FileSystemProvider

Throws:

IOException

getFileAttributeView

public <V extends FileAttributeView> V getFileAttributeView(Path path,
                                                            Class<V> type,
                                                            LinkOption... options)

Specified by:

getFileAttributeView in class FileSystemProvider

isSupportedFileAttributeView

public boolean isSupportedFileAttributeView(Path path,
                                            Class<? extends FileAttributeView> type)

isSupportedFileAttributeView

public boolean isSupportedFileAttributeView(SftpFileSystem fs,
                                            Class<? extends FileAttributeView> type)

readAttributes

public <A extends BasicFileAttributes> A readAttributes(Path path,
                                                        Class<A> type,
                                                        LinkOption... options)
                                                 throws IOException

Specified by:

readAttributes in class FileSystemProvider

Throws:

IOException

readAttributes

public Map<String,Object> readAttributes(Path path,
                                               String attributes,
                                               LinkOption... options)
                                        throws IOException

Specified by:

readAttributes in class FileSystemProvider

Throws:

IOException

readAttributes

public Map<String,Object> readAttributes(Path path,
                                               String view,
                                               String attrs,
                                               LinkOption... options)
                                        throws IOException

Throws:

IOException

readCustomViewAttributes

protected Map<String,Object> readCustomViewAttributes(SftpPath path,
                                                            String view,
                                                            String attrs,
                                                            LinkOption... options)
                                                     throws IOException

Throws:

IOException

readAclViewAttributes

protected NavigableMap<String,Object> readAclViewAttributes(SftpPath path,
                                                                  String view,
                                                                  String attrs,
                                                                  LinkOption... options)
                                                           throws IOException

Throws:

IOException

readRemoteAttributes

public SftpClient.Attributes readRemoteAttributes(SftpPath path,
                                                  LinkOption... options)
                                           throws IOException

Throws:

IOException

resolveRemoteFileAttributes

protected SftpClient.Attributes resolveRemoteFileAttributes(SftpPath path,
                                                            LinkOption... options)
                                                     throws IOException

Throws:

IOException

readPosixViewAttributes

protected NavigableMap<String,Object> readPosixViewAttributes(SftpPath path,
                                                                    String view,
                                                                    String attrs,
                                                                    LinkOption... options)
                                                             throws IOException

Throws:

IOException

setAttribute

public void setAttribute(Path path,
                         String attribute,
                         Object value,
                         LinkOption... options)
                  throws IOException

Specified by:

setAttribute in class FileSystemProvider

Throws:

IOException

setAttribute

public void setAttribute(Path path,
                         String view,
                         String attr,
                         Object value,
                         LinkOption... options)
                  throws IOException

Throws:

IOException

toSftpPath

public SftpPath toSftpPath(Path path)

attributesToPermissions

protected int attributesToPermissions(Path path,
                                      Collection<PosixFilePermission> perms)

getRWXPermissions

public static String getRWXPermissions(int perms)

getOctalPermissions

public static String getOctalPermissions(int perms)

permissionsToAttributes

public static Set<PosixFilePermission> permissionsToAttributes(int perms)

getOctalPermissions

public static String getOctalPermissions(Collection<PosixFilePermission> perms)

getFileSystemIdentifier

public static String getFileSystemIdentifier(URI uri)

Uses the host, port and username to create a unique identifier

Parameters:

uri - The URI - Note: not checked to make sure that the scheme is sftp://

Returns:

The unique identifier

See Also:

getFileSystemIdentifier(String, int, String)

getFileSystemIdentifier

public static String getFileSystemIdentifier(ClientSession session)

Uses the remote host address, port and current username to create a unique identifier

Parameters:

session - The ClientSession

Returns:

The unique identifier

See Also:

getFileSystemIdentifier(String, int, String)

getFileSystemIdentifier

public static String getFileSystemIdentifier(String host,
                                             int port,
                                             String username)

createFileSystemURI

public static URI createFileSystemURI(String host,
                                      int port,
                                      String username,
                                      String password)

createFileSystemURI

public static URI createFileSystemURI(String host,
                                      int port,
                                      String username,
                                      String password,
                                      Map<String,?> params)

encodeCredentials

public static String encodeCredentials(String username,
                                       String password)