Package com.day.cq.dam.scene7.api

Interface Scene7UploadService

@ProviderType public interface Scene7UploadService
The Scene7Service provides methods for interacting with the official Scene7 API.

  • Field Details

    • SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_NAME

      static final String SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_NAME
      See Also:

    • SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_DEFAULT_VALUE

      static final int SCR_PROP_NAME_ACTIVE_JOB_TIMEOUT_DEFAULT_VALUE
      See Also:

    • SCR_PROP_NAME_CONN_MAX_PER_ROUTE_NAME

      static final String SCR_PROP_NAME_CONN_MAX_PER_ROUTE_NAME
      See Also:

    • SCR_PROP_NAME_CONN_MAX_PER_ROUTE_DEFAULT_VALUE

      static final int SCR_PROP_NAME_CONN_MAX_PER_ROUTE_DEFAULT_VALUE
      See Also:

  • Method Details

    • 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 Scene7 job handle

    • 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

      @Deprecated String moveFile(String path, ResourceResolver assetResolver, ResourceResolver configResolver)
      Deprecated.
      use Scene7Service.moveAsset(S7Config,Resource,String) instead
      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

      @Deprecated String moveFolder(String dstpath, String srcpath, ResourceResolver assetResolver, ResourceResolver configResolver)
      Deprecated.
      use Scene7Service.moveFolder(S7Config,String,String) instead
      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.

    • getActiveJobTimeOut

      long getActiveJobTimeOut()
      Retrieve Scene7 upload job timeout parameter
      Returns:
      long Scene7 active job timeout

    • getConnectionMaxPerRoute

      int getConnectionMaxPerRoute()
      Retrieve Scene7 upload job maximum number of connections
      Returns:
      int Scene7 connections