com.day.cq.dam.scene7.api

Interface Scene7UploadService

public interface Scene7UploadService

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	moveFile(java.lang.String path, ResourceResolver resolver) Deprecated. No longer supported. Replaced by moveFile(String, ResourceResolver, ResourceResolver)
java.lang.String	moveFile(java.lang.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.
java.lang.String	moveFolder(java.lang.String dstpath, java.lang.String srcpath, ResourceResolver resolver) Deprecated. No longer supported. Replaced by moveFolder(String, String, ResourceResolver, ResourceResolver)
java.lang.String	moveFolder(java.lang.String dstpath, java.lang.String srcpath, ResourceResolver assetResolver, ResourceResolver configResolver) Moves a folder (including sub folders/assets) back to the Scene7 server.
java.lang.String	synchronizeFile(java.lang.String path, ResourceResolver resolver) Deprecated. No longer supported. Replaced by synchronizeFile(String, ResourceResolver, ResourceResolver)
java.lang.String	synchronizeFile(java.lang.String path, ResourceResolver assetResolver, ResourceResolver configResolver) Synchronises a file at a given repository path back into the Scene7 server.
java.lang.String	uploadFile(java.lang.String path, java.lang.String cloudServiceConfigPath, ResourceResolver resolver) Uploads a file at a given repository path to the Scene7 server.
java.lang.String	uploadFolder(java.lang.String path, java.lang.String cloudServiceConfigPath, ResourceResolver resolver) Uploads a folder at a given repository path to the Scene7 server.
java.lang.String	uploadFolder(java.lang.String path, java.lang.String cloudServiceConfigPath, ResourceResolver assetResolver, ResourceResolver configResolver) Uploads a folder at a given repository path to the Scene7 server.

Method Detail

uploadFile

java.lang.String uploadFile(java.lang.String path,
                            java.lang.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

java.lang.String uploadFolder(java.lang.String path,
                              java.lang.String cloudServiceConfigPath,
                              ResourceResolver resolver)

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

Parameters:

path - to the folder

cloudServiceConfigPath -

resolver - Sling ResourceResolver to access DAM asset resource / node and AEM-S7 cloud configuration

Returns:

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

uploadFolder

java.lang.String uploadFolder(java.lang.String path,
                              java.lang.String cloudServiceConfigPath,
                              ResourceResolver assetResolver,
                              ResourceResolver configResolver)

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

Parameters:

path - to the folder

cloudServiceConfigPath -

assetResolver - Sling ResourceResolver to access DAM asset resource / node

configResolver - Sling ResourceResolver to access AEM-S7 cloud configuration

Returns:

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

synchronizeFile

@Deprecated
java.lang.String synchronizeFile(java.lang.String path,
                                             ResourceResolver resolver)

Deprecated. No longer supported. Replaced by synchronizeFile(String, ResourceResolver, ResourceResolver)

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

Parameters:

path - Path to the file in the repository

resolver - Sling ResourceResolver

Returns:

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

synchronizeFile

java.lang.String synchronizeFile(java.lang.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 DAM asset resource / node

configResolver - Sling ResourceResolver to access AEM-S7 cloud configuration

Returns:

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

moveFile

@Deprecated
java.lang.String moveFile(java.lang.String path,
                                      ResourceResolver resolver)

Deprecated. No longer supported. Replaced by moveFile(String, ResourceResolver, ResourceResolver)

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

resolver - Sling ResourceResolver

Returns:

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

moveFile

java.lang.String moveFile(java.lang.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 DAM asset resource / node

configResolver - Sling ResourceResolver to access AEM-S7 cloud configuration

Returns:

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

moveFolder

@Deprecated
java.lang.String moveFolder(java.lang.String dstpath,
                                        java.lang.String srcpath,
                                        ResourceResolver resolver)

Deprecated. No longer supported. Replaced by moveFolder(String, String, ResourceResolver, ResourceResolver)

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

resolver - Sling ResourceResolver

Returns:

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

moveFolder

java.lang.String moveFolder(java.lang.String dstpath,
                            java.lang.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 DAM asset resource / node

configResolver - Sling ResourceResolver to access AEM-S7 cloud configuration

Returns:

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