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

Class DiskLockingService

java.lang.Object

me.desair.tus.server.upload.disk.AbstractDiskBasedService

me.desair.tus.server.upload.disk.DiskLockingService

All Implemented Interfaces:

UploadLockingService

public class DiskLockingService
extends AbstractDiskBasedService
implements UploadLockingService

UploadLockingService implementation that uses the file system for implementing locking
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.

Constructor Summary

Constructors

Constructor	Description
DiskLockingService(String storagePath)
DiskLockingService(UploadIdFactory idFactory, String storagePath)	Constructor to use custom UploadIdFactory.

Method Summary

Modifier and Type	Method	Description
void	cleanupStaleLocks()	Clean up any stale locks that are still present.
boolean	isLocked(UploadId id)	Check if the upload with the given ID is currently locked.
UploadLock	lockUploadByUri(String requestUri)	If the given URI represents a valid upload, lock that upload for processing.
void	setIdFactory(UploadIdFactory idFactory)	Set an instance if IdFactory to be used for creating identities and extracting them from uploadUris.

Methods inherited from class me.desair.tus.server.upload.disk.AbstractDiskBasedService

getPathInStorageDirectory, getStoragePath

Methods inherited from class java.lang.Object

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

Constructor Details

DiskLockingService

public DiskLockingService(String storagePath)

DiskLockingService

public DiskLockingService(UploadIdFactory idFactory,
 String storagePath)

Constructor to use custom UploadIdFactory.

Method Details

lockUploadByUri

public UploadLock lockUploadByUri(String requestUri)
                           throws TusException,
IOException

Description copied from interface: UploadLockingService

If the given URI represents a valid upload, lock that upload for processing.

Specified by:

lockUploadByUri in interface UploadLockingService

Parameters:

requestUri - The URI that potentially represents an upload

Returns:

The lock on the upload, or null if not lock was applied

Throws:

TusException - If the upload is already locked

IOException

cleanupStaleLocks

public void cleanupStaleLocks()
                       throws IOException

Description copied from interface: UploadLockingService

Clean up any stale locks that are still present.

Specified by:

cleanupStaleLocks in interface UploadLockingService

Throws:

IOException - When cleaning a stale lock fails

isLocked

public boolean isLocked(UploadId id)

Description copied from interface: UploadLockingService

Check if the upload with the given ID is currently locked.

Specified by:

isLocked in interface UploadLockingService

Parameters:

id - The ID of the upload to check

Returns:

True if the upload is locked, false otherwise

setIdFactory

public void setIdFactory(UploadIdFactory idFactory)

Description copied from interface: UploadLockingService

Set an instance if IdFactory to be used for creating identities and extracting them from uploadUris.

Specified by:

setIdFactory in interface UploadLockingService

Parameters:

idFactory - The UploadIdFactory to use within this locking service