ddf.catalog.event.retrievestatus

Interface DownloadStatusInfo

All Known Implementing Classes:

DownloadStatusInfoImpl

public interface DownloadStatusInfo

This class is a backend information gathering and aggregation class. It holds information about all downloads and then returns this information when requested, usually by DownloadManagerService. Most of the information is accessed through a reference to the ReliableResourceDownloadManager responsible for the download.

Method Summary

Modifier and Type	Method and Description
void	addDownloadInfo(String downloadIdentifier, ReliableResourceDownloader downloader, ResourceResponse resourceResponse) Adds a ReliableResourceDownloadManager to the Map, which is used by this.getDownloadStatus.
void	cancelDownload(String userId, String downloadIdentifier) Function for admin to cancel a download.
List<String>	getAllDownloads() Function to get all downloads.
List<String>	getAllDownloads(String userId) Function to get all downloads for a specific user.
Map<String,String>	getDownloadStatus(String downloadIdentifier) Function to get information about a specific download.
void	removeDownloadInfo(String downloadIdentifier) Function to remove the map entry corresponding to the downloadIdentifer passed it.

Method Detail

addDownloadInfo

void addDownloadInfo(String downloadIdentifier,
                     ReliableResourceDownloader downloader,
                     ResourceResponse resourceResponse)

Adds a ReliableResourceDownloadManager to the Map, which is used by this.getDownloadStatus. Currently this is called in ReliableResourceDownloadManager

Parameters:

downloadIdentifier - Randomly generated String assigned to download at its start.

downloadManager - The Object that handles the download; this uses it to gather information about the download.

getAllDownloads

List<String> getAllDownloads()

Function to get all downloads.

Returns:

Returns an array of downloadIdentifier Strings

getAllDownloads

List<String> getAllDownloads(String userId)

Function to get all downloads for a specific user.

Parameters:

userId - The id of the user.

Returns:

Returns an array of downloadIdentifier Strings, similar to this.getAllDownloads.

getDownloadStatus

Map<String,String> getDownloadStatus(String downloadIdentifier)

Function to get information about a specific download.

Parameters:

downloadIdentifier - The randomly generated downloadId string assigned to the download at its start.

Returns:

Returns a map of attributes describing the download; see this.getAllDownloadsStatus for details.

removeDownloadInfo

void removeDownloadInfo(String downloadIdentifier)

Function to remove the map entry corresponding to the downloadIdentifer passed it. This means it will no longer be returned by this.getAllDownloadsStatus, this.getDownloadStatus, or this.getAllDownloads.

Parameters:

downloadIdentifier - The randomly generated downloadId string assigned to the download at its start.

cancelDownload

void cancelDownload(String userId,
                    String downloadIdentifier)

Function for admin to cancel a download. Throws a "cancel" event.

Parameters:

userId - The Id assigned to the user who is downloading.

downloadIdentifier - The randomly generated downloadId string assigned to the download at its start.