Dokan-Java

Introduction

Dokan-Java is a Java wrapper for Dokany 1.x releases and above. Using this project you are able to implement your own filesystem on Windows... in Java!

Dokany is a device driver providing an interface to develop and run your own filesystem on Windows (similar to FUSE). Its native bindings are written in C/C++, this library provides via JNA a Java interface to its API with additional convenience methods.

Runtime Dependencies

• 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
• Commons IO
• Guava
• JUnit 5

How to Use

There are 2 ways to directly use dokan-java: 1. Use a pre-built version 2. Build it yourself

Pre-Built Version

The first stable release can be found here: https://bintray.com/infeo/maven/dokan-java

To use dokan-java in maven or gradle projects, you have to add jcenter as a repository and then find it under the following coordinates: * Maven

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

• Gradle

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

A publication to MavenCentral is in progress.

Build Instructions

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 a local Maven repository, execute as the third step ./gradlew.bat publishToMavenLocal

Examples

Example user filesystems using this library, see the examples package dev.dokan.dokan_java.examples.

Contributing

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

License

This library is licensed under GNU LGPLv3.