Module org.cryptomator.frontend.fuse

Package org.cryptomator.frontend.fuse

Class ReadOnlyAdapter

java.lang.Object

org.cryptomator.frontend.fuse.ReadOnlyAdapter

All Implemented Interfaces:

AutoCloseable, FuseNioAdapter, org.cryptomator.jfuse.api.FuseOperations

Direct Known Subclasses:

ReadWriteAdapter

public sealed class ReadOnlyAdapter
extends Object
implements FuseNioAdapter
permits ReadWriteAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface org.cryptomator.jfuse.api.FuseOperations

org.cryptomator.jfuse.api.FuseOperations.Operation

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	enableXattr
protected final org.cryptomator.jfuse.api.Errno	errno
protected final FileNameTranscoder	fileNameTranscoder
protected final FileStore	fileStore
protected final LockManager	lockManager
protected final OpenFileFactory	openFiles
protected final Path	root

Fields inherited from interface org.cryptomator.frontend.fuse.FuseNioAdapter

DEFAULT_MAX_FILENAMELENGTH

Fields inherited from interface org.cryptomator.jfuse.api.FuseOperations

FUSE_READDIR_PLUS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReadOnlyAdapter(org.cryptomator.jfuse.api.Errno errno, Path root, int maxFileNameLength, FileNameTranscoder fileNameTranscoder, FileStore fileStore, OpenFileFactory openFiles, ReadOnlyDirectoryHandler dirHandler, ReadOnlyFileHandler fileHandler, boolean enableXattr)

Method Summary

Modifier and Type	Method	Description
int	access(String path, int mask)
protected int	checkAccess(Path path, Set<AccessMode> requiredAccessModes)
protected int	checkAccess(Path path, Set<AccessMode> requiredAccessModes, Set<AccessMode> deniedAccessModes)
void	close()
static ReadOnlyAdapter	create(org.cryptomator.jfuse.api.Errno errno, Path root, int maxFileNameLength, FileNameTranscoder fileNameTranscoder, boolean enableXattr)
void	destroy()
org.cryptomator.jfuse.api.Errno	errno()
int	getattr(String path, org.cryptomator.jfuse.api.Stat stat, org.cryptomator.jfuse.api.FileInfo fi)
protected int	getErrorCodeForGenericFileSystemException(FileSystemException e, String opDesc)	Attempts to get a specific error code that best describes the given exception.
int	getxattr(String path, String name, ByteBuffer value)
boolean	isInUse()	Checks if the filesystem is in use (and therefore an unmount attempt should be avoided).
int	listxattr(String path, ByteBuffer list)
int	open(String path, org.cryptomator.jfuse.api.FileInfo fi)
int	opendir(String path, org.cryptomator.jfuse.api.FileInfo fi)
int	read(String path, ByteBuffer buf, long size, long offset, org.cryptomator.jfuse.api.FileInfo fi)
int	readdir(String path, org.cryptomator.jfuse.api.DirFiller filler, long offset, org.cryptomator.jfuse.api.FileInfo fi, int flags)
int	readlink(String path, ByteBuffer buf, long size)
int	release(String path, org.cryptomator.jfuse.api.FileInfo fi)
int	releasedir(String path, org.cryptomator.jfuse.api.FileInfo fi)
protected Path	resolvePath(String absolutePath)
int	statfs(String path, org.cryptomator.jfuse.api.Statvfs stbuf)
Set<org.cryptomator.jfuse.api.FuseOperations.Operation>	supportedOperations()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cryptomator.jfuse.api.FuseOperations

chmod, chown, create, fallocate, flock, flush, fsync, fsyncdir, init, ioctl, link, mkdir, mknod, removexattr, rename, rmdir, setxattr, symlink, truncate, unlink, utimens, write

Field Details

errno

protected final org.cryptomator.jfuse.api.Errno errno

root

protected final Path root

fileStore

protected final FileStore fileStore

enableXattr

protected final boolean enableXattr

lockManager

protected final LockManager lockManager

openFiles

protected final OpenFileFactory openFiles

fileNameTranscoder

protected final FileNameTranscoder fileNameTranscoder

Constructor Details

ReadOnlyAdapter

protected ReadOnlyAdapter(org.cryptomator.jfuse.api.Errno errno,
 Path root,
 int maxFileNameLength,
 FileNameTranscoder fileNameTranscoder,
 FileStore fileStore,
 OpenFileFactory openFiles,
 ReadOnlyDirectoryHandler dirHandler,
 ReadOnlyFileHandler fileHandler,
 boolean enableXattr)

Method Details

create

public static ReadOnlyAdapter create(org.cryptomator.jfuse.api.Errno errno,
 Path root,
 int maxFileNameLength,
 FileNameTranscoder fileNameTranscoder,
 boolean enableXattr)

errno

public org.cryptomator.jfuse.api.Errno errno()

Specified by:

errno in interface org.cryptomator.jfuse.api.FuseOperations

supportedOperations

public Set<org.cryptomator.jfuse.api.FuseOperations.Operation> supportedOperations()

Specified by:

supportedOperations in interface org.cryptomator.jfuse.api.FuseOperations

resolvePath

protected Path resolvePath(String absolutePath)

statfs

public int statfs(String path,
 org.cryptomator.jfuse.api.Statvfs stbuf)

Specified by:

statfs in interface org.cryptomator.jfuse.api.FuseOperations

access

public int access(String path,
 int mask)

Specified by:

access in interface org.cryptomator.jfuse.api.FuseOperations

checkAccess

protected int checkAccess(Path path,
 Set<AccessMode> requiredAccessModes)

checkAccess

protected int checkAccess(Path path,
 Set<AccessMode> requiredAccessModes,
 Set<AccessMode> deniedAccessModes)

readlink

public int readlink(String path,
 ByteBuffer buf,
 long size)

Specified by:

readlink in interface org.cryptomator.jfuse.api.FuseOperations

getattr

public int getattr(String path,
 org.cryptomator.jfuse.api.Stat stat,
 org.cryptomator.jfuse.api.FileInfo fi)

Specified by:

getattr in interface org.cryptomator.jfuse.api.FuseOperations

getxattr

public int getxattr(String path,
 String name,
 ByteBuffer value)

Specified by:

getxattr in interface org.cryptomator.jfuse.api.FuseOperations

listxattr

public int listxattr(String path,
 ByteBuffer list)

Specified by:

listxattr in interface org.cryptomator.jfuse.api.FuseOperations

opendir

public int opendir(String path,
 org.cryptomator.jfuse.api.FileInfo fi)

Specified by:

opendir in interface org.cryptomator.jfuse.api.FuseOperations

readdir

public int readdir(String path,
 org.cryptomator.jfuse.api.DirFiller filler,
 long offset,
 org.cryptomator.jfuse.api.FileInfo fi,
 int flags)

Specified by:

readdir in interface org.cryptomator.jfuse.api.FuseOperations

releasedir

public int releasedir(String path,
 org.cryptomator.jfuse.api.FileInfo fi)

Specified by:

releasedir in interface org.cryptomator.jfuse.api.FuseOperations

open

public int open(String path,
 org.cryptomator.jfuse.api.FileInfo fi)

Specified by:

open in interface org.cryptomator.jfuse.api.FuseOperations

read

public int read(String path,
 ByteBuffer buf,
 long size,
 long offset,
 org.cryptomator.jfuse.api.FileInfo fi)

Specified by:

read in interface org.cryptomator.jfuse.api.FuseOperations

release

public int release(String path,
 org.cryptomator.jfuse.api.FileInfo fi)

Specified by:

release in interface org.cryptomator.jfuse.api.FuseOperations

destroy

public void destroy()

Specified by:

destroy in interface org.cryptomator.jfuse.api.FuseOperations

isInUse

public boolean isInUse()

Description copied from interface: FuseNioAdapter

Checks if the filesystem is in use (and therefore an unmount attempt should be avoided).

Important: This function only checks, like the name suggests, if the filesystem is busy and used. A return value of false should not be considered as an unmount can be safely and successfully executed and thus an unmount may fail.

API note: It is the task of the fs developer to decide what "in use" means. For example, "in use" can mean there are open resources or pending operations. Additionally no guarantees about the validity of the result after the call is made, i.e. the result may be immediately outdated.

Specified by:

isInUse in interface FuseNioAdapter

Returns:

true if the filesystem is in use

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FuseNioAdapter

Throws:

IOException

getErrorCodeForGenericFileSystemException

protected int getErrorCodeForGenericFileSystemException(FileSystemException e,
 String opDesc)

Attempts to get a specific error code that best describes the given exception. As a side effect this logs the error.

Parameters:

e - An exception

opDesc - A human-friendly string describing what operation was attempted (for logging purposes)

Returns:

A specific error code or -EIO.