com.day.cq.dam.api.s7dam.utils.SampleUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

package com.day.cq.dam.api.s7dam.utils;

import org.osgi.annotation.versioning.ProviderType;

/**
 * The SampleUtils service provides calls to prepare DM sample assets and
 * presets for DMS7 integration.
 */
@ProviderType
public interface SampleUtils {

    /**
     * Copy DM sample assets from standard location to targetFolder for sync.
     *
     * The standard location is /libs/dam/preview/.
     *
     * @param targetFolder target folder path to which the DM sample assets are to be copied to
     * @throws Exception error which copying DM sample assets from standard location to targetFolder for sync.
     */
    void processSampleAssets(String targetFolder) throws Exception;

    /**
     * Iterate viewer presets in standard location and copy to related CSS and
     * artwork to targetFolder for sync. Update viewer preset nodes to point to
     * new CSS location.
     *
     * The standard location is /etc/dam/presets/viewer/.
     *
     * @param targetFolder target folder path to which the CSS and artwork are to be copied to
     * @throws Exception error which iterating and copying data from standard location to targetFolder for sync.
     */
    void processPresetAssets(String targetFolder) throws Exception;
}