org.codice.ddf.catalog.admin.downloadmanager

Class DownloadManagerService

java.lang.Object

org.codice.ddf.catalog.admin.downloadmanager.DownloadManagerService

All Implemented Interfaces:

DownloadManagerServiceMBean

public class DownloadManagerService
extends Object
implements DownloadManagerServiceMBean

Constructor Summary

Constructors

Constructor and Description
DownloadManagerService(DownloadStatusInfo downloadStatusInfo)

Method Summary

Modifier and Type	Method and Description
void	cancelDownload(String userId, String downloadIdentifier) Function to cancel a download.
void	destroy()
List<String>	getAllDownloads() Function to get all downloads.
List<String>	getAllDownloads(String userId) Function to get all downloads for a specific user.
List<Map<String,String>>	getAllDownloadsStatus() Function to get information about every download.
Map<String,String>	getDownloadStatus(String downloadIdentifier) Function to get information about a specific download.
void	init()
void	removeDownloadInfo(String downloadIdentifier) Function to remove the map entry corresponding to the downloadIdentifer passed it.

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadManagerService

public DownloadManagerService(DownloadStatusInfo downloadStatusInfo)

Method Detail

init

public void init()

destroy

public void destroy()

getAllDownloadsStatus

public List<Map<String,String>> getAllDownloadsStatus()

Description copied from interface: DownloadManagerServiceMBean

Function to get information about every download.

Specified by:

getAllDownloadsStatus in interface DownloadManagerServiceMBean

Returns:

Returns the information in an array of maps, where each map holds information about a specific download; attributes are: "percent" (percent completed) "downloadId" (randomly generated downloadId assigned to each download at its beginning) "status" (status of download, e.g. "COMPLETED", "IN_PROGRESS" etc) "bytesDownloaded" (count of bytes that have been downloaded to cache) "fileName" (name of the file being downloaded) "user" (identifer of the user performing the download)

getDownloadStatus

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

Description copied from interface: DownloadManagerServiceMBean

Function to get information about a specific download.

Specified by:

getDownloadStatus in interface DownloadManagerServiceMBean

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.

getAllDownloads

public List<String> getAllDownloads()

Description copied from interface: DownloadManagerServiceMBean

Function to get all downloads.

Specified by:

getAllDownloads in interface DownloadManagerServiceMBean

Returns:

Returns an array of downloadIdentifier Strings

getAllDownloads

public List<String> getAllDownloads(String userId)

Description copied from interface: DownloadManagerServiceMBean

Function to get all downloads for a specific user.

Specified by:

getAllDownloads in interface DownloadManagerServiceMBean

Parameters:

userId - The id of the user.

Returns:

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

removeDownloadInfo

public void removeDownloadInfo(String downloadIdentifier)

Description copied from interface: DownloadManagerServiceMBean

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 DownloadManagerServiceMBean

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: DownloadManagerServiceMBean

Function to cancel a download.

Specified by:

cancelDownload in interface DownloadManagerServiceMBean

Parameters:

userId - The id of the user who is performing the download.

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