FUSE implementation in Java using Java Native Runtime (JNR)
Java
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

jnr-fuse

Build Status Download Join the chat at https://gitter.im/SerCeMan/jnr-fuse

jnr-fuse is a FUSE implementation in java using Java Native Runtime (JNR).

Project Goals

The main goal of the project is to provide an easy way to create a high-performance filesystem in userspace.

About technologies

FUSE (Filesystem in Userspace) is an OS mechanism for unix-like OS that lets non-privileged users create their own file systems without editing kernel code.

Java Native Runtime (JNR) is high-performance Java API for binding native libraries and native memory.

Get it

Gradle

repositories {
    jcenter()
}

dependencies {
    compile 'com.github.serceman:jnr-fuse:0.5.2.1'
}

Maven

<repositories>
    <repository>
        <id>central</id>
        <name>bintray</name>
        <url>http://jcenter.bintray.com</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.serceman</groupId>
        <artifactId>jnr-fuse</artifactId>
        <version>0.5.2.1</version>
    </dependency>
</dependencies>

How to use

For implementing your own filesystem you just need to extend FuseStubFS class and implement methods you need.

See some examples.

See blog article about the implementation

Projects using jnr-fuse

  • Alluxio: Alluxio is a memory-centric distributed storage system
  • mux2fs Muxes subtitles into Matroska files as a FUSE filesystem

Supported platforms

Supported platforms
Linux x64 x86
MacOS (via osxfuse) x64 x86
Windows (via winfsp) x64 n/a

Installation and troubleshooting

See instructions.