Package org.alfresco.service.cmr.download

Interface DownloadService

All Known Implementing Classes:
DownloadServiceImpl
public interface DownloadService
Zip download service. Implementations are responsible for triggering the Zip creation process and reporting on the status of the of this process.
Author:
Alex Miller

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancelDownload(NodeRef downloadNodeRef)
    Cancel a download request
    NodeRef
    createDownload(NodeRef[] nodeRefs, boolean recursive)
    Start the creation of a downloadable archive file containing the content from the given nodeRefs.
    NodeRef
    createDownload(NodeRef[] nodeRefs, boolean recursive, String downloadNodeName)
    Start the creation of a downloadable archive file containing the content from the given nodeRefs.
    void
    deleteDownloads(Date before)
    Delete downloads created before before.
    void
    deleteDownloads(Date before, int batchSize, boolean cleanAllSysDownloadFolders)
    Delete downloads created before the specified date.
    DownloadStatus
    getDownloadStatus(NodeRef downloadNode)
    Get the status of the of the download identified by downloadNode.

  • Method Details

    • createDownload

      NodeRef createDownload(NodeRef[] nodeRefs, boolean recursive)
      Start the creation of a downloadable archive file containing the content from the given nodeRefs. Implementations are expected to do this asynchronously, with clients using the returned NodeRef to check on progress. Initially, only zip files will be supported, however this could be extended in the future, to support additional archive types.
      Parameters:
      nodeRefs - NodeRefs of content to be added to the archive file
      recursive - Recurse into container nodes
      Returns:
      Reference to node which will eventually contain the archive file

    • createDownload

      NodeRef createDownload(NodeRef[] nodeRefs, boolean recursive, String downloadNodeName)
      Start the creation of a downloadable archive file containing the content from the given nodeRefs. Implementations are expected to do this asynchronously, with clients using the returned NodeRef to check on progress. Initially, only zip files will be supported, however this could be extended in the future, to support additional archive types.
      Parameters:
      nodeRefs - NodeRefs of content to be added to the archive file
      recursive - Recurse into container nodes
      downloadNodeName - Download node name
      Returns:
      Reference to node which will eventually contain the archive file

    • getDownloadStatus

      DownloadStatus getDownloadStatus(NodeRef downloadNode)
      Get the status of the of the download identified by downloadNode.

    • deleteDownloads

      void deleteDownloads(Date before)
      Delete downloads created before before.
      Parameters:
      before - Date

    • deleteDownloads

      void deleteDownloads(Date before, int batchSize, boolean cleanAllSysDownloadFolders)
      Delete downloads created before the specified date. It also limits the number of deleted files for this batch of work to the specified batchSize; It can also look into deleting downloads files from all sys:Download folders affected by MNT-20212

    • cancelDownload

      void cancelDownload(NodeRef downloadNodeRef)
      Cancel a download request
      Parameters:
      downloadNodeRef - NodeRef of the download to cancel