ddf.catalog.event.retrievestatus

Class DownloadStatusInfoImpl

java.lang.Object

ddf.catalog.event.retrievestatus.DownloadStatusInfoImpl

All Implemented Interfaces:

DownloadStatusInfo

public class DownloadStatusInfoImpl
extends Object
implements DownloadStatusInfo

Constructor Summary

Constructors

Constructor and Description
DownloadStatusInfoImpl()

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.
void	setEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadStatusInfoImpl

public DownloadStatusInfoImpl()

Method Detail

setEventAdmin

public void setEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)

addDownloadInfo

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

Description copied from interface: DownloadStatusInfo

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

Specified by:

addDownloadInfo in interface DownloadStatusInfo

Parameters:

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

getAllDownloads

public List<String> getAllDownloads()

Description copied from interface: DownloadStatusInfo

Function to get all downloads.

Specified by:

getAllDownloads in interface DownloadStatusInfo

Returns:

Returns an array of downloadIdentifier Strings

getAllDownloads

public List<String> getAllDownloads(String userId)

Description copied from interface: DownloadStatusInfo

Function to get all downloads for a specific user.

Specified by:

getAllDownloads in interface DownloadStatusInfo

Parameters:

userId - The id of the user.

Returns:

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

getDownloadStatus

public Map<String,String> getDownloadStatus(String downloadIdentifier)

Description copied from interface: DownloadStatusInfo

Function to get information about a specific download.

Specified by:

getDownloadStatus in interface DownloadStatusInfo

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

public void removeDownloadInfo(String downloadIdentifier)

Description copied from interface: DownloadStatusInfo

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.

Specified by:

removeDownloadInfo in interface DownloadStatusInfo

Parameters:

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

cancelDownload

public void cancelDownload(String userId,
                           String downloadIdentifier)

Description copied from interface: DownloadStatusInfo

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

Specified by:

cancelDownload in interface DownloadStatusInfo

Parameters:

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

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