com.day.cq.dam.api.s7dam.jobs

Interface S7damExportService

public interface S7damExportService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	S7_PRESET The DAM export job type.

Method Summary

Modifier and Type	Method and Description
boolean	downloadAndExtractFiles(java.util.List<java.lang.String> fileLocations, java.util.Set<Asset> assets, java.lang.String s7ExportSettings, java.util.zip.ZipOutputStream zo, Resource configResource, java.lang.Boolean flatStructure) Download assets with s7dam settings and write to the zip file.
java.lang.String	export(Resource configResource, java.util.Set<Asset> assets, java.lang.String s7ExportSettings, java.lang.String exportJobName) S7dam Export.
java.util.List<java.lang.String>	getExportUrls(java.lang.String jcrPath, java.util.Set<Asset> assets, java.lang.String s7ExportSettings, Resource configResource) Get the downloadUrls that points to the exported archive file.
void	removeJobStatusNode(Resource configResource, java.lang.String nodeName) Clean up the job's info from jcr after the job is done.

Field Detail

S7_PRESET

static final java.lang.String S7_PRESET

The DAM export job type.

See Also:

Constant Field Values

Method Detail

export

java.lang.String export(Resource configResource,
                        java.util.Set<Asset> assets,
                        java.lang.String s7ExportSettings,
                        java.lang.String exportJobName)

S7dam Export.

Parameters:

configResource - The cloud config resource

assets - type: Set (the export assets)

s7ExportSettings - type: String: It could be an imagePreset or a string of several modifiers

exportJobName - type: String

Returns:

String hosted: returns a JCR node name. It is for getting the updated export job status if it is done successfully. onprem: returns an empty string.

downloadAndExtractFiles

boolean downloadAndExtractFiles(java.util.List<java.lang.String> fileLocations,
                                java.util.Set<Asset> assets,
                                java.lang.String s7ExportSettings,
                                java.util.zip.ZipOutputStream zo,
                                Resource configResource,
                                java.lang.Boolean flatStructure)

Download assets with s7dam settings and write to the zip file.

Parameters:

fileLocations - type: List (the url to get the S7 asset(s) bytes)

assets - type: Set (to save the S7 assets to their corresponding folders by the export file names)

s7ExportSettings - type: String: It could be an imagePreset or a string of several modifiers

zo - type: ZipOutputStream (the export zip out stream)

configResource - config resource

Returns:

boolean

getExportUrls

java.util.List<java.lang.String> getExportUrls(java.lang.String jcrPath,
                                               java.util.Set<Asset> assets,
                                               java.lang.String s7ExportSettings,
                                               Resource configResource)

Get the downloadUrls that points to the exported archive file.

Parameters:

jcrPath - type: String value (hosted): it is used to fetch the downloadUrl which is generated after a S7 export job (onprem): it is an empty string

assets - type: Set (the export assets with the path info)

s7ExportSettings - type: String: It could be an imagePreset or a string of several modifiers

configResource - config resource

flatStructure - type: boolean indicating whether or not to create subfolders for dynamic media assets

Returns:

List

removeJobStatusNode

void removeJobStatusNode(Resource configResource,
                         java.lang.String nodeName)

Clean up the job's info from jcr after the job is done.

Parameters:

configResource - The cloud config resource

nodeName - type: String: the name of the jcrNode that saved the S7 downloadUrl