Dokan-Java is a Java wrapper for Dokany 1.3.0 releases and above.

Dokany is a device driver providing an interface to develop and run your own filesystem on Windows (similar to FUSE). It is natively written in C/C++. Usually a Java developer, who would like to utilize Dokany would need to write time-consuming and error-prone JNI-Code. Dokan-java closes this gap and provides a Java interface to Dokany's API with additional convenience methods using JNA to access Dokany. Using this project you are able to implement your own filesystem on Windows... in Java!

dokan-java requires Java JRE 11.

All dependencies can be seen in the dependecies section of the build file. The following are the primary dependencies:

• JNA - provides access to native Dokany functions
• JUnit 5

There are 2 ways to directly use dokan-java:

1. Use a pre-built version
2. Build it yourself

Release can be found on bintray.

The project publishs to jcenter for easy integration with maven or gradle projects.

In order to include dokan-java, add jcenter as an additional repository in your pom.xml

<repositories>
    <repository>
        <id>jcenter</id>
        <url>https://jcenter.bintray.com/</url>
    </repository>
</repositories>

and add the project as a dependency:

<dependency>
    <groupId>dev.dokan</groupId>
    <artifactId>dokan-java</artifactId>
    <version>1.1.0</version>
</dependency>

In order to use dokan-java, add jcenter to your build.gradle

repositories {
    jcenter()
}

and add the project as a dependency:

dependencies {
    implementation (group:'dev.dokan', name:'dokan-java', version:'1.1.1')
}

Prerequisite: JDK 11

Building a jar using Gradle:

1. Open Terminal
2. Navigate to the root folder of the project
3. Execute ./gradlew.bat jar

To publish to your local Maven repository, execute as the third step ./gradlew.bat publishToMavenLocal

An example user filesystems using this library can be found in the examples package dev.dokan.dokan_java.examples.

Dokan-Java uses it's own versioning system and therefore doesn't match the versions of Dokany. For Dokan-Java to work you need to have a suitable version of Dokany installed on your machine. The following table helps you choose the correct Dokany-version.

You're encouraged to contribute. Fork the code and then submit a pull request.

This library is licensed under GNU LGPLv3.