Module org.cryptomator.frontend.dokany

Package org.cryptomator.frontend.dokany.internal.structure

Class DokanyOperations

java.lang.Object

com.sun.jna.Structure

org.cryptomator.frontend.dokany.internal.structure.DokanyOperations

public class DokanyOperations
extends com.sun.jna.Structure

Dokany API callbacks interface. This is an internal class and should not used directly by code outside com.dokany.java.

A struct of callbacks that describe all Dokany API operation that will be called when Windows accesses the file system.

If an error occurs, return NtStatus.

All these callbacks can be set to null or return NtStatus.NOT_IMPLEMENTED if you don't want to support one of them. Be aware that returning such a value to important callbacks such as DokanyOperations.ZwCreateFile or DokanyOperations.ReadFile would make the file system not working or unstable.

This is the same struct as _DOKAN_OPERATIONS (dokan.h) in the C++ version of Dokany.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DokanyOperations.Cleanup	Receipt of this request indicates that the last handle for a file object that is associated with the target device object has been closed (but, due to outstanding I/O requests, might not have been released).
static interface	DokanyOperations.CloseFile	CloseFile is called at the end of the life of the context.
static interface	DokanyOperations.DeleteDirectory	Check if it is possible to delete a directory.
static interface	DokanyOperations.DeleteFile	Check if it is possible to delete a file.
static interface	DokanyOperations.FillWin32FindData
static interface	DokanyOperations.FillWin32FindStreamData
static interface	DokanyOperations.FindFiles	List all files in the path requested.
static interface	DokanyOperations.FindFilesWithPattern	Same as DokanyOperations.FindFiles but with a search pattern to filter the result.
static interface	DokanyOperations.FindStreams	Retrieve all NTFS Streams informations on the file.
static interface	DokanyOperations.FlushFileBuffers	Clears buffers for this context and causes any buffered data to be written to the file.
static interface	DokanyOperations.GetDiskFreeSpace	Retrieves information about the amount of space that is available on a disk volume, which is the total amount of space, the total amount of free space, and the total amount of free space available to the user that is associated with the calling thread.
static interface	DokanyOperations.GetFileInformation	Get specific informations on a file.
static interface	DokanyOperations.GetFileSecurity	Get specified information about the security of a file or directory.
static interface	DokanyOperations.GetVolumeInformation	Retrieves information about the file system and volume associated with the specified root directory.
static interface	DokanyOperations.LockFile	Lock file at a specific offset and data length.
static interface	DokanyOperations.Mounted	Is called when Dokany succeeded mounting the volume.
static interface	DokanyOperations.MoveFile	Move a file or directory to a new location.
static interface	DokanyOperations.ReadFile	ReadFile callback on the file previously opened in DokanyOperations.ZwCreateFile.
static interface	DokanyOperations.SetAllocationSize	SetAllocationSize is used to truncate or extend a file.
static interface	DokanyOperations.SetEndOfFile	SetEndOfFile is used to truncate or extend a file (physical file size).
static interface	DokanyOperations.SetFileAttributes	Set file attributes on a specific file.
static interface	DokanyOperations.SetFileSecurity	Sets the security of a file or directory object.
static interface	DokanyOperations.SetFileTime	Set file times on a specific file.
static interface	DokanyOperations.UnlockFile	Unlock file at a specific offset and data length.
static interface	DokanyOperations.Unmounted	Is called when Dokany succeeded unmounting the volume.
static interface	DokanyOperations.Win32FindStreamDataInterface
static interface	DokanyOperations.WriteFile	WriteFile callback on the file previously opened in DokanyOperations.ZwCreateFile It can be called by different thread at the same time, therefore the write/context has to be thread safe.
static interface	DokanyOperations.ZwCreateFile	CreateFile is called each time a request is made on a file system object.

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.ByReference, com.sun.jna.Structure.ByValue, com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field	Description
DokanyOperations.Cleanup	Cleanup
DokanyOperations.CloseFile	CloseFile
DokanyOperations.DeleteDirectory	DeleteDirectory
DokanyOperations.DeleteFile	DeleteFile
DokanyOperations.FindFiles	FindFiles
DokanyOperations.FindFilesWithPattern	FindFilesWithPattern
DokanyOperations.FindStreams	FindStreams
DokanyOperations.FlushFileBuffers	FlushFileBuffers
DokanyOperations.GetDiskFreeSpace	GetDiskFreeSpace
DokanyOperations.GetFileInformation	GetFileInformation
DokanyOperations.GetFileSecurity	GetFileSecurity
DokanyOperations.GetVolumeInformation	GetVolumeInformation
DokanyOperations.LockFile	LockFile
DokanyOperations.Mounted	Mounted
DokanyOperations.MoveFile	MoveFile
DokanyOperations.ReadFile	ReadFile
DokanyOperations.SetAllocationSize	SetAllocationSize
DokanyOperations.SetEndOfFile	SetEndOfFile
DokanyOperations.SetFileAttributes	SetFileAttributes
DokanyOperations.SetFileSecurity	SetFileSecurity
DokanyOperations.SetFileTime	SetFileTime
DokanyOperations.UnlockFile	UnlockFile
DokanyOperations.Unmounted	Unmounted
DokanyOperations.WriteFile	WriteFile
DokanyOperations.ZwCreateFile	ZwCreateFile

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
DokanyOperations()

Method Summary

Modifier and Type	Method	Description
protected List<String>	getFieldOrder()

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ZwCreateFile

public DokanyOperations.ZwCreateFile ZwCreateFile

Cleanup

public DokanyOperations.Cleanup Cleanup

CloseFile

public DokanyOperations.CloseFile CloseFile

ReadFile

public DokanyOperations.ReadFile ReadFile

WriteFile

public DokanyOperations.WriteFile WriteFile

FlushFileBuffers

public DokanyOperations.FlushFileBuffers FlushFileBuffers

GetFileInformation

public DokanyOperations.GetFileInformation GetFileInformation

FindFiles

public DokanyOperations.FindFiles FindFiles

FindFilesWithPattern

public DokanyOperations.FindFilesWithPattern FindFilesWithPattern

SetFileAttributes

public DokanyOperations.SetFileAttributes SetFileAttributes

SetFileTime

public DokanyOperations.SetFileTime SetFileTime

DeleteFile

public DokanyOperations.DeleteFile DeleteFile

DeleteDirectory

public DokanyOperations.DeleteDirectory DeleteDirectory

MoveFile

public DokanyOperations.MoveFile MoveFile

SetEndOfFile

public DokanyOperations.SetEndOfFile SetEndOfFile

SetAllocationSize

public DokanyOperations.SetAllocationSize SetAllocationSize

LockFile

public DokanyOperations.LockFile LockFile

UnlockFile

public DokanyOperations.UnlockFile UnlockFile

GetDiskFreeSpace

public DokanyOperations.GetDiskFreeSpace GetDiskFreeSpace

GetVolumeInformation

public DokanyOperations.GetVolumeInformation GetVolumeInformation

Mounted

public DokanyOperations.Mounted Mounted

Unmounted

public DokanyOperations.Unmounted Unmounted

GetFileSecurity

public DokanyOperations.GetFileSecurity GetFileSecurity

SetFileSecurity

public DokanyOperations.SetFileSecurity SetFileSecurity

FindStreams

public DokanyOperations.FindStreams FindStreams

Constructor Details

DokanyOperations

public DokanyOperations()

Method Details

getFieldOrder

protected List<String> getFieldOrder()

Overrides:

getFieldOrder in class com.sun.jna.Structure