org.apache.sshd.client.subsystem.sftp

Class SftpFileSystemProvider

java.lang.Object

java.nio.file.spi.FileSystemProvider

org.apache.sshd.client.subsystem.sftp.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 and Description
static String	AUTH_TIME_PROP_NAME
static String	CONNECT_TIME_PROP_NAME
static long	DEFAULT_AUTH_TIME
static long	DEFAULT_CONNECT_TIME
static int	DEFAULT_READ_BUFFER_SIZE
static int	DEFAULT_WRITE_BUFFER_SIZE
protected org.slf4j.Logger	log
static String	READ_BUFFER_PROP_NAME
static Set<Class<? extends FileAttributeView>>	UNIVERSAL_SUPPORTED_VIEWS
static String	VERSION_PARAM URI parameter that can be used to specify a special version selection.
static String	WRITE_BUFFER_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
SftpFileSystemProvider()
SftpFileSystemProvider(SftpVersionSelector selector)
SftpFileSystemProvider(SshClient client)
SftpFileSystemProvider(SshClient client, SftpVersionSelector selector)

Method Summary

Modifier and Type	Method and 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)
<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(ClientSession session) Uses the remote host address, port and current username to create a unique identifier
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	getOctalPermissions(Collection<PosixFilePermission> perms)
static String	getOctalPermissions(int perms)
Path	getPath(URI uri)
static String	getRWXPermissions(int perms)
String	getScheme()
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(ClientSession session)
SftpFileSystem	newFileSystem(URI uri, Map<String,?> env)
static Map<String,Object>	parseURIParameters(String params)
static Map<String,Object>	parseURIParameters(URI uri)
static Set<PosixFilePermission>	permissionsToAttributes(int perms)
protected Map<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 attributes, LinkOption... options)
Map<String,Object>	readAttributes(Path path, String view, String attrs, LinkOption... options)
protected Map<String,Object>	readCustomViewAttributes(SftpPath path, String view, String attrs, LinkOption... options)
protected Map<String,Object>	readPosixViewAttributes(SftpPath path, String view, String attrs, LinkOption... options)
protected 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 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)
SftpPath	toSftpPath(Path path)

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

createLink, deleteIfExists, installedProviders, newAsynchronousFileChannel, newFileSystem, newInputStream, newOutputStream

Methods inherited from class java.lang.Object

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

Field Detail

READ_BUFFER_PROP_NAME

public static final String READ_BUFFER_PROP_NAME

See Also:

Constant Field Values

DEFAULT_READ_BUFFER_SIZE

public static final int DEFAULT_READ_BUFFER_SIZE

See Also:

Constant Field Values

WRITE_BUFFER_PROP_NAME

public static final String WRITE_BUFFER_PROP_NAME

See Also:

Constant Field Values

DEFAULT_WRITE_BUFFER_SIZE

public static final int DEFAULT_WRITE_BUFFER_SIZE

See Also:

Constant Field Values

CONNECT_TIME_PROP_NAME

public static final String CONNECT_TIME_PROP_NAME

See Also:

Constant Field Values

DEFAULT_CONNECT_TIME

public static final long DEFAULT_CONNECT_TIME

AUTH_TIME_PROP_NAME

public static final String AUTH_TIME_PROP_NAME

See Also:

Constant Field Values

DEFAULT_AUTH_TIME

public static final long DEFAULT_AUTH_TIME

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)

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

See Also:

SshClient.setUpDefaultClient()

SftpFileSystemProvider

public SftpFileSystemProvider(SshClient client,
                              SftpVersionSelector selector)

Method Detail

getScheme

public String getScheme()

Specified by:

getScheme in class FileSystemProvider

getSftpVersionSelector

public final SftpVersionSelector getSftpVersionSelector()

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)

resolveFileSystemParameters

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

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

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 Map<String,Object> readAclViewAttributes(SftpPath path,
                                                   String view,
                                                   String attrs,
                                                   LinkOption... options)
                                            throws IOException

Throws:

IOException

readRemoteAttributes

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

Throws:

IOException

readPosixViewAttributes

protected Map<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)