Package convex.dlfs

Class DLFileSystem

java.lang.Object

java.nio.file.FileSystem

convex.dlfs.DLFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable

Direct Known Subclasses:

DLFSLocal

public abstract class DLFileSystem
extends FileSystem
implements Cloneable

Base class for Data Lattice FileSystems. A Data Lattice FileSystem has: - A single root directory - A method of snapshotting any path on the tree - An efficient method of cloning the Drive with an immutable snapshot

Field Summary

Fields

Modifier and Type	Field	Description
protected final DLPath	emptyPath
protected final DLFSProvider	provider
protected final DLPath	root
protected final String	uriPath

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DLFileSystem(DLFSProvider dlfsProvider, String uriPath, CVMLong timestamp)

Method Summary

Modifier and Type	Method	Description
protected abstract void	checkAccess(DLPath path)	Implementation for DLFSProvider delegation
abstract DLFileSystem	clone()
void	close()
protected abstract DLPath	createDirectory(DLPath dir, FileAttribute<?>[] attrs)	Implementation for delegation by DLFSProvider, create a directory
abstract AVector<ACell>	createFile(DLPath path)	Creates a file, returning the new node
abstract void	delete(DLPath dlp)
DLPath	getEmptyPath()	Gets an empty path for this FileSystem
DLFSFileAttributes	getFileAttributes(DLPath path)
Iterable<FileStore>	getFileStores()
abstract AVector<ACell>	getNode(DLPath path)	Gets DLFS node for the given path
Hash	getNodeHash(DLPath p)
DLPath	getPath(String first, String... more)
PathMatcher	getPathMatcher(String syntaxAndPattern)
DLPath	getRoot()	Gets the unique root path for this FileSystem
Iterable<Path>	getRootDirectories()
abstract Hash	getRootHash()
String	getSeparator()
final CVMLong	getTimestamp()	Gets the timestamp of this DLFS drive
UserPrincipalLookupService	getUserPrincipalLookupService()
boolean	isOpen()
boolean	isReadOnly()
abstract void	merge(AVector<ACell> other)	Merges another DLFS drive into this one
abstract SeekableByteChannel	newByteChannel(DLPath path, Set<? extends OpenOption> options, FileAttribute<?>[] attrs)	Implementation for delegation by DLFSProvider
abstract DLDirectoryStream	newDirectoryStream(DLPath dir, DirectoryStream.Filter<? super Path> filter)	Implementation for delegation by DLFSProvider
WatchService	newWatchService()
DLFSProvider	provider()
void	replicate(DLFileSystem other)
final void	setTimestamp(CVMLong newTimestamp)	Sets the timestamp of this DLFS drive
Set<String>	supportedFileAttributeViews()
abstract AVector<ACell>	updateNode(DLPath path, AVector<ACell> newNode)	Updates a node, returning the new node
CVMLong	updateTimestamp()	Updates the timestamp of the drive to the current system timestamp
CVMLong	updateTimestamp(long newTimestamp)	Updates the timestamp of this DLFS drive to the maximum of the given timestamp or it's current time stamp

Methods inherited from class java.lang.Object

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

Field Details

provider

protected final DLFSProvider provider

root

protected final DLPath root

emptyPath

protected final DLPath emptyPath

uriPath

protected final String uriPath

Constructor Details

DLFileSystem

protected DLFileSystem(DLFSProvider dlfsProvider,
 String uriPath,
 CVMLong timestamp)

Method Details

provider

public DLFSProvider provider()

Specified by:

provider in class FileSystem

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class FileSystem

Throws:

IOException

getTimestamp

public final CVMLong getTimestamp()

Gets the timestamp of this DLFS drive

Returns:

Current timestamp as a CVM integer

setTimestamp

public final void setTimestamp(CVMLong newTimestamp)

Sets the timestamp of this DLFS drive

Parameters:

newTimestamp - New timestamp

updateTimestamp

public CVMLong updateTimestamp(long newTimestamp)

Updates the timestamp of this DLFS drive to the maximum of the given timestamp or it's current time stamp

Parameters:

newTimestamp - Potential new timestamp

Returns:

The new timestamp value, or the original one if unchanged

updateTimestamp

public CVMLong updateTimestamp()

Updates the timestamp of the drive to the current system timestamp

isOpen

public boolean isOpen()

Specified by:

isOpen in class FileSystem

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in class FileSystem

getSeparator

public String getSeparator()

Specified by:

getSeparator in class FileSystem

getRootDirectories

public Iterable<Path> getRootDirectories()

Specified by:

getRootDirectories in class FileSystem

getFileStores

public Iterable<FileStore> getFileStores()

Specified by:

getFileStores in class FileSystem

supportedFileAttributeViews

public Set<String> supportedFileAttributeViews()

Specified by:

supportedFileAttributeViews in class FileSystem

getPath

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

Specified by:

getPath in class FileSystem

getPathMatcher

public PathMatcher getPathMatcher(String syntaxAndPattern)

Specified by:

getPathMatcher in class FileSystem

getUserPrincipalLookupService

public UserPrincipalLookupService getUserPrincipalLookupService()

Specified by:

getUserPrincipalLookupService in class FileSystem

newWatchService

public WatchService newWatchService()
                             throws IOException

Specified by:

newWatchService in class FileSystem

Throws:

IOException

getRoot

public DLPath getRoot()

Gets the unique root path for this FileSystem

Returns:

Path instance to root

getEmptyPath

public DLPath getEmptyPath()

Gets an empty path for this FileSystem

Returns:

empty path instance

newByteChannel

public abstract SeekableByteChannel newByteChannel(DLPath path,
 Set<? extends OpenOption> options,
 FileAttribute<?>[] attrs)
                                            throws IOException

Implementation for delegation by DLFSProvider

Parameters:

path - Path for new file

options - Options for file creation

attrs - File attributes

Returns:

ByteChannel instance

Throws:

IOException - In case of IO Error

newDirectoryStream

public abstract DLDirectoryStream newDirectoryStream(DLPath dir,
 DirectoryStream.Filter<? super Path> filter)

Implementation for delegation by DLFSProvider

Returns:

Directory stream

getFileAttributes

public DLFSFileAttributes getFileAttributes(DLPath path)

getNode

public abstract AVector<ACell> getNode(DLPath path)

Gets DLFS node for the given path

Parameters:

path - Path for which to obtain DLFSNode

Returns:

DLFS node, or null if does not exist

createDirectory

protected abstract DLPath createDirectory(DLPath dir,
 FileAttribute<?>[] attrs)
                                   throws IOException

Implementation for delegation by DLFSProvider, create a directory

Returns:

Throws:

IOException

checkAccess

protected abstract void checkAccess(DLPath path)
                             throws IOException

Implementation for DLFSProvider delegation

Parameters:

path -

Throws:

IOException

delete

public abstract void delete(DLPath dlp)
                     throws IOException

Throws:

IOException

getRootHash

public abstract Hash getRootHash()

getNodeHash

public Hash getNodeHash(DLPath p)

createFile

public abstract AVector<ACell> createFile(DLPath path)
                                   throws IOException

Creates a file, returning the new node

Parameters:

path - Path for which to create DLFSNode

Returns:

New file node

Throws:

IOException - In event of IOError

updateNode

public abstract AVector<ACell> updateNode(DLPath path,
 AVector<ACell> newNode)

Updates a node, returning the new node

Parameters:

path - Path for which to update DLFSNode

newNode - NEw node to put in place

Returns:

The new node

merge

public abstract void merge(AVector<ACell> other)

Merges another DLFS drive into this one

Parameters:

other - Root node of other DLFS drive

replicate

public void replicate(DLFileSystem other)

clone

public abstract DLFileSystem clone()

Overrides:

clone in class Object