Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.fs.SftpFileSystemProvider

Modifier and Type	Class and Description
private class	SftpFileSystemProvider.SessionProvider A session provider that automatically creates a new session if the current one is no longer open (or if there isn't one yet).

Modifier and Type	Field and Description
private final SshClient	clientInstance
private final SftpErrorDataHandler	errorDataHandler
private final SftpClientFactory	factory
private final NavigableMap<String, SftpFileSystem>	fileSystems
private SftpFileSystemClientSessionInitializer	fsSessionInitializer
protected final Logger	log
public static final Set<Class<? extends FileAttributeView>>	UNIVERSAL_SUPPORTED_VIEWS
public static final String	VERSION_PARAM URI parameter that can be used to specify a special version selection.
private final SftpVersionSelector	versionSelector

Access	Constructor and Description
public	SftpFileSystemProvider()
public	SftpFileSystemProvider(SftpVersionSelector selector)
public	SftpFileSystemProvider(SshClient client)
public	SftpFileSystemProvider(SshClient client, SftpVersionSelector selector)
public	SftpFileSystemProvider(SshClient client, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
public	SftpFileSystemProvider(SshClient client, SftpClientFactory factory, SftpVersionSelector selector)
public	SftpFileSystemProvider(SshClient 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 client, SftpClientFactory The `SftpClientFactory` to use to generate SFTP client instances factory, SftpVersionSelector The `SftpVersionSelector` to use in order to negotiate the SFTP version selector, SftpErrorDataHandler The `SftpErrorDataHandler` to handle incoming data through the error stream - if `null` the data is silently ignored errorDataHandler)

Method Summary

Modifier and Type	Method and Description
protected int	attributesToPermissions(Path path, Collection<PosixFilePermission> perms)
public void	checkAccess(Path the path to the file to check path, AccessMode... The access modes to check; may have zero elements modes) Implements abstract java.nio.file.spi.FileSystemProvider.checkAccess. Checks the existence, and optionally the accessibility, of a file.
public void	copy(Path the path to the file to copy source, Path the path to the target file target, CopyOption... options specifying how the copy should be done options) Implements abstract java.nio.file.spi.FileSystemProvider.copy. Copy a file to a target file.
public void	createDirectory(Path the directory to create dir, FileAttribute<?>... an optional list of file attributes to set atomically when creating the directory attrs) Implements abstract java.nio.file.spi.FileSystemProvider.createDirectory. Creates a new directory.
public static URI	createFileSystemURI(String host, int port, String username, String password)
public static URI	createFileSystemURI(String host, int port, String username, String password, Map<String, ?> params)
public void	createSymbolicLink(Path the path of the symbolic link to create link, Path the target of the symbolic link target, FileAttribute<?>... the array of attributes to set atomically when creating the symbolic link attrs) Overrides java.nio.file.spi.FileSystemProvider.createSymbolicLink. Creates a symbolic link to a target.
public void	delete(Path the path to the file to delete path) Implements abstract java.nio.file.spi.FileSystemProvider.delete. Deletes a file.
public static String	encodeCredentials(String username, String password)
public final SshClient	getClientInstance()
public <V extends FileAttributeView> V	getFileAttributeView(Path the path to the file path, Class<V> the `Class` object corresponding to the file attribute view type, final LinkOption... options indicating how symbolic links are handled options) Implements abstract java.nio.file.spi.FileSystemProvider.getFileAttributeView. Returns a file attribute view of a given type.
public FileStore	getFileStore(Path the path to the file path) Implements abstract java.nio.file.spi.FileSystemProvider.getFileStore. Returns the `FileStore` representing the file store where a file is located.
public FileSystem	getFileSystem(URI URI reference uri) Implements abstract java.nio.file.spi.FileSystemProvider.getFileSystem. Returns an existing `FileSystem` created by this provider.
public SftpFileSystem	Returns: The cached `SftpFileSystem` - `null` if no match getFileSystem(String File system identifier - ignored if `null`/empty id)
public static String	Returns: The unique identifier getFileSystemIdentifier(URI The `URI` - Note: not checked to make sure that the scheme is `sftp://` uri) Uses the host, port and username to create a unique identifier
public static String	Returns: The unique identifier getFileSystemIdentifier(ClientSession The `ClientSession` session) Uses the remote host address, port and current username to create a unique identifier
public static String	getFileSystemIdentifier(String host, int port, String username)
public static String	getOctalPermissions(int perms)
public static String	getOctalPermissions(Collection<PosixFilePermission> perms)
public Path	getPath(URI The URI to convert uri) Implements abstract java.nio.file.spi.FileSystemProvider.getPath. Return a `Path` object by converting the given `URI`.
public static String	getRWXPermissions(int perms)
public String	getScheme() Implements abstract java.nio.file.spi.FileSystemProvider.getScheme. Returns the URI scheme that identifies this provider.
public SftpClientFactory	getSftpClientFactory()
public SftpErrorDataHandler	getSftpErrorDataHandler()
public SftpFileSystemClientSessionInitializer	getSftpFileSystemClientSessionInitializer()
public final SftpVersionSelector	getSftpVersionSelector()
public boolean	isHidden(Path the path to the file to test path) Implements abstract java.nio.file.spi.FileSystemProvider.isHidden. Tells whether or not a file is considered hidden.
public boolean	isSameFile(Path one path to the file path1, Path the other path path2) Implements abstract java.nio.file.spi.FileSystemProvider.isSameFile. Tests if two paths locate the same file.
public boolean	isSupportedFileAttributeView(Path path, Class<? extends FileAttributeView> type)
public boolean	isSupportedFileAttributeView(SftpFileSystem fs, Class<? extends FileAttributeView> type)
public void	move(Path the path to the file to move source, Path the path to the target file target, CopyOption... options specifying how the move should be done options) Implements abstract java.nio.file.spi.FileSystemProvider.move. Move or rename a file to a target file.
public FileChannel	newByteChannel(Path the path to the file to open or create path, Set<? extends OpenOption> options specifying how the file is opened options, FileAttribute<?>... an optional list of file attributes to set atomically when creating the file attrs) Implements abstract java.nio.file.spi.FileSystemProvider.newByteChannel. Opens or creates a file, returning a seekable byte channel to access the file.
public DirectoryStream<Path>	newDirectoryStream(Path the path to the directory dir, DirectoryStream.Filter<? super Path> the directory stream filter filter) Implements abstract java.nio.file.spi.FileSystemProvider.newDirectoryStream. Opens a directory, returning a `DirectoryStream` to iterate over the entries in the directory.
public FileChannel	newFileChannel(Path the path of the file to open or create path, Set<? extends OpenOption> options specifying how the file is opened options, FileAttribute<?>... an optional list of file attributes to set atomically when creating the file attrs) Overrides java.nio.file.spi.FileSystemProvider.newFileChannel. Opens or creates a file for reading and/or writing, returning a file channel to access the file.
public SftpFileSystem	newFileSystem(URI URI reference uri, Map<String, ?> A map of provider specific properties to configure the file system; may be empty env) Implements abstract java.nio.file.spi.FileSystemProvider.newFileSystem. Constructs a new `FileSystem` object identified by a URI.
public SftpFileSystem	newFileSystem(ClientSession session)
public InputStream	newInputStream(Path the path to the file to open path, OpenOption... options specifying how the file is opened options) Overrides java.nio.file.spi.FileSystemProvider.newInputStream. Opens a file, returning an input stream to read from the file.
public OutputStream	newOutputStream(Path the path to the file to open or create path, OpenOption... options specifying how the file is opened options) Overrides java.nio.file.spi.FileSystemProvider.newOutputStream. Opens or creates a file, returning an output stream that may be used to write bytes to the file.
public static MutableBasicCredentials	Returns: The parsed credentials - `null` if none available parseCredentials(URI The `URI` value - ignored if `null` or does not contain any `user info`. uri) Attempts to parse the user information from the URI
public static MutableBasicCredentials	parseCredentials(String userInfo)
public static Map<String, Object>	parseURIParameters(URI uri)
public static Map<String, Object>	parseURIParameters(String params)
public static Set<PosixFilePermission>	permissionsToAttributes(int perms)
protected NavigableMap<String, Object>	readAclViewAttributes(SftpPath path, String view, String attrs, LinkOption... options)
public <A extends BasicFileAttributes> A	readAttributes(Path the path to the file path, Class<A> the `Class` of the file attributes required to read type, LinkOption... options indicating how symbolic links are handled options) Implements abstract java.nio.file.spi.FileSystemProvider.readAttributes. Reads a file's attributes as a bulk operation.
public Map<String, Object>	readAttributes(Path the path to the file path, String the attributes to read attributes, LinkOption... options indicating how symbolic links are handled options) Implements abstract java.nio.file.spi.FileSystemProvider.readAttributes. Reads a set of file attributes as a bulk operation.
public 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 NavigableMap<String, Object>	readPosixViewAttributes(SftpPath path, String view, String attrs, LinkOption... options)
public SftpClient.Attributes	readRemoteAttributes(SftpPath path, LinkOption... options)
public Path	readSymbolicLink(Path the path to the symbolic link link) Overrides java.nio.file.spi.FileSystemProvider.readSymbolicLink. Reads the target of a symbolic link.
public SftpFileSystem	Returns: The removed `SftpFileSystem` - `null` if no match removeFileSystem(String File system identifier - ignored if `null`/empty id)
public 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)
public void	setAttribute(Path the path to the file path, String the attribute to set attribute, Object the attribute value value, LinkOption... options indicating how symbolic links are handled options) Implements abstract java.nio.file.spi.FileSystemProvider.setAttribute. Sets the value of a file attribute.
public void	setAttribute(Path path, String view, String attr, Object value, LinkOption... options)
public void	setSftpFileSystemClientSessionInitializer(SftpFileSystemClientSessionInitializer initializer)
public SftpPath	toSftpPath(Path path)

Inherited from java.nio.file.spi.FileSystemProvider:: createLink deleteIfExists exists installedProviders newAsynchronousFileChannel newFileSystem readAttributesIfExists

public Class SftpFileSystemProvider

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary