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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cancelDownload​(org.alfresco.service.cmr.repository.NodeRef downloadNodeRef)
      Cancel a download request
      org.alfresco.service.cmr.repository.NodeRef createDownload​(org.alfresco.service.cmr.repository.NodeRef[] nodeRefs, boolean recusirsive)
      Start the creation of a downlaodable archive file containing the content from the given nodeRefs.
      void deleteDownloads​(java.util.Date before)
      Delete downloads created before before.
      void deleteDownloads​(java.util.Date before, int batchSize, boolean cleanAllSysDownloadFolders)
      Delete downloads created before the specified date.
      DownloadStatus getDownloadStatus​(org.alfresco.service.cmr.repository.NodeRef downloadNode)
      Get the status of the of the download identified by downloadNode.

    • Method Detail

      • createDownload

        org.alfresco.service.cmr.repository.NodeRef createDownload​(org.alfresco.service.cmr.repository.NodeRef[] nodeRefs,
                                                           boolean recusirsive)
        Start the creation of a downlaodable 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
        recusirsive - Recurse into container nodes
        Returns:
        Reference to node which will eventually contain the archive file

      • getDownloadStatus

        DownloadStatus getDownloadStatus​(org.alfresco.service.cmr.repository.NodeRef downloadNode)
        Get the status of the of the download identified by downloadNode.

      • deleteDownloads

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

      • deleteDownloads

        void deleteDownloads​(java.util.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​(org.alfresco.service.cmr.repository.NodeRef downloadNodeRef)
        Cancel a download request
        Parameters:
        downloadNodeRef - NodeRef of the download to cancel