Package org.apache.sshd.common.file.root

Class RootedFileSystemProvider

java.lang.Object

java.nio.file.spi.FileSystemProvider

org.apache.sshd.common.file.root.RootedFileSystemProvider

public class RootedFileSystemProvider
extends FileSystemProvider

File system provider which provides a rooted file system. The file system only gives access to files under the root directory.

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
RootedFileSystemProvider()

Method Summary

Modifier and Type	Method	Description
void	checkAccess(Path path, AccessMode... modes)
void	copy(Path source, Path target, CopyOption... options)
void	createDirectory(Path dir, FileAttribute<?>... attrs)
void	createLink(Path link, Path existing)
protected void	createLink(Path link, Path target, boolean symLink, FileAttribute<?>... attrs)
void	createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)
void	delete(Path path)
boolean	deleteIfExists(Path path)
<V extends FileAttributeView> V	getFileAttributeView(Path path, Class<V> type, LinkOption... options)
FileStore	getFileStore(Path path)
FileSystem	getFileSystem(URI uri)
protected RootedFileSystem	getFileSystem(Path path)
Path	getPath(URI uri)
String	getScheme()
boolean	isHidden(Path path)
boolean	isSameFile(Path path, Path path2)
void	move(Path source, Path target, CopyOption... options)
AsynchronousFileChannel	newAsynchronousFileChannel(Path path, Set<? extends OpenOption> options, ExecutorService executor, FileAttribute<?>... attrs)
SeekableByteChannel	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)
protected FileSystem	newFileSystem(Object src, Path path, Map<String,?> env)
FileSystem	newFileSystem(URI uri, Map<String,?> env)
FileSystem	newFileSystem(Path path, Map<String,?> env)
InputStream	newInputStream(Path path, OpenOption... options)
OutputStream	newOutputStream(Path path, OpenOption... options)
protected FileSystemProvider	provider(Path path)
<A extends BasicFileAttributes> A	readAttributes(Path path, Class<A> type, LinkOption... options)
Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options)
Path	readSymbolicLink(Path link)
protected Path	resolveLocalPath(RootedPath path)
protected DirectoryStream<Path>	root(RootedFileSystem rfs, DirectoryStream<Path> ds)
protected Path	root(RootedFileSystem rfs, Path nat)
protected Iterator<Path>	root(RootedFileSystem rfs, Iterator<Path> iter)
void	setAttribute(Path path, String attribute, Object value, LinkOption... options)
protected Path	unroot(Path path)
protected Path	uriToPath(URI uri)

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

installedProviders

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

RootedFileSystemProvider

public RootedFileSystemProvider()

Method Detail

getScheme

public String getScheme()

Specified by:

getScheme in class FileSystemProvider

newFileSystem

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

Specified by:

newFileSystem in class FileSystemProvider

Throws:

IOException

getFileSystem

public FileSystem getFileSystem(URI uri)

Specified by:

getFileSystem in class FileSystemProvider

newFileSystem

public FileSystem newFileSystem(Path path,
                                Map<String,?> env)
                         throws IOException

Overrides:

newFileSystem in class FileSystemProvider

Throws:

IOException

newFileSystem

protected FileSystem newFileSystem(Object src,
                                   Path path,
                                   Map<String,?> env)
                            throws IOException

Throws:

IOException

uriToPath

protected Path uriToPath(URI uri)

getPath

public Path getPath(URI uri)

Specified by:

getPath in class FileSystemProvider

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

newFileChannel

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

Overrides:

newFileChannel in class FileSystemProvider

Throws:

IOException

newAsynchronousFileChannel

public AsynchronousFileChannel newAsynchronousFileChannel(Path path,
                                                          Set<? extends OpenOption> options,
                                                          ExecutorService executor,
                                                          FileAttribute<?>... attrs)
                                                   throws IOException

Overrides:

newAsynchronousFileChannel in class FileSystemProvider

Throws:

IOException

newByteChannel

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

Specified by:

newByteChannel 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

root

protected DirectoryStream<Path> root(RootedFileSystem rfs,
                                     DirectoryStream<Path> ds)

root

protected Iterator<Path> root(RootedFileSystem rfs,
                              Iterator<Path> iter)

createDirectory

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

Specified by:

createDirectory in class FileSystemProvider

Throws:

IOException

createSymbolicLink

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

Overrides:

createSymbolicLink in class FileSystemProvider

Throws:

IOException

createLink

public void createLink(Path link,
                       Path existing)
                throws IOException

Overrides:

createLink in class FileSystemProvider

Throws:

IOException

createLink

protected void createLink(Path link,
                          Path target,
                          boolean symLink,
                          FileAttribute<?>... attrs)
                   throws IOException

Throws:

IOException

delete

public void delete(Path path)
            throws IOException

Specified by:

delete in class FileSystemProvider

Throws:

IOException

deleteIfExists

public boolean deleteIfExists(Path path)
                       throws IOException

Overrides:

deleteIfExists in class FileSystemProvider

Throws:

IOException

readSymbolicLink

public Path readSymbolicLink(Path link)
                      throws IOException

Overrides:

readSymbolicLink 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 path,
                          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

getFileSystem

protected RootedFileSystem getFileSystem(Path path)
                                  throws FileSystemNotFoundException

Throws:

FileSystemNotFoundException

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

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

setAttribute

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

Specified by:

setAttribute in class FileSystemProvider

Throws:

IOException

provider

protected FileSystemProvider provider(Path path)

root

protected Path root(RootedFileSystem rfs,
                    Path nat)

unroot

protected Path unroot(Path path)

Parameters:

path - The original (rooted) Path

Returns:

The actual absolute local Path represented by the rooted one

Throws:

IllegalArgumentException - if null path argument

ProviderMismatchException - if not a RootedPath

See Also:

resolveLocalPath(RootedPath)

resolveLocalPath

protected Path resolveLocalPath(RootedPath path)

Parameters:

path - The original RootedPath - never null

Returns:

The actual absolute local Path represented by the rooted one

Throws:

InvalidPathException - If the resolved path is not a proper sub-path of the rooted file system