ch.pontius.nio.smb

Class SMBFileSystem

java.lang.Object

java.nio.file.FileSystem

ch.pontius.nio.smb.SMBFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable

public final class SMBFileSystem
extends FileSystem

This class represents a single SMB server (filesystem). The authority part of the SMB URI creates a unique SMBFileSystem, that is, if you connect to the same server with different credentials, it will results in two distinc SMBFileSystem instances. Furthermore, different names for the same server will result in different SMBFileSystem instances too. The SMBFileSystem is the factory for several types of objects, like SMBPath, SMBFileStore etc.

Since:

1.0

Version:

1.1

Author:

Ralph Gasser

Method Summary

Modifier and Type	Method and Description
void	close() Removes the current instance of SMBFileSystem from the SMBFileSystemProvider's cache.
Iterable<FileStore>	getFileStores() Returns the SMBFileStores, i.e.
Path	getPath(String first, String... more) Constructs a new SMBPath by concatenating the provided path components.
PathMatcher	getPathMatcher(String syntaxAndPattern) Returns a new SMBPathMatcher for the provided pattern.
Iterable<Path>	getRootDirectories() Returns the root directories, i.e.
String	getSeparator() Returns the default path sepeator, which is "/".
UserPrincipalLookupService	getUserPrincipalLookupService() UserPrincipalLookupService are not supported by the current version of SMBFileSystem.
boolean	isOpen() Returns true, if the current SMBFileSystem is still known to the SMBFileSystemProvider.
boolean	isReadOnly() Returns false because generally, SMBFileSystem's are not considered to be read-only.
WatchService	newWatchService() WatchService are not supported by the current version of SMBFileSystem.
FileSystemProvider	provider() Returns instance of SMBFileSystemProvider this SMBFileSystem belongs to.
Set<String>	supportedFileAttributeViews() Returns a containing the names of the supported FileAttributeViews

Methods inherited from class java.lang.Object

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

Method Detail

provider

public FileSystemProvider provider()

Returns instance of SMBFileSystemProvider this SMBFileSystem belongs to.

Specified by:

provider in class FileSystem

Returns:

SMBFileSystemProvider

close

public void close()

Removes the current instance of SMBFileSystem from the SMBFileSystemProvider's cache. Calling this method will not actually close any underlying resource. However, existing paths pointing to the current instance of SMBFileSystem will not be handled to the

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class FileSystem

isOpen

public boolean isOpen()

Returns true, if the current SMBFileSystem is still known to the SMBFileSystemProvider.

Specified by:

isOpen in class FileSystem

Returns:

If current SMBFileSystem is still open.

isReadOnly

public boolean isReadOnly()

Returns false because generally, SMBFileSystem's are not considered to be read-only. However, the concrete access permissions are specific to a file or resource.

Specified by:

isReadOnly in class FileSystem

Returns:

false

getSeparator

public String getSeparator()

Returns the default path sepeator, which is "/".

Specified by:

getSeparator in class FileSystem

Returns:

"/"

getRootDirectories

public Iterable<Path> getRootDirectories()

Returns the root directories, i.e. the list of shares, provided by the current SMBFileSystem.

Specified by:

getRootDirectories in class FileSystem

Returns:

List of shares for the current SMBFileSystem.

getFileStores

public Iterable<FileStore> getFileStores()

Returns the SMBFileStores, i.e. the list of shares, provided by the current SMBFileSystem.

Specified by:

getFileStores in class FileSystem

Returns:

List of SMBFileStores for the current SMBFileSystem.

supportedFileAttributeViews

public Set<String> supportedFileAttributeViews()

Returns a containing the names of the supported FileAttributeViews

Specified by:

supportedFileAttributeViews in class FileSystem

Returns:

Set with the names of the supported FileAttributeViews.

getPath

public Path getPath(String first,
                    String... more)

Constructs a new SMBPath by concatenating the provided path components. If the first path starts with a '/' the newly constructed path will be an absolute path. If the last component ends with a '/' the path is treated as a folder.

Specified by:

getPath in class FileSystem

Parameters:

first - First path component.

more - List of additional path components.

Returns:

Constructed SMBPath.

getPathMatcher

public PathMatcher getPathMatcher(String syntaxAndPattern)

Returns a new SMBPathMatcher for the provided pattern.

Specified by:

getPathMatcher in class FileSystem

Parameters:

syntaxAndPattern - The syntax or pattern that should be used to match paths against.

Returns:

SMBPathMatcher

getUserPrincipalLookupService

public UserPrincipalLookupService getUserPrincipalLookupService()

UserPrincipalLookupService are not supported by the current version of SMBFileSystem.

Specified by:

getUserPrincipalLookupService in class FileSystem

Throws:

UnsupportedOperationException - Always

newWatchService

public WatchService newWatchService()
                             throws IOException

WatchService are not supported by the current version of SMBFileSystem.

Specified by:

newWatchService in class FileSystem

Throws:

UnsupportedOperationException - Always

IOException