com.pb.downloadmanager.api.downloaders

Interface Downloader

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

LocalFilePassthroughDownloader

public interface Downloader
extends java.io.Serializable

A Downloader consumes a Downloadable, which contains a remote file location, and will download it to the local file system. If the Downloadable has the unarchive flag set to true then the Downloader will examine the download, and if the download is a supported archive then the download will be extracted and the extracted folder will be the path in the DownloadResult. If the download process was skipped (e.g. the file was cached from a previous download) then the DownloadResult's isDownloadSkipped flag must be set to true. Implement WorkspaceDownloader if you want caching, file-locking, versioning, and extracting handled for you.

Method Summary

Modifier and Type	Method and Description
DownloadResult	download(Downloadable downloadable) Handles the entire management of the download process.
boolean	supports(java.lang.String path) Indicates whether an implementation can handle this remote path.

Method Detail

download

DownloadResult download(Downloadable downloadable)

Handles the entire management of the download process. An implementation could include caching, downloading, extracting, file-locking, etc. Each download will be called asynchronously by the DownloadManager.

Parameters:

downloadable - The download request containing the location of the remote resource

Returns:

The result of the download containing the local filesystem path of the downloaded resource

supports

boolean supports(java.lang.String path)

Indicates whether an implementation can handle this remote path. This is typically decided based on the path's scheme.

Parameters:

path - The path to be downloaded

Returns:

true if this Downloader implementation can handle this path