JGitFileSystemProvider (UberFire NIO.2 :: JGIT Impl 2.5.0.Final API)

java.lang.Object
- org.uberfire.java.nio.fs.jgit.JGitFileSystemProvider

All Implemented Interfaces:: org.uberfire.commons.lifecycle.Disposable, FileSystemProvider, SecuredFileSystemProvider

public class JGitFileSystemProvider
extends Object
implements SecuredFileSystemProvider, org.uberfire.commons.lifecycle.Disposable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class JGitFileSystemProvider.RepositoryResolverImpl<T>

Nested Classes
Modifier and Type	Class and Description
`class`	`JGitFileSystemProvider.RepositoryResolverImpl<T>`

Constructor Summary

Constructors
Constructor and Description
`JGitFileSystemProvider()` Creates a JGit filesystem provider which takes its configuration from system properties.
`JGitFileSystemProvider(org.uberfire.commons.config.ConfigProperties gitPrefs, ExecutorService executorService)` Creates a JGit filesystem provider which takes its configuration from the given ConfigProperties instance.
`JGitFileSystemProvider(Map<String,String> gitPrefs)` Creates a JGit filesystem provider which takes its configuration from the given map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkAccess(Path path, AccessMode... modes)`
`void`	`copy(Path source, Path target, CopyOption... options)`
`void`	`createDirectory(Path path, FileAttribute<?>... attrs)`
`void`	`createLink(Path link, Path existing)`
`void`	`createSymbolicLink(Path link, Path target, FileAttribute<?>... attrs)`
`void`	`delete(Path path, DeleteOption... options)`
`void`	`deleteAsset(JGitPathImpl path, DeleteOption... options)`
`boolean`	`deleteAssetIfExists(JGitPathImpl path, DeleteOption... options)`
`void`	`deleteBranch(JGitPathImpl path)`
`boolean`	`deleteBranchIfExists(JGitPathImpl path)`
`boolean`	`deleteIfExists(Path path, DeleteOption... options)`
`void`	`dispose()`
`protected boolean`	`exists(Path path)`
`String`	`extractHostForPath(URI uri)`
`String`	`extractPath(URI uri)`
`void`	`forceAsDefault()`
`<V extends FileAttributeView> V`	`getFileAttributeView(Path path, Class<V> type, LinkOption... options)`
`FileStore`	`getFileStore(Path path)`
`FileSystem`	`getFileSystem(URI uri)`
`JGitFileSystemsManager`	`getFsManager()`
`File`	`getGitRepoContainerDir()` Returns the directory that contains all the git repositories managed by this file system provider.
`Path`	`getPath(URI uri)`
`String`	`getScheme()`
`boolean`	`isDefault()`
`boolean`	`isHidden(Path path)`
`boolean`	`isSameFile(Path pathA, Path pathB)`
`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 path, DirectoryStream.Filter<Path> pfilter)`
`FileChannel`	`newFileChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs)`
`FileSystem`	`newFileSystem(Path path, Map<String,?> env)`
`FileSystem`	`newFileSystem(URI uri, Map<String,?> env)`
`InputStream`	`newInputStream(Path path, OpenOption... options)`
`OutputStream`	`newOutputStream(Path path, OpenOption... options)`
`void`	`onCloseFileSystem(JGitFileSystem fileSystem)`
`void`	`onDisposeFileSystem(JGitFileSystem fileSystem)`
`<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)`
`void`	`setAttribute(Path path, String attribute, Object value, LinkOption... options)`
`void`	`setAuthenticator(FileSystemAuthenticator authenticator)`
`void`	`setAuthorizer(FileSystemAuthorizer authorizer)`
`void`	`setDetectedFS(org.eclipse.jgit.util.FS detectedFS)`
`void`	`shutdown()` Closes and disposes all open filesystems and stops the Git and SSH daemons if they are running.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- JGitFileSystemProvider
```
public JGitFileSystemProvider()
```
  Creates a JGit filesystem provider which takes its configuration from system properties. In a normal production deployment of UberFire, this is the constructor that will be invoked by the ServiceLoader mechanism. For a list of properties that affect the configuration of JGitFileSystemProvider, see the DEBUG log output of this class during startup.
- JGitFileSystemProvider
```
public JGitFileSystemProvider(Map<String,String> gitPrefs)
```
  Creates a JGit filesystem provider which takes its configuration from the given map. For a list of properties that affect the configuration of JGitFileSystemProvider, see the DEBUG log output of this class during startup.
- JGitFileSystemProvider
```
public JGitFileSystemProvider(org.uberfire.commons.config.ConfigProperties gitPrefs,
                              ExecutorService executorService)
```
  Creates a JGit filesystem provider which takes its configuration from the given ConfigProperties instance. For a list of properties that affect the configuration of JGitFileSystemProvider, see the DEBUG log output of this class during startup.

Method Detail

onCloseFileSystem

public void onCloseFileSystem(JGitFileSystem fileSystem)

onDisposeFileSystem

public void onDisposeFileSystem(JGitFileSystem fileSystem)

setAuthenticator
```
public void setAuthenticator(FileSystemAuthenticator authenticator)
```
Specified by:

setAuthenticator in interface SecuredFileSystemProvider

setAuthorizer
```
public void setAuthorizer(FileSystemAuthorizer authorizer)
```
Specified by:

setAuthorizer in interface SecuredFileSystemProvider

dispose
```
public void dispose()
```
Specified by:

dispose in interface org.uberfire.commons.lifecycle.Disposable

shutdown
```
public void shutdown()
```
Closes and disposes all open filesystems and stops the Git and SSH daemons if they are running. This filesystem provider can be reactivated by attempting to open a new filesystem or by creating a new filesystem.

getGitRepoContainerDir
```
public File getGitRepoContainerDir()
```
Returns the directory that contains all the git repositories managed by this file system provider.

forceAsDefault
```
public void forceAsDefault()
```
Specified by:

forceAsDefault in interface FileSystemProvider

isDefault
```
public boolean isDefault()
```
Specified by:

isDefault in interface FileSystemProvider

getScheme
```
public String getScheme()
```
Specified by:

getScheme in interface FileSystemProvider

newFileSystem

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

Specified by:: newFileSystem in interface FileSystemProvider
Throws:: IllegalArgumentException; UnsupportedOperationException; IOException; SecurityException

newFileSystem

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

Specified by:: newFileSystem in interface FileSystemProvider
Throws:: IllegalArgumentException; IOException; SecurityException; FileSystemAlreadyExistsException

getFileSystem

public FileSystem getFileSystem(URI uri)
                         throws IllegalArgumentException,
                                FileSystemNotFoundException,
                                SecurityException

Specified by:: getFileSystem in interface FileSystemProvider
Throws:: IllegalArgumentException; FileSystemNotFoundException; SecurityException

getPath

public Path getPath(URI uri)
             throws IllegalArgumentException,
                    FileSystemNotFoundException,
                    SecurityException

Specified by:: getPath in interface FileSystemProvider
Throws:: IllegalArgumentException; FileSystemNotFoundException; SecurityException

extractPath
```
public String extractPath(URI uri)
```

newInputStream

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

Specified by:: newInputStream in interface FileSystemProvider
Throws:: IllegalArgumentException; UnsupportedOperationException; IOException; SecurityException

newOutputStream

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

Specified by:: newOutputStream in interface FileSystemProvider
Throws:: IllegalArgumentException; UnsupportedOperationException; IOException; SecurityException

newFileChannel

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

Specified by:: newFileChannel in interface FileSystemProvider
Throws:: IllegalArgumentException; UnsupportedOperationException; IOException; SecurityException

newAsynchronousFileChannel

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

Specified by:: newAsynchronousFileChannel in interface FileSystemProvider
Throws:: IllegalArgumentException; UnsupportedOperationException; IOException; SecurityException

newByteChannel

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

Specified by:: newByteChannel in interface FileSystemProvider
Throws:: IllegalArgumentException; UnsupportedOperationException; IOException; SecurityException

exists
```
protected boolean exists(Path path)
```

newDirectoryStream

public DirectoryStream<Path> newDirectoryStream(Path path,
                                                DirectoryStream.Filter<Path> pfilter)
                                         throws IOException,
                                                SecurityException

Specified by:: newDirectoryStream in interface FileSystemProvider
Throws:: IOException; SecurityException

createDirectory

public void createDirectory(Path path,
                            FileAttribute<?>... attrs)
                     throws UnsupportedOperationException,
                            IOException,
                            SecurityException

Specified by:: createDirectory in interface FileSystemProvider
Throws:: UnsupportedOperationException; IOException; SecurityException

createSymbolicLink

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

Specified by:: createSymbolicLink in interface FileSystemProvider
Throws:: UnsupportedOperationException; IOException; SecurityException

createLink

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

Specified by:: createLink in interface FileSystemProvider
Throws:: UnsupportedOperationException; IOException; SecurityException

delete

public void delete(Path path,
                   DeleteOption... options)
            throws IOException,
                   SecurityException

Specified by:: delete in interface FileSystemProvider
Throws:: IOException; SecurityException

deleteAsset

public void deleteAsset(JGitPathImpl path,
                        DeleteOption... options)

deleteBranch

public void deleteBranch(JGitPathImpl path)

deleteIfExists

public boolean deleteIfExists(Path path,
                              DeleteOption... options)
                       throws IOException,
                              SecurityException

Specified by:: deleteIfExists in interface FileSystemProvider
Throws:: IOException; SecurityException

deleteBranchIfExists

public boolean deleteBranchIfExists(JGitPathImpl path)

deleteAssetIfExists

public boolean deleteAssetIfExists(JGitPathImpl path,
                                   DeleteOption... options)

readSymbolicLink

public Path readSymbolicLink(Path link)
                      throws UnsupportedOperationException,
                             IOException,
                             SecurityException

Specified by:: readSymbolicLink in interface FileSystemProvider
Throws:: UnsupportedOperationException; IOException; SecurityException

copy

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

Specified by:: copy in interface FileSystemProvider
Throws:: UnsupportedOperationException; IOException; SecurityException

move

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

Specified by:: move in interface FileSystemProvider
Throws:: DirectoryNotEmptyException; AtomicMoveNotSupportedException; IOException; SecurityException

isSameFile

public boolean isSameFile(Path pathA,
                          Path pathB)
                   throws IOException,
                          SecurityException

Specified by:: isSameFile in interface FileSystemProvider
Throws:: IOException; SecurityException

isHidden

public boolean isHidden(Path path)
                 throws IllegalArgumentException,
                        IOException,
                        SecurityException

Specified by:: isHidden in interface FileSystemProvider
Throws:: IllegalArgumentException; IOException; SecurityException

getFileStore

public FileStore getFileStore(Path path)
                       throws IOException,
                              SecurityException

Specified by:: getFileStore in interface FileSystemProvider
Throws:: IOException; SecurityException

checkAccess

public void checkAccess(Path path,
                        AccessMode... modes)
                 throws UnsupportedOperationException,
                        NoSuchFileException,
                        AccessDeniedException,
                        IOException,
                        SecurityException

Specified by:: checkAccess in interface FileSystemProvider
Throws:: UnsupportedOperationException; NoSuchFileException; AccessDeniedException; IOException; SecurityException

getFileAttributeView

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

Specified by:: getFileAttributeView in interface FileSystemProvider
Throws:: NoSuchFileException

readAttributes

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

Specified by:: readAttributes in interface FileSystemProvider
Throws:: NoSuchFileException; UnsupportedOperationException; IOException; SecurityException

readAttributes

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

Specified by:: readAttributes in interface FileSystemProvider
Throws:: UnsupportedOperationException; IllegalArgumentException; IOException; SecurityException

setAttribute

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

Specified by:: setAttribute in interface FileSystemProvider
Throws:: UnsupportedOperationException; IllegalArgumentException; ClassCastException; IOException; SecurityException

extractHostForPath

public String extractHostForPath(URI uri)

setDetectedFS

public void setDetectedFS(org.eclipse.jgit.util.FS detectedFS)

getFsManager

public JGitFileSystemsManager getFsManager()

Class JGitFileSystemProvider

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JGitFileSystemProvider

JGitFileSystemProvider

JGitFileSystemProvider

Method Detail

onCloseFileSystem

onDisposeFileSystem

setAuthenticator

setAuthorizer

dispose

shutdown

getGitRepoContainerDir

forceAsDefault

isDefault

getScheme

newFileSystem

newFileSystem

getFileSystem

getPath

extractPath

newInputStream

newOutputStream

newFileChannel

newAsynchronousFileChannel

newByteChannel

exists

newDirectoryStream

createDirectory

createSymbolicLink

createLink

delete

deleteAsset

deleteBranch

deleteIfExists

deleteBranchIfExists

deleteAssetIfExists

readSymbolicLink

copy

move

isSameFile

isHidden

getFileStore

checkAccess

getFileAttributeView

readAttributes

readAttributes

setAttribute

extractHostForPath

setDetectedFS

getFsManager