Package com.adobe.cq.dam.download.api

Interface DownloadApiFactory

@ProviderType public interface DownloadApiFactory

Factory interface for creating various objects whose implementations depend on the type of service being implemented.

Implementers of custom DownloadService implementations should implement this interface to return dependencies whose types are applicable to the custom service.

See Also:

  • Method Details

    • createDownloadManifest

      DownloadManifest createDownloadManifest()
      Creates a new manifest instance for use with the DownloadService.
      Returns:
      An empty manifest.

    • createDownloadFile

      DownloadFile createDownloadFile(Optional<Long> size, URI binaryURI, Map<String,Object> parameters)
      Creates a new instance for use with a DownloadTargetProcessor.
      Parameters:
      size - The size, in bytes, of the file.
      binaryURI - URI to the file's binary data.
      parameters - Additional data to include with the file.
      Returns:
      An initialized instance that uses the provided values.

    • createFailedDownloadFile

      DownloadFile createFailedDownloadFile(String failureReason, Map<String,Object> parameters)
      Creates a representation of a failed download file.
      Parameters:
      failureReason - The reason this download file should be considered failed.
      parameters - Additional data to include with the file.
      Returns:
      An initialized instance that uses the provided values.

    • createDownloadTarget

      DownloadTarget createDownloadTarget(String targetType, Map<String,Object> parameters)
      Creates a new instance for use with a DownloadManifest.
      Parameters:
      targetType - The target's DownloadTarget.getType() value.
      parameters - Parameters to be retrieved using the target's getParameter() methods.
      Returns:
      An initialized target instance that uses the provided values.