org.catacombae.jfuse.joapi
Interface JFUSEOperations


public interface JFUSEOperations

Author:
erik

Method Summary
 void access(String path, int mode)
           Check file access permissions.
 void bmap(String path, long blocksize, LongRef idx)
           Map block index within file to block index within device.
 void chmod(String path, short newMode)
           Change the permission bits of a file.
 void chown(String path, long userId, long groupId)
           Change the owner and group of a file
 void create(String path, short mode, FUSEFileInfo fi)
           Create and open a file.
 void destroy(Object o)
           Clean up filesystem.
 void fgetattr(String path, Stat stat, FUSEFileInfo fi)
           Get attributes from an open file.
 void flush(String path, FUSEFileInfo fi)
           Possibly flush cached data.
 void fsync(String path, boolean datasync, FUSEFileInfo fi)
           Synchronize file contents.
 void fsyncdir(String path, boolean datasync, FUSEFileInfo fi)
           Synchronize directory contents.
 void ftruncate(String path, long length, FUSEFileInfo fi)
           Change the size of an open file.
 void getattr(String path, Stat stat)
           Get file attributes.
 void getdir(String path, FUSEDirFil filler)
          Deprecated.  
 int getxattr(String path, String name, ByteBuffer value)
           Get extended attributes.
 int getxattr(String path, String name, ByteBuffer value, int position)
           Get extended attributes.
 Object init(FUSEConnInfo conn)
           Initialize filesystem.
 void link(String sourcePath, String destPath)
           Create a hard link to a file.
 int listxattr(String path, ByteBuffer namebuf)
           List extended attributes.
 void lock(String path, FUSEFileInfo fi, int cmd, Flock flock)
           Perform POSIX file locking operation.
 void mkdir(String path, short createMode)
           Create a directory.
 void mknod(String path, short fileMode, long deviceNumber)
           Create a file node.
 void open(String path, FUSEFileInfo fi)
           File open operation.
 void opendir(String path, FUSEFileInfo fi)
           Open directory.
 int read(String path, ByteBuffer dest, long off, FUSEFileInfo fi)
           Read data from an open file.
 void readdir(String path, FUSEFillDir filler, long offset, FUSEFileInfo fi)
           Read directory.
 void readlink(String path, ByteBuffer buffer)
           Read the target of a symbolic link.
 void release(String path, FUSEFileInfo fi)
           Release an open file.
 void releasedir(String path, FUSEFileInfo fi)
           Release directory.
 void removexattr(String path, String name)
           Remove extended attributes.
 void rename(String oldPath, String newPath)
           Rename a file.
 void rmdir(String path)
           Remove a directory.
 void setxattr(String path, String name, ByteBuffer value, int flags)
           Set extended attributes.
 void setxattr(String path, String name, ByteBuffer value, int flags, int position)
           Set extended attributes.
 void statfs(String path, StatVFS stat)
           Get file system statistics.
 void symlink(String sourcePath, String destPath)
           Create a symbolic link.
 void truncate(String path, long newSize)
           Change the size of a file.
 void unlink(String path)
           Remove a file.
 void utime(String path, Utimbuf time)
          Deprecated.  
 void utimens(String path, Timespec accessTime, Timespec modificationTime)
           Change the access and modification times of a file with nanosecond resolution.
 int write(String path, ByteBuffer src, long off, FUSEFileInfo fi)
           Write data to an open file.
 

Method Detail

getattr

void getattr(String path,
             Stat stat)
             throws JFUSEException
 Get file attributes.

 Similar to stat().  The 'st_dev' and 'st_blksize' fields are
 ignored.  The 'st_ino' field is ignored except if the 'use_ino'
 mount option is given.
 

Parameters:
path - (const char*)
stat - (struct stat*)
Throws:
JFUSEException

readlink

void readlink(String path,
              ByteBuffer buffer)
              throws JFUSEException
 Read the target of a symbolic link.

 The buffer should be filled with a null terminated string.  The
 buffer size argument includes the space for the terminating
 null character.  If the linkname is too long to fit in the
 buffer, it should be truncated.  The return value should be 0
 for success.
 
In jFUSE the buffer size argument has already been parsed when this method gets the buffer. The byte array passed to readlink has a size equal to the size of the native buffer.

Parameters:
path - (const char*)
buffer - (char*)
Throws:
JFUSEException

getdir

void getdir(String path,
            FUSEDirFil filler)
            throws JFUSEException
Deprecated. 

 Deprecated, use readdir() instead.
 

Parameters:
path - (const char*)
filler - (fuse_dirfil_t)
Throws:
JFUSEException

mknod

void mknod(String path,
           short fileMode,
           long deviceNumber)
           throws JFUSEException
 Create a file node.

 This is called for creation of all non-directory, non-symlink
 nodes.  If the filesystem defines a create() method, then for
 regular files that will be called instead.
 

Parameters:
path - (const char*)
fileMode - (mode_t)
deviceNumber - (dev_t)
Throws:
JFUSEException

mkdir

void mkdir(String path,
           short createMode)
           throws JFUSEException
 Create a directory.
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
createMode - (mode_t)
Throws:
JFUSEException

unlink

void unlink(String path)
            throws JFUSEException
 Remove a file.
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
Throws:
JFUSEException

rmdir

void rmdir(String path)
           throws JFUSEException
 Remove a directory.
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
Throws:
JFUSEException

symlink

void symlink(String sourcePath,
             String destPath)
             throws JFUSEException
 Create a symbolic link.
 

Parameters:
sourcePath - (const char*)
destPath - (const char*)
Throws:
JFUSEException

rename

void rename(String oldPath,
            String newPath)
            throws JFUSEException
 Rename a file.
 

Parameters:
oldPath - (const char*)
newPath - (const char*)
Throws:
JFUSEException

link

void link(String sourcePath,
          String destPath)
          throws JFUSEException
 Create a hard link to a file.
 

Parameters:
sourcePath - (const char*)
destPath - (const char*)
Throws:
JFUSEException

chmod

void chmod(String path,
           short newMode)
           throws JFUSEException
 Change the permission bits of a file.
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
newMode - (mode_t)
Throws:
JFUSEException

chown

void chown(String path,
           long userId,
           long groupId)
           throws JFUSEException
 Change the owner and group of a file
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
userId - (uid_t)
groupId - (uid_t)
Throws:
JFUSEException

truncate

void truncate(String path,
              long newSize)
              throws JFUSEException
 Change the size of a file.
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
newSize - (off_t)
Throws:
JFUSEException

utime

void utime(String path,
           Utimbuf time)
           throws JFUSEException
Deprecated. 

 Change the access and/or modification times of a file.

 Deprecated, use utimens() instead.
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
time - (struct utimbuf*)
Throws:
JFUSEException

open

void open(String path,
          FUSEFileInfo fi)
          throws JFUSEException
 File open operation.

 No creation, or truncation flags (O_CREAT, O_EXCL, O_TRUNC)
 will be passed to open().  Open should check if the operation
 is permitted for the given flags.  Optionally open may also
 return an arbitrary filehandle in the fuse_file_info structure,
 which will be passed to all file operations.

 Changed in version 2.2
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
fi - (struct fuse_file_info*)
Throws:
JFUSEException

read

int read(String path,
         ByteBuffer dest,
         long off,
         FUSEFileInfo fi)
         throws JFUSEException
 Read data from an open file.

 Read should return exactly the number of bytes requested except
 on EOF or error, otherwise the rest of the data will be
 substituted with zeroes.  An exception to this is when the
 'direct_io' mount option is specified, in which case the return
 value of the read system call will reflect the return value of
 this operation.

 Changed in version 2.2
 

Parameters:
path - (const char*) a path to the file to read from.
dest - (char*) the destination buffer.
off - (off_t) offset in file to start reading.
fi - (struct fuse_file_info*) file info.
Returns:
the number of bytes read (a positive number) if the operation completed successfully, or a negated value from FUSEErrorValues if an error occurred.
Typical error return values for read:
  • -EBADF
  • -EINVAL
  • -EISDIR
  • -ENOMEM
  • -EIO
Throws:
JFUSEException

write

int write(String path,
          ByteBuffer src,
          long off,
          FUSEFileInfo fi)
          throws JFUSEException
 Write data to an open file.

 Write should return exactly the number of bytes requested
 except on error.  An exception to this is when the 'direct_io'
 mount option is specified (see read operation).

 Changed in version 2.2
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
src - (const char*) the data to write.
off - (off_t) offset in file where data should be written.
fi - (struct fuse_file_info*)
Returns:
0 if successful or an inverted error value from FUSEErrorValues otherwise.
Throws:
JFUSEException

statfs

void statfs(String path,
            StatVFS stat)
            throws JFUSEException
 Get file system statistics.

 The 'f_frsize', 'f_favail', 'f_fsid' and 'f_flag' fields are ignored

 Replaced 'struct statfs' parameter with 'struct statvfs' in
 version 2.5
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
stat - (struct statvfs*)
Throws:
JFUSEException

flush

void flush(String path,
           FUSEFileInfo fi)
           throws JFUSEException
 Possibly flush cached data.

 BIG NOTE: This is not equivalent to fsync().  It's not a
 request to sync dirty data.

 Flush is called on each close() of a file descriptor.  So if a
 filesystem wants to return write errors in close() and the file
 has cached dirty data, this is a good place to write back data
 and return any errors.  Since many applications ignore close()
 errors this is not always useful.

 NOTE: The flush() method may be called more than once for each
 open().  This happens if more than one file descriptor refers
 to an opened file due to dup(), dup2() or fork() calls.  It is
 not possible to determine if a flush is final, so each flush
 should be treated equally.  Multiple write-flush sequences are
 relatively rare, so this shouldn't be a problem.

 Filesystems shouldn't assume that flush will always be called
 after some writes, or that if will be called at all.

 Changed in version 2.2
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
fi - (struct fuse_file_info*)
Throws:
JFUSEException

release

void release(String path,
             FUSEFileInfo fi)
             throws JFUSEException
 Release an open file.

 Release is called when there are no more references to an open
 file: all file descriptors are closed and all memory mappings
 are unmapped.

 For every open() call there will be exactly one release() call
 with the same flags and file descriptor.  It is possible to
 have a file opened more than once, in which case only the last
 release will mean, that no more reads/writes will happen on the
 file.  The return value of release is ignored.

 Changed in version 2.2
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
fi - (struct fuse_file_info*)
Throws:
JFUSEException

fsync

void fsync(String path,
           boolean datasync,
           FUSEFileInfo fi)
           throws JFUSEException
 Synchronize file contents.

 If the datasync parameter is non-zero, then only the user data
 should be flushed, not the meta data.

 Changed in version 2.2
 

Parameters:
path - (const char*) the path to the file system node on which the operation is to be applied.
datasync - (int) set to true if only the user data should be flushed, and not the meta-data.
fi - (struct fuse_file_info*)
Throws:
JFUSEException

setxattr

void setxattr(String path,
              String name,
              ByteBuffer value,
              int flags,
              int position)
              throws JFUSEException
 Set extended attributes.
 
This is the FreeBSD version of the callback. If you want your application to respond properly to the setxattr call on all platforms, you need to implement both setxattr callbacks.

Parameters:
path - (const char*)
name - (const char*)
value - (const char*)
flags - (int)
position - (uint32_t)
Throws:
JFUSEException - if the operation could not complete successfully.

setxattr

void setxattr(String path,
              String name,
              ByteBuffer value,
              int flags)
              throws JFUSEException
 Set extended attributes.
 
This is the non-BSD version of the callback. If you want your application to respond properly to the setxattr call on all platforms, you need to implement both setxattr and setxattr_BSD.

Parameters:
path - (const char*)
name - (const char*)
value - (const char*)
flags - (int)
Throws:
JFUSEException - if the operation could not complete successfully.

getxattr

int getxattr(String path,
             String name,
             ByteBuffer value,
             int position)
             throws JFUSEException
 Get extended attributes.
 
This is the FreeBSD version of the callback. If you want your application to respond properly to the getxattr call on all platforms, you need to implement both getxattr callbacks.

Parameters:
path - (const char*)
name - (const char*)
value - (char*) (out)
position - (uint32_t)
Returns:
the size of the retrieved extended attribute data.
Throws:
JFUSEException - if the operation could not complete successfully.

getxattr

int getxattr(String path,
             String name,
             ByteBuffer value)
             throws JFUSEException
 Get extended attributes.
 
This is the non-BSD version of the callback. If you want your application to respond properly to the getxattr call on all platforms, you need to implement both getxattr and getxattr_BSD.

Parameters:
path - (const char*)
name - (const char*)
value - (char*) (out)
Returns:
the size of the retrieved extended attribute data.
Throws:
JFUSEException - if the operation could not complete successfully.

listxattr

int listxattr(String path,
              ByteBuffer namebuf)
              throws JFUSEException
 List extended attributes.
 

Parameters:
path - (const char*)
namebuf - (char*) the buffer where we store the result.
Returns:
the size of the extended attributes list.
Throws:
JFUSEException - if the operation could not complete successfully.

removexattr

void removexattr(String path,
                 String name)
                 throws JFUSEException
 Remove extended attributes.
 

Parameters:
path - (const char*)
name - (const char*)
Throws:
JFUSEException - if the operation could not complete successfully.

opendir

void opendir(String path,
             FUSEFileInfo fi)
             throws JFUSEException
 Open directory.

 This method should check if the open operation is permitted for
 this  directory

 Introduced in version 2.3
 

Parameters:
path - (const char*)
fi - (struct fuse_file_info*)
Throws:
JFUSEException

readdir

void readdir(String path,
             FUSEFillDir filler,
             long offset,
             FUSEFileInfo fi)
             throws JFUSEException
 Read directory.

 This supersedes the old getdir() interface.  New applications
 should use this.

 The filesystem may choose between two modes of operation:

 1) The readdir implementation ignores the offset parameter, and
 passes zero to the filler function's offset.  The filler
 function will not return '1' (unless an error happens), so the
 whole directory is read in a single readdir operation.  This
 works just like the old getdir() method.

 2) The readdir implementation keeps track of the offsets of the
 directory entries.  It uses the offset parameter and always
 passes non-zero offset to the filler function.  When the buffer
 is full (or an error happens) the filler function will return
 '1'.

 Introduced in version 2.3
 

Parameters:
path - (const char*)
filler - (fuse_fill_dir_t)
offset - (off_t)
fi - (struct fuse_file_info*)
Throws:
JFUSEException

releasedir

void releasedir(String path,
                FUSEFileInfo fi)
                throws JFUSEException
 Release directory.

 Introduced in version 2.3
 

Parameters:
path - (const char*)
fi - (struct fuse_file_info*)
Throws:
JFUSEException

fsyncdir

void fsyncdir(String path,
              boolean datasync,
              FUSEFileInfo fi)
              throws JFUSEException
 Synchronize directory contents.

 If the datasync parameter is non-zero, then only the user data
 should be flushed, not the meta data

 Introduced in version 2.3
 

Parameters:
path - (const char*)
datasync - (int)
fi - (struct fuse_file_info*)
Throws:
JFUSEException

init

Object init(FUSEConnInfo conn)
 Initialize filesystem.

 The return value will passed in the private_data field of
 fuse_context to all file operations and as a parameter to the
 destroy() method.

 Introduced in version 2.3
 Changed in version 2.6
 

Parameters:
conn - (struct fuse_conn_info*)
Returns:
(optional) a return value that will be passed in the private_data field of fuse_context to all file operations and as a parameter to the destroy() method.

destroy

void destroy(Object o)
 Clean up filesystem.

 Called on filesystem exit.

 Introduced in version 2.3
 


access

void access(String path,
            int mode)
            throws JFUSEException
 Check file access permissions.

 This will be called for the access() system call.  If the
 'default_permissions' mount option is given, this method is not
 called.

 This method is not called under Linux kernel versions 2.4.x

 Introduced in version 2.5
 

Parameters:
path - (const char*)
mode - (int)
Throws:
JFUSEException

create

void create(String path,
            short mode,
            FUSEFileInfo fi)
            throws JFUSEException
 Create and open a file.

 If the file does not exist, first create it with the specified
 mode, and then open it.

 If this method is not implemented or under Linux kernel
 versions earlier than 2.6.15, the mknod() and open() methods
 will be called instead.

 Introduced in version 2.5
 

Parameters:
path - (const char*) path to the newly created file.
mode - (mode_t) the mode flags for the created file.
fi - (struct fuse_file_info*)
Throws:
JFUSEException

ftruncate

void ftruncate(String path,
               long length,
               FUSEFileInfo fi)
               throws JFUSEException
 Change the size of an open file.

 This method is called instead of the truncate() method if the
 truncation was invoked from an ftruncate() system call.

 If this method is not implemented or under Linux kernel
 versions earlier than 2.6.15, the truncate() method will be
 called instead.

 Introduced in version 2.5
 

Parameters:
path - (const char*)
length - (off_t)
fi - (struct fuse_file_info*)
Throws:
JFUSEException

fgetattr

void fgetattr(String path,
              Stat stat,
              FUSEFileInfo fi)
              throws JFUSEException
 Get attributes from an open file.

 This method is called instead of the getattr() method if the
 file information is available.

 Currently this is only called after the create() method if that
 is implemented (see above).  Later it may be called for
 invocations of fstat() too.

 Introduced in version 2.5
 

Parameters:
path - (const char*)
stat - (struct stat*)
fi - (struct fuse_file_info*)
Throws:
JFUSEException

lock

void lock(String path,
          FUSEFileInfo fi,
          int cmd,
          Flock flock)
          throws JFUSEException
 Perform POSIX file locking operation.

 The cmd argument will be either F_GETLK, F_SETLK or F_SETLKW.

 For the meaning of fields in 'struct flock' see the man page
 for fcntl(2).  The l_whence field will always be set to
 SEEK_SET.

 For checking lock ownership, the 'fuse_file_info->owner'
 argument must be used.

 For F_GETLK operation, the library will first check currently
 held locks, and if a conflicting lock is found it will return
 information without calling this method.  This ensures, that
 for local locks the l_pid field is correctly filled in.  The
 results may not be accurate in case of race conditions and in
 the presence of hard links, but it's unlikly that an
 application would rely on accurate GETLK results in these
 cases.  If a conflicting lock is not found, this method will be
 called, and the filesystem may fill out l_pid by a meaningful
 value, or it may leave this field zero.

 For F_SETLK and F_SETLKW the l_pid field will be set to the pid
 of the process performing the locking operation.

 Note: if this method is not implemented, the kernel will still
 allow file locking to work locally.  Hence it is only
 interesting for network filesystems and similar.

 Introduced in version 2.6
 

Parameters:
path - (const char*)
fi - (struct fuse_file_info*)
cmd - (int)
flock - (struct flock*)
Throws:
JFUSEException

utimens

void utimens(String path,
             Timespec accessTime,
             Timespec modificationTime)
             throws JFUSEException
 Change the access and modification times of a file with
 nanosecond resolution.

 Introduced in version 2.6
 

Parameters:
path - (const char*)
accessTime - (const struct timespec)
modificationTime - (const struct timespec)
Throws:
JFUSEException

bmap

void bmap(String path,
          long blocksize,
          LongRef idx)
          throws JFUSEException
 Map block index within file to block index within device.

 Note: This makes sense only for block device backed filesystems
 mounted with the 'blkdev' option

 Introduced in version 2.6
 

Parameters:
path - (const char*)
blocksize - (size_t)
idx - (uint64_t*)
Throws:
JFUSEException