Package me.desair.tus.server.upload.disk

Class FileBasedLock

java.lang.Object

me.desair.tus.server.upload.disk.FileBasedLock

All Implemented Interfaces:

AutoCloseable, UploadLock

public class FileBasedLock
extends Object
implements UploadLock

Upload locking implementation using the file system file locking mechanism. File locking can also apply to shared network drives. This way the framework supports clustering as long as the upload storage directory is mounted as a shared (network) drive.
File locks are also automatically released on application (JVM) shutdown. This means the file locking is not persistent and prevents cleanup and stale lock issues.

Field Summary

Fields

Modifier and Type	Field	Description
protected Path	lockPath

Constructor Summary

Constructors

Constructor	Description
FileBasedLock(String uploadUri, Path lockPath)

Method Summary

Modifier and Type	Method	Description
void	close()
protected FileChannel	createFileChannel()
String	getUploadUri()	Get the upload URI of the upload that is locked by this lock
void	release()	Method to release the lock on an upload when done processing it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

lockPath

protected Path lockPath

Constructor Details

FileBasedLock

public FileBasedLock(String uploadUri,
 Path lockPath)
              throws UploadAlreadyLockedException,
IOException

Throws:

UploadAlreadyLockedException

IOException

Method Details

getUploadUri

public String getUploadUri()

Description copied from interface: UploadLock

Get the upload URI of the upload that is locked by this lock

Specified by:

getUploadUri in interface UploadLock

Returns:

The URI of the locked upload

release

public void release()

Description copied from interface: UploadLock

Method to release the lock on an upload when done processing it. It's possible that this method is called multiple times within the same request

Specified by:

release in interface UploadLock

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface UploadLock

Throws:

IOException

createFileChannel

protected FileChannel createFileChannel()
                                 throws IOException

Throws:

IOException