com.day.cq.dam.scene7.api

Interface Scene7UploadService

public interface Scene7UploadService

The Scene7Service provides methods for interacting with the official Scene7 API.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_DEFAULT_VALUE
static String	SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_NAME

Method Summary

Modifier and Type	Method and Description
String	moveFile(String path, ResourceResolver assetResolver, ResourceResolver configResolver) Moves an S7 managed file ( a file that has an associated S7 assetHandle) at a given repository path back into the Scene7 server.
String	moveFolder(String dstpath, String srcpath, ResourceResolver assetResolver, ResourceResolver configResolver) Moves a folder (including sub folders/assets) back to the Scene7 server.
String	synchronizeFile(String path, ResourceResolver assetResolver, ResourceResolver configResolver) Synchronises a file at a given repository path back into the Scene7 server.
String	uploadFile(String path, String cloudServiceConfigPath, ResourceResolver resolver) Uploads a file at a given repository path to the Scene7 server.
String	uploadFolder(String path, String cloudServiceConfigPath, ResourceResolver resolver) Uploads a folder at a given repository path to the Scene7 server.

Field Detail

SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_NAME

static final String SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_NAME

See Also:

Constant Field Values

SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_DEFAULT_VALUE

static final int SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_DEFAULT_VALUE

See Also:

Constant Field Values

Method Detail

uploadFile

String uploadFile(String path,
                  String cloudServiceConfigPath,
                  ResourceResolver resolver)

Uploads a file at a given repository path to the Scene7 server.

Parameters:

path - Path to the file in the repository

cloudServiceConfigPath -

resolver - Sling ResourceResolver

Returns:

String 'success' if upload finished successfully or a representation of the job handle if upload failed.

uploadFolder

String uploadFolder(String path,
                    String cloudServiceConfigPath,
                    ResourceResolver resolver)

Uploads a folder at a given repository path to the Scene7 server.

Parameters:

path - to the folder

cloudServiceConfigPath -

resolver -

Returns:

String 'success' if upload finished successfully or a representation of the job handle if upload failed.

synchronizeFile

String synchronizeFile(String path,
                       ResourceResolver assetResolver,
                       ResourceResolver configResolver)

Synchronises a file at a given repository path back into the Scene7 server.

Parameters:

path - Path to the file in the repository

assetResolver - Sling ResourceResolver to access AEM asset

configResolver - Sling ResourceResolver to access AEM-Scene7 configuration

Returns:

String 'success' if upload finished successfully or a representation of the job handle if upload failed.

moveFile

String moveFile(String path,
                ResourceResolver assetResolver,
                ResourceResolver configResolver)

Moves an S7 managed file ( a file that has an associated S7 assetHandle) at a given repository path back into the Scene7 server.

Parameters:

path - Path to the file in the repository

assetResolver - Sling ResourceResolver to access AEM asset

configResolver - Sling ResourceResolver to access AEM-Scene7 configuration

Returns:

String 'success' if upload finished successfully or a representation of the job handle if upload failed.

moveFolder

String moveFolder(String dstpath,
                  String srcpath,
                  ResourceResolver assetResolver,
                  ResourceResolver configResolver)

Moves a folder (including sub folders/assets) back to the Scene7 server.

Parameters:

dstpath - destination path to the file in the repository

srcpath - Original path of the folder in the repository

assetResolver - Sling ResourceResolver to access AEM asset

configResolver - Sling ResourceResolver to access AEM-Scene7 configuration

Returns:

String 'success' if upload finished successfully or a representation of the job handle if upload failed.