org.das2.util.filesystem

Class GitLabFileSystem

java.lang.Object

org.das2.util.filesystem.FileSystem

org.das2.util.filesystem.WebFileSystem

org.das2.util.filesystem.GitLabFileSystem

public class GitLabFileSystem
extends WebFileSystem

GitLab-backed FileSystem for Das2. Intended URI forms: https://git.example.edu/group/subgroup/project/-/blob/main/path/to/file.txt https://git.example.edu/group/subgroup/project/-/tree/main/path/to/dir https://git.example.edu/group/subgroup/project Internal strategy: - parse the web URL into host + projectPath + optional ref + optional repoPath - if ref is missing, query project metadata and use default_branch - list directories with /api/v4/projects/:id/repository/tree - read files with /-/raw/{ref}/{path}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GitLabFileSystem.GitLabNode
protected static class	GitLabFileSystem.ParsedGitLabRoot

Nested classes/interfaces inherited from class org.das2.util.filesystem.FileSystem

FileSystem.DirectoryEntry, FileSystem.FileSystemOfflineException

Field Summary

Fields

Modifier and Type	Field and Description
protected GitLabFileSystem.ParsedGitLabRoot	parsedRoot

Fields inherited from class org.das2.util.filesystem.WebFileSystem

HTTP_CHECK_TIMESTAMP_LIMIT_MS, id, LISTING_TIMEOUT_MS, localRoot, logger, MEMORY_LISTING_TIMEOUT_MS, offline, offlineMessage, offlineResponseCode, PROP_OFFLINE, PROP_READ_ONLY_CACHE, protocol

Fields inherited from class org.das2.util.filesystem.FileSystem

loggerUrl, NULL, PROP_CASE_INSENSITIVE, properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GitLabFileSystem(java.net.URI rootUri)
protected	GitLabFileSystem(java.net.URI rootUri, java.io.File localRoot, java.lang.String branch, int baseOffset, java.lang.String token)

Method Summary

Modifier and Type	Method and Description
static GitLabFileSystem	createGitLabFileSystem(java.net.URI rootUri)
protected java.util.Map<java.lang.String,java.lang.String>	downloadFile(java.lang.String filename, java.io.File f, java.io.File partfile, ProgressMonitor monitor) Transfers the file from the remote store to a local copy f.
FileObject	getFileObject(java.lang.String filename) Return the handle for this file.
protected java.lang.String	getResolvedRef()
java.net.URI	getRootURI() Optional convenience.
long	getSize(java.lang.String filename) Optional convenience method if Das2 FileSystem has a method like this.
boolean	isDirectory(java.lang.String filename) return true if the name refers to a directory, not a file.
java.lang.String[]	listDirectory(java.lang.String directory) return the directory listing for the name.
protected java.lang.String	normalizeRepoPath(java.lang.String p)
protected java.net.HttpURLConnection	open(java.lang.String surl)
protected GitLabFileSystem.GitLabNode	stat(java.lang.String repoPath)
protected static java.lang.String	urlEncodePathSegmentwise(java.lang.String path) Encode each path segment but preserve slashes.

Methods inherited from class org.das2.util.filesystem.WebFileSystem

addPropertyChangeListener, addRoCacheEntries, cacheListing, consumeStream, copyStream, getDownloadDirectory, getDownloadLock, getLastAccessed, getLocalName, getLocalName, getLocalRoot, getLocalRootAbsPath, getOfflineMessage, getOfflineResponseCode, getPartFile, getProtocol, getReadOnlyCache, getRootURL, getURI, getURL, isAppletMode, isGitClone, isListingCached, isOffline, listDirectory, listDirectoryFromMemory, listingFile, localRoot, maybeUpdateDirectoryEntry, removePropertyChangeListener, resetListCache, resetListingCache, setAppletMode, setOffline, setReadOnlyCache, toString

Methods inherited from class org.das2.util.filesystem.FileSystem

create, create, create, create, create, create, createFileSystem, getExceptionHandler, getListing, getListing, getProperty, listDirectory, listDirectory, listDirectoryDeep, peek, peekInstances, recreate, recreate, registerFileSystemFactory, reset, reset, setExceptionHandler, settings, splitUrl, toCanonicalFilename, toCanonicalFolderName, toCanonicalFolderName, toCanonicalFolderNameString

Methods inherited from class java.lang.Object

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

Field Detail

parsedRoot

protected final GitLabFileSystem.ParsedGitLabRoot parsedRoot

Constructor Detail

GitLabFileSystem

protected GitLabFileSystem(java.net.URI rootUri)
                    throws java.io.IOException

Throws:

java.io.IOException

GitLabFileSystem

protected GitLabFileSystem(java.net.URI rootUri,
                           java.io.File localRoot,
                           java.lang.String branch,
                           int baseOffset,
                           java.lang.String token)
                    throws java.io.IOException

Throws:

java.io.IOException

Method Detail

createGitLabFileSystem

public static GitLabFileSystem createGitLabFileSystem(java.net.URI rootUri)
                                               throws java.io.IOException

Throws:

java.io.IOException

listDirectory

public java.lang.String[] listDirectory(java.lang.String directory)
                                 throws java.io.IOException

Description copied from class: WebFileSystem

return the directory listing for the name.

Specified by:

listDirectory in class WebFileSystem

Parameters:

directory - the directory name within the filesystem.

Returns:

list of files and folders within the filesystem.

Throws:

java.io.IOException

See Also:

for listings constrained by regular expressions.

isDirectory

public boolean isDirectory(java.lang.String filename)
                    throws java.io.IOException

Description copied from class: WebFileSystem

return true if the name refers to a directory, not a file.

Specified by:

isDirectory in class WebFileSystem

Parameters:

filename - the name

Returns:

true if the name is a directory.

Throws:

java.io.IOException

getSize

public long getSize(java.lang.String filename)
             throws java.io.IOException

Optional convenience method if Das2 FileSystem has a method like this.

Throws:

java.io.IOException

getRootURI

public java.net.URI getRootURI()

Optional convenience.

Overrides:

getRootURI in class FileSystem

Returns:

stat

protected GitLabFileSystem.GitLabNode stat(java.lang.String repoPath)
                                    throws java.io.IOException

Throws:

java.io.IOException

getResolvedRef

protected java.lang.String getResolvedRef()
                                   throws java.io.IOException

Throws:

java.io.IOException

open

protected java.net.HttpURLConnection open(java.lang.String surl)
                                   throws java.io.IOException

Throws:

java.io.IOException

normalizeRepoPath

protected java.lang.String normalizeRepoPath(java.lang.String p)

urlEncodePathSegmentwise

protected static java.lang.String urlEncodePathSegmentwise(java.lang.String path)
                                                    throws java.io.IOException

Encode each path segment but preserve slashes.

Throws:

java.io.IOException

getFileObject

public FileObject getFileObject(java.lang.String filename)

Description copied from class: WebFileSystem

Return the handle for this file. This is not the file itself, and accessing this object does not necessarily download the resource. This will be a container for file metadata, in addition to providing access to the data file itself.

Overrides:

getFileObject in class WebFileSystem

Parameters:

filename - the name of the file within the filesystem.

Returns:

a FileObject for the file

downloadFile

protected java.util.Map<java.lang.String,java.lang.String> downloadFile(java.lang.String filename,
                                                                        java.io.File f,
                                                                        java.io.File partfile,
                                                                        ProgressMonitor monitor)
                                                                 throws java.io.IOException

Description copied from class: WebFileSystem

Transfers the file from the remote store to a local copy f. This should only be used within the class and subclasses, clients should use getFileObject( String ).getFile(). Subclasses implementing this should download data to partfile, then rename partfile to f after the download is complete. Note, this is non-trivial, since several threads and even several processes may be using the same area at once. See HttpFileSystem's implementation of this before attempting to implement the function.

Specified by:

downloadFile in class WebFileSystem

Parameters:

filename - the name of the file, relative to the filesystem.

f - the file to where the file is downloaded.

partfile - the temporary file during download.

monitor - progress monitor

Returns:

metadata headers from the load, if any are available. See WebProtocol.

Throws:

java.io.IOException

See Also:

WebProtocol.getMetadata(org.das2.util.filesystem.WebFileObject)