com.day.cq.dam.api.jobs

Interface AssetDownloadService

@ProviderType
public interface AssetDownloadService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AssetDownloadService.AssetDownloadParams

Method Summary

Modifier and Type	Method and Description
java.lang.String	assetDownload(AssetDownloadService.AssetDownloadParams params) Test URL params to see if this request should go to S7 (has image format or image presets)
java.lang.String	assetDownload(Resource configResource, java.util.Set<Resource> downloadSet, boolean downloadAssets, boolean downloadRenditions, boolean downloadSubassets, java.lang.String s7ExportSettings, java.util.Date date, java.lang.String downloadName, java.lang.String emailRecipients, java.io.OutputStream out) Test URL params to see if this request should go to S7 (has image format or image presets)
java.lang.String	assetDownload(Resource configResource, java.util.Set<Resource> downloadSet, boolean downloadAssets, boolean downloadRenditions, boolean downloadSubassets, java.lang.String s7ExportSettings, java.util.Date date, java.util.zip.ZipOutputStream out, java.lang.String downloadName, java.lang.String emailRecipients) Deprecated. since 6.5, Please use assetDownload(Resource, Set, boolean, boolean, boolean, String, Date, String, String, OutputStream) that operates with `OutputStream` instead.
AssetDownloadService.AssetDownloadParams	assetDownloadParamsReference() Deprecated.
long	computeAssetDownloadSize(AssetDownloadService.AssetDownloadParams params) Computes uncompressed size of assets requested for download

Method Detail

assetDownload

@Deprecated
java.lang.String assetDownload(Resource configResource,
                                           java.util.Set<Resource> downloadSet,
                                           boolean downloadAssets,
                                           boolean downloadRenditions,
                                           boolean downloadSubassets,
                                           java.lang.String s7ExportSettings,
                                           java.util.Date date,
                                           java.util.zip.ZipOutputStream out,
                                           java.lang.String downloadName,
                                           java.lang.String emailRecipients)

Deprecated. since 6.5, Please use assetDownload(Resource, Set, boolean, boolean, boolean, String, Date, String, String, OutputStream) that operates with `OutputStream` instead.

Test URL params to see if this request should go to S7 (has image format or image presets)

Parameters:

configResource - Resource

downloadSet - Set<Resource> Set of JcrNodeResource, which includes assets' info

downloadAssets - boolean

downloadRenditions - boolean

downloadSubassets - boolean

s7ExportSettings - String: it could be an imagePreset or a string of several modifiers; No s7export if this is null

date - Date: the export could be scheduled or execute immediately if this is null

out - ZipOutputStream, pass the output stream filter for the archive downloading

downloadName - String: download job name

emailRecipients - String: email recipients

Returns:

String: downloadUrl if the archive file is stored in jcr

assetDownload

java.lang.String assetDownload(Resource configResource,
                               java.util.Set<Resource> downloadSet,
                               boolean downloadAssets,
                               boolean downloadRenditions,
                               boolean downloadSubassets,
                               java.lang.String s7ExportSettings,
                               java.util.Date date,
                               java.lang.String downloadName,
                               java.lang.String emailRecipients,
                               java.io.OutputStream out)

Test URL params to see if this request should go to S7 (has image format or image presets)

Parameters:

configResource - Resource

downloadSet - Set<Resource> Set of JcrNodeResource, which includes assets' info

downloadAssets - boolean

downloadRenditions - boolean

downloadSubassets - boolean

s7ExportSettings - String: it could be an imagePreset or a string of several modifiers; No s7export if this is null

date - Date: the export could be scheduled or execute immediately if this is null

downloadName - String: download job name

emailRecipients - String: email recipients

out - OutputStream, pass the output stream filter for the archive downloading

Returns:

String: downloadUrl if the archive file is stored in jcr

computeAssetDownloadSize

long computeAssetDownloadSize(AssetDownloadService.AssetDownloadParams params)

Computes uncompressed size of assets requested for download

Parameters:

params - asset download options

Returns:

long: (uncompressed) size of the content requested for download (in bytes)

assetDownload

java.lang.String assetDownload(AssetDownloadService.AssetDownloadParams params)

Test URL params to see if this request should go to S7 (has image format or image presets)

Parameters:

params - asset download options

Returns:

String: downloadUrl if the archive file is stored in jcr

assetDownloadParamsReference

@Deprecated
AssetDownloadService.AssetDownloadParams assetDownloadParamsReference()

Deprecated.

parameter class for asset download service

Returns:

asset download options