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

Interface DownloadManifest

@ProviderType
public interface DownloadManifest

Provides a means for specifying which binaries should be included in a download.

The manifest primarily consists of one or more DownloadTarget items that the consumer needs to download. The DownloadService will convert these targets into one or more URIs that will be provided as the output of the download process.

See Also:

DownloadService, DownloadTarget, DownloadTargetProcessor

Method Summary

Modifier and Type	Method	Description
void	addTarget(DownloadTarget target)	Adds a new DownloadTarget item to the manifest.
java.util.Map<java.lang.String,java.lang.Object>	getParameters()	Retrieves all the parameter options to be applied on this download
int	getTargetCount()	Retrieves the total number of targets that are included in the manifest.
java.util.Collection<DownloadTarget>	getTargets()	Retrieves all of the DownloadTarget items that have been added to the manifest.

Method Detail

getTargetCount

int getTargetCount()

Retrieves the total number of targets that are included in the manifest.

Returns:

Number of targets.

addTarget

void addTarget(DownloadTarget target)

Adds a new DownloadTarget item to the manifest. This flavor accepts an instance of DownloadTarget, which might be helpful in cases where more control over the target may be required.

Parameters:

target - The target to add to the manifest's list of targets.

getTargets

java.util.Collection<DownloadTarget> getTargets()

Retrieves all of the DownloadTarget items that have been added to the manifest.

Returns:

The manifest's targets.

getParameters

java.util.Map<java.lang.String,java.lang.Object> getParameters()

Retrieves all the parameter options to be applied on this download

Returns:

map of the parameters