me.desair.tus.server.upload.cache

Class ThreadLocalCachedStorageAndLockingService

java.lang.Object

me.desair.tus.server.upload.cache.ThreadLocalCachedStorageAndLockingService

All Implemented Interfaces:

UploadLockingService, UploadStorageService

public class ThreadLocalCachedStorageAndLockingService
extends Object
implements UploadLockingService, UploadStorageService

Combined implementation of UploadStorageService and UploadLockingService. Uses both of them as delegates but allowing to reduce disk operations during a request processing by caching UploadInfo in the memory. UploadLockingService service is used as a delegate to cleanup cached data on releasing a lock.

Constructor Summary

Constructors

Constructor and Description
ThreadLocalCachedStorageAndLockingService(UploadStorageService storageServiceDelegate, UploadLockingService lockingServiceDelegate)

Method Summary

Modifier and Type	Method and Description
UploadInfo	append(UploadInfo upload, InputStream inputStream) Append the bytes in the give InputStream to the upload with the given ID starting at the provided offset.
void	cleanupExpiredUploads(UploadLockingService uploadLockingService) Clean up any upload data that is expired according to the configured expiration time
void	cleanupStaleLocks() Clean up any stale locks that are still present
void	copyUploadTo(UploadInfo info, OutputStream outputStream) Copy the uploaded bytes to the given output stream
UploadInfo	create(UploadInfo info, String ownerKey) Create an upload location with the given upload information
long	getMaxUploadSize() Get the maximum upload size configured on this storage service
UploadConcatenationService	getUploadConcatenationService() Return the UploadConcatenationService implementation that this upload service is using
InputStream	getUploadedBytes(String uploadURI, String ownerKey) Get the uploaded bytes corresponding to the given upload URL as a stream
InputStream	getUploadedBytes(UploadId id) Get the uploaded bytes corresponding to the given upload ID as a stream
Long	getUploadExpirationPeriod() Get the expiration period of an upload in milliseconds
UploadInfo	getUploadInfo(String uploadUrl, String ownerKey) Method to retrieve the upload info by its upload URL
UploadInfo	getUploadInfo(UploadId id) Method to retrieve the upload info by its ID
String	getUploadURI() The URI which is configured as the upload endpoint
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	removeLastNumberOfBytes(UploadInfo uploadInfo, long byteCount) Remove the given last amount of bytes from the uploaded data
void	setIdFactory(UploadIdFactory idFactory) Set an instance if IdFactory to be used for creating identities and extracting them from uploadURIs
void	setMaxUploadSize(Long maxUploadSize) Limit the maximum upload size to the given value
void	setUploadConcatenationService(UploadConcatenationService concatenationService) Set the UploadConcatenationService that this upload storage service should use
void	setUploadExpirationPeriod(Long uploadExpirationPeriod) Set the expiration period after which an in-progress upload expires
void	terminateUpload(UploadInfo uploadInfo) Terminate completed and unfinished uploads allowing the Server to free up used resources.
void	update(UploadInfo uploadInfo) Update the upload information for the provided ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadLocalCachedStorageAndLockingService

public ThreadLocalCachedStorageAndLockingService(UploadStorageService storageServiceDelegate,
                                                 UploadLockingService lockingServiceDelegate)

Method Detail

getUploadInfo

public UploadInfo getUploadInfo(UploadId id)
                         throws IOException

Description copied from interface: UploadStorageService

Method to retrieve the upload info by its ID

Specified by:

getUploadInfo in interface UploadStorageService

Parameters:

id - The ID of the upload

Returns:

The matching upload info

Throws:

IOException - When the service is not able to retrieve the upload information

getUploadInfo

public UploadInfo getUploadInfo(String uploadUrl,
                                String ownerKey)
                         throws IOException

Description copied from interface: UploadStorageService

Method to retrieve the upload info by its upload URL

Specified by:

getUploadInfo in interface UploadStorageService

Parameters:

uploadUrl - The URL corresponding to this upload. This parameter can be null.

ownerKey - A key representing the owner of the upload

Returns:

The upload info matching the given URL, or null when not found.

Throws:

IOException

update

public void update(UploadInfo uploadInfo)
            throws IOException,
                   UploadNotFoundException

Description copied from interface: UploadStorageService

Update the upload information for the provided ID.

Specified by:

update in interface UploadStorageService

Parameters:

uploadInfo - The upload info object containing the ID and information to update

Throws:

IOException

UploadNotFoundException

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

Specified by:

setIdFactory in interface UploadStorageService

Parameters:

idFactory - The UploadIdFactory to use within this locking service

getUploadURI

public String getUploadURI()

Description copied from interface: UploadStorageService

The URI which is configured as the upload endpoint

Specified by:

getUploadURI in interface UploadStorageService

Returns:

The URI

append

public UploadInfo append(UploadInfo upload,
                         InputStream inputStream)
                  throws IOException,
                         TusException

Description copied from interface: UploadStorageService

Append the bytes in the give InputStream to the upload with the given ID starting at the provided offset. This method also updates the UploadInfo corresponding to this upload. The Upload Storage server should not exceed its max upload size when writing bytes.

Specified by:

append in interface UploadStorageService

Parameters:

upload - The ID of the upload

inputStream - The input stream containing the bytes to append

Returns:

The new UploadInfo for this upload

Throws:

IOException

TusException

setMaxUploadSize

public void setMaxUploadSize(Long maxUploadSize)

Description copied from interface: UploadStorageService

Limit the maximum upload size to the given value

Specified by:

setMaxUploadSize in interface UploadStorageService

Parameters:

maxUploadSize - The maximum upload limit to set

getMaxUploadSize

public long getMaxUploadSize()

Description copied from interface: UploadStorageService

Get the maximum upload size configured on this storage service

Specified by:

getMaxUploadSize in interface UploadStorageService

Returns:

The maximum upload size or zero if no maximum

create

public UploadInfo create(UploadInfo info,
                         String ownerKey)
                  throws IOException

Description copied from interface: UploadStorageService

Create an upload location with the given upload information

Specified by:

create in interface UploadStorageService

Parameters:

info - The Upload information to use to create the new upload

ownerKey - A key representing the owner of the upload

Returns:

An UploadInfo object containing the information used to create the upload and its unique ID

Throws:

IOException

getUploadedBytes

public InputStream getUploadedBytes(String uploadURI,
                                    String ownerKey)
                             throws IOException,
                                    UploadNotFoundException

Description copied from interface: UploadStorageService

Get the uploaded bytes corresponding to the given upload URL as a stream

Specified by:

getUploadedBytes in interface UploadStorageService

Parameters:

uploadURI - The URI

ownerKey - The owner key of this upload

Returns:

an OutputStream containing the bytes of the upload

Throws:

IOException

UploadNotFoundException

getUploadedBytes

public InputStream getUploadedBytes(UploadId id)
                             throws IOException,
                                    UploadNotFoundException

Description copied from interface: UploadStorageService

Get the uploaded bytes corresponding to the given upload ID as a stream

Specified by:

getUploadedBytes in interface UploadStorageService

Parameters:

id - the ID of the upload

Returns:

an OutputStream containing the bytes of the upload

Throws:

IOException - When retrieving the bytes from the storage layer fails

UploadNotFoundException - When the proved id is not linked to an upload

copyUploadTo

public void copyUploadTo(UploadInfo info,
                         OutputStream outputStream)
                  throws UploadNotFoundException,
                         IOException

Description copied from interface: UploadStorageService

Copy the uploaded bytes to the given output stream

Specified by:

copyUploadTo in interface UploadStorageService

Parameters:

info - The upload of which we should copy the bytes

outputStream - The output stream where we have to copy the bytes to

Throws:

UploadNotFoundException

IOException

cleanupExpiredUploads

public void cleanupExpiredUploads(UploadLockingService uploadLockingService)
                           throws IOException

Description copied from interface: UploadStorageService

Clean up any upload data that is expired according to the configured expiration time

Specified by:

cleanupExpiredUploads in interface UploadStorageService

Parameters:

uploadLockingService - An UploadLockingService that can be used to check and lock uploads

Throws:

IOException

removeLastNumberOfBytes

public void removeLastNumberOfBytes(UploadInfo uploadInfo,
                                    long byteCount)
                             throws UploadNotFoundException,
                                    IOException

Description copied from interface: UploadStorageService

Remove the given last amount of bytes from the uploaded data

Specified by:

removeLastNumberOfBytes in interface UploadStorageService

Parameters:

uploadInfo - Upload of which to remove the bytes

byteCount - The number of bytes to remove at the end

Throws:

UploadNotFoundException

IOException

terminateUpload

public void terminateUpload(UploadInfo uploadInfo)
                     throws UploadNotFoundException,
                            IOException

Description copied from interface: UploadStorageService

Terminate completed and unfinished uploads allowing the Server to free up used resources.

Specified by:

terminateUpload in interface UploadStorageService

Parameters:

uploadInfo - The upload to terminate

Throws:

UploadNotFoundException

IOException

getUploadExpirationPeriod

public Long getUploadExpirationPeriod()

Description copied from interface: UploadStorageService

Get the expiration period of an upload in milliseconds

Specified by:

getUploadExpirationPeriod in interface UploadStorageService

Returns:

The number of milliseconds before an upload expires, or null if it cannot expire

setUploadExpirationPeriod

public void setUploadExpirationPeriod(Long uploadExpirationPeriod)

Description copied from interface: UploadStorageService

Set the expiration period after which an in-progress upload expires

Specified by:

setUploadExpirationPeriod in interface UploadStorageService

Parameters:

uploadExpirationPeriod - The period in milliseconds

setUploadConcatenationService

public void setUploadConcatenationService(UploadConcatenationService concatenationService)

Description copied from interface: UploadStorageService

Set the UploadConcatenationService that this upload storage service should use

Specified by:

setUploadConcatenationService in interface UploadStorageService

Parameters:

concatenationService - The UploadConcatenationService implementation to use

getUploadConcatenationService

public UploadConcatenationService getUploadConcatenationService()

Description copied from interface: UploadStorageService

Return the UploadConcatenationService implementation that this upload service is using

Specified by:

getUploadConcatenationService in interface UploadStorageService

Returns:

The UploadConcatenationService that is being used

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