org.aktin.broker.download

Class DownloadManager

java.lang.Object

org.aktin.broker.download.DownloadManager

@Singleton
public class DownloadManager
extends Object

Creates and manages downloads which expire after a predefined amount of time. This class is useful to separate authentication (needed to request downloads) from the actual download. The browser does not send authentication headers (e.g. bearer token) to download links.

Author:

R.W.Majeed

Constructor Summary

Constructors

Constructor and Description
DownloadManager()
DownloadManager(Path tempDir)

Method Summary

Modifier and Type	Method and Description
void	cleanupExpired() Cleanup expired downloads.
Download	createDataSourceDownload(DataSource ds, String name) Create download to a given local path.
Download	createTemporaryFile(String mediaType, String name) Create a temporary file for download.
Download	get(UUID id) Retrieve a download for the given id.
void	setTempDirectory(Path dir) Set the directory where temporary downloads will be created and stored before they expire.

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadManager

public DownloadManager()

DownloadManager

public DownloadManager(Path tempDir)
                throws IOException

Throws:

IOException

Method Detail

setTempDirectory

public void setTempDirectory(Path dir)
                      throws IOException

Set the directory where temporary downloads will be created and stored before they expire. If the specified path does not exist, the directory will be created.

Parameters:

dir - path to store temporary download files

Throws:

IOException - IO error because directories could not be created

get

public Download get(UUID id)
             throws IOException

Retrieve a download for the given id. Non-existing and expired downloads will return null.

Parameters:

id - id for the download to be retrieved

Returns:

download or null if not found or expired

Throws:

IOException - IO error

createDataSourceDownload

public Download createDataSourceDownload(DataSource ds,
                                         String name)

Create download to a given local path. The path will not be deleted once the download expires.

Parameters:

ds - data source for download

name - optional name for download

Returns:

Download

createTemporaryFile

public Download createTemporaryFile(String mediaType,
                                    String name)
                             throws IOException

Create a temporary file for download. Once the download expires, the file will be deleted.

Parameters:

mediaType - media type for the download

name - optional file name for the download, null to omit

Returns:

download

Throws:

IOException - IO error

cleanupExpired

public void cleanupExpired()
                    throws IOException

Cleanup expired downloads.

Throws:

IOException - io error