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

Interface DownloadArtifact

  • @ProviderType
public interface DownloadArtifact
    Represents a final artifact that is a result of the download creation process. The artifact will consist of a URI that can be used to retrieve the artifact, along with various peices of status information.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.net.URI getBinaryURI()
      Retrieves the URI where the artifact can be retrieved.
      java.lang.String getFailureReason()
      Retrieves a description of why the artifact failed to be created successfully.
      java.util.Map<java.lang.String,​java.lang.String> getFailures()
      Retrieves information about the items that failed to process.
      java.lang.String getId()
      Retrieves the identifier of the artifact.
      java.lang.String getMimeType()
      Retrieves the mime type of the artifact.
      java.lang.String getName()
      Retrieves the name of the artifact.
      int getSuccessCount()
      Get the number of successful files.
      java.util.Collection<java.lang.String> getSuccesses()
      Retrieves details about the items that processed correctly.

    • Method Detail

      • getId

        java.lang.String getId()
        Retrieves the identifier of the artifact.
        Returns:
        A unique artifact identifier.

      • getName

        java.lang.String getName()
        Retrieves the name of the artifact.
        Returns:
        An artifact name.

      • getMimeType

        java.lang.String getMimeType()
        Retrieves the mime type of the artifact. This will typically be the HTTP content type of the binary.
        Returns:
        A mime type.

      • getBinaryURI

        java.net.URI getBinaryURI()

        Retrieves the URI where the artifact can be retrieved. The URI might be either a path or an HTTP URL. If a path, the artifact should be requested from the same host where the download was initiated.

        If the artifact failed to generate successfully, then the URI value will be null. In this case, use getFailureReason() to get information about why the artifact failed.

        Returns:
        An HTTP URL, an absolute path, or null if there was a failure.

      • getFailureReason

        java.lang.String getFailureReason()
        Retrieves a description of why the artifact failed to be created successfully.
        Returns:
        A failure description, or null if the artifact was created successfully.

      • getSuccesses

        java.util.Collection<java.lang.String> getSuccesses()
        Retrieves details about the items that processed correctly.
        Returns:
        All of the successful items that were processed.

      • getSuccessCount

        int getSuccessCount()
        Get the number of successful files.
        Returns:
        count of successfully processed files

      • getFailures

        java.util.Map<java.lang.String,​java.lang.String> getFailures()
        Retrieves information about the items that failed to process. The presense of failures does not indicate that the artifact itself failed to process, only that one or more of the requested items could not be included in the artifact.
        Returns:
        A map whose keys are item paths and whose values are failure messages.