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

Interface S7Config

  • @ProviderType
public interface S7Config
    Scene7 server access configuration.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  S7Config.SyncMode  

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void close()
      Close ResourceResolver embedded into this S7Config instance, if necessary.
      java.lang.String get​(java.lang.String prop)
      Returns a property of this configuration with the specified name.
      java.lang.String getAdhocFolder()
      Returns the Scene7 ad-hoc folder for this configuration.
      java.lang.String getAllMimeTypeJobParams()
      Returns the Scene7 upload job parameters configured under the scene7 config
      java.lang.String getBasePath()
      Returns the top most folder of the S7 company associated with this configuration.
      java.lang.String getCachedPreviewServerToken()
      Returns the cached jwt token issued by IPS, to be used to authenticate by ImageServing Preview.
      java.lang.String getCloudConfigPath()
      Returns the configuration path of this configuration.
      java.lang.String getCompanyHandle()
      Returns the company handle associated with this configuration.
      S7Config.SyncMode getDefaultSyncMode()  
      java.lang.String getEmail()
      Returns the email address used for this configuration.
      java.lang.String getFlashTemplatesServer()
      Deprecated.
      java.lang.String getFXGServer()
      Deprecated.
      java.lang.String getImportQueueName()
      Returns the name of the import queue
      java.lang.String getImportQueueTopic()
      Returns the topic of the associated import queue
      java.lang.Boolean getMimeTypeEnabled​(java.lang.String mimeType)
      Returns if enable the S7 uploading with given MIME type, by default return true if cannot find the value
      java.lang.String getMimeTypeJobParams​(java.lang.String mimeType)
      Returns the Scene7 upload job parameters associated with given MIME type
      java.lang.String getMimeTypeJobParams​(java.lang.String mimeType, java.lang.Boolean addCommonJobParam)
      Returns the Scene7 upload job parameters associated with given MIME type
      java.lang.String getPassword()
      Returns the encrypted password for the S7 service associated with this cloud configuration.
      java.lang.String getPreviewableServer()
      Returns the proper server for previewing, it return previewServer always regardless if immediate mode It was designed to return server by checking immediate mode or not, but envolved into always return new preview server
      java.lang.String getPreviewServer()
      Returns the Scene7 configured preview server.
      InheritanceValueMap getPropertiesMap()
      Returns the properties held in this S7 configuration object.
      Scene7PublishMode getPublishMode()
      Returns the secure preview feature state support status as a string.
      java.lang.String getPublishServer()
      Returns the Scene7 configured publish server.
      java.lang.String getRegion()
      Returns the region for this configuration.
      java.lang.String getRootPath()
      Returns the root path of the Scene7 company hierarchy (not to be confused with the actual physical path on the S7 servers).
      java.lang.String getTargetPath()
      Returns the target path where the Scene7 assets are downloaded into CQ DAM.
      java.lang.String getUserHandle()
      Returns the user handle associated with this configuration.
      boolean isDefault()
      Returns the default status of this configuration
      java.lang.String isDelayedPublishEnabled()
      Deprecated.
      boolean isMimeTypeDenied​(java.lang.String mimeType)
      Check if mimeType is denied or not
      java.lang.String isPublishEnabled()
      Deprecated.
      use isDelayedPublishEnabled()
      boolean isSelectiveSyncEnabled()  
      java.lang.String isSyncEnabled()
      Returns the synchronisation status as a string.
      void setJCRContentProperty​(java.lang.String property, java.lang.String value)
      Sets the param value at the Jcr:Content level
      void setMimeTypeJobParams​(java.lang.String mimeType, java.lang.String jobParams)
      sets the upload job Params of given mimetype

    • Method Detail

      • getCloudConfigPath

        java.lang.String getCloudConfigPath()
        Returns the configuration path of this configuration.
        Returns:
        the s7 cloud configuration path

      • getEmail

        java.lang.String getEmail()
        Returns the email address used for this configuration.
        Returns:
        email address for the s7 cloud configuration

      • getPassword

        java.lang.String getPassword()
        Returns the encrypted password for the S7 service associated with this cloud configuration. To decrypt the password use the CryptoSupport's unprotect method.
        Returns:
        encrypted password for s7 service associated with this cloud configuration

      • getRegion

        java.lang.String getRegion()
        Returns the region for this configuration.
        Returns:
        associated s7 server region associated with this cloud configuration

      • getUserHandle

        java.lang.String getUserHandle()
        Returns the user handle associated with this configuration.
        Returns:
        the user handle associated with the s7 server account

      • getCompanyHandle

        java.lang.String getCompanyHandle()
        Returns the company handle associated with this configuration.
        Returns:
        the company handle associated with the s7 server account

      • getRootPath

        java.lang.String getRootPath()
        Returns the root path of the Scene7 company hierarchy (not to be confused with the actual physical path on the S7 servers).
        Returns:
        virtual root path

      • isSyncEnabled

        java.lang.String isSyncEnabled()
        Returns the synchronisation status as a string.
        Returns:
        string value ("on/"off") that controls whether previously published folders/assets are kept in sync from cq to s7 when moved or updated

      • isDelayedPublishEnabled

        @Deprecated
java.lang.String isDelayedPublishEnabled()
        Deprecated.
        Returns the secure preview feature state support status as a string.
        Returns:
        string value ("on/"off") that controls whether DAM asset activation state reflects Scene7 asset MarkForPublish state

      • getPublishMode

        Scene7PublishMode getPublishMode()
        Returns the secure preview feature state support status as a string.
        Returns:
        string value ("IMMEDIATE/"ML"/"SELECTIVE") that controls whether DAM asset activation state reflects Scene7 asset MarkForPublish state

      • isPublishEnabled

        @Deprecated
java.lang.String isPublishEnabled()
        Deprecated.
        use isDelayedPublishEnabled()
        Returns the secure preview feature state support status as a string.
        Returns:
        string value ("on/"off") that controls whether DAM asset activation state reflects Scene7 asset MarkForPublish state

      • getBasePath

        java.lang.String getBasePath()
        Returns the top most folder of the S7 company associated with this configuration.
        Returns:
        company root folder

      • get

        java.lang.String get​(java.lang.String prop)
        Returns a property of this configuration with the specified name.
        Parameters:
        prop - the property's name
        Returns:
        the value of the property

      • getPropertiesMap

        InheritanceValueMap getPropertiesMap()
        Returns the properties held in this S7 configuration object.
        Returns:
        the properties map

      • getPublishServer

        java.lang.String getPublishServer()
        Returns the Scene7 configured publish server.
        Returns:
        a String with the server's URL

      • getPreviewServer

        java.lang.String getPreviewServer()
        Returns the Scene7 configured preview server.
        Returns:
        a String with the server's URL

      • getPreviewableServer

        java.lang.String getPreviewableServer()
        Returns the proper server for previewing, it return previewServer always regardless if immediate mode It was designed to return server by checking immediate mode or not, but envolved into always return new preview server
        Returns:
        a String with the server's URL

      • getCachedPreviewServerToken

        java.lang.String getCachedPreviewServerToken()
        Returns the cached jwt token issued by IPS, to be used to authenticate by ImageServing Preview.
        Returns:
        a String with the jwt token

      • getFlashTemplatesServer

        @Deprecated
java.lang.String getFlashTemplatesServer()
        Deprecated.
        Returns the configured Scene7 Flash Templates server.
        Returns:
        a String with the server's URL

      • getTargetPath

        java.lang.String getTargetPath()
        Returns the target path where the Scene7 assets are downloaded into CQ DAM.
        Returns:
        a String containing the full path where the Scene7 assets will be saved into DAM

      • isDefault

        boolean isDefault()
        Returns the default status of this configuration
        Returns:
        boolean value indicating if this S7 configuration is the default one

      • getFXGServer

        @Deprecated
java.lang.String getFXGServer()
        Deprecated.
        Returns the cached S7 FXG endpoint URL. Deprecated and only return null now.
        Returns:
        a String containing the FXG URL

      • getAdhocFolder

        java.lang.String getAdhocFolder()
        Returns the Scene7 ad-hoc folder for this configuration.
        Returns:
        a String containing the ad-hoc folder path

      • getImportQueueName

        java.lang.String getImportQueueName()
        Returns the name of the import queue
        Returns:
        a String containing the name of the import queue

      • getImportQueueTopic

        java.lang.String getImportQueueTopic()
        Returns the topic of the associated import queue
        Returns:
        a String containing the import queue topic

      • getMimeTypeJobParams

        java.lang.String getMimeTypeJobParams​(java.lang.String mimeType)
        Returns the Scene7 upload job parameters associated with given MIME type
        Parameters:
        mimeType - asset MIME type
        Returns:
        a String containing all Scene7 upload job parameters

      • getMimeTypeJobParams

        java.lang.String getMimeTypeJobParams​(java.lang.String mimeType,
                                      java.lang.Boolean addCommonJobParam)
        Returns the Scene7 upload job parameters associated with given MIME type
        Parameters:
        mimeType - asset MIME type
        addCommonJobParam - add common job params
        Returns:
        a String containing all Scene7 upload job parameters

      • getAllMimeTypeJobParams

        java.lang.String getAllMimeTypeJobParams()
        Returns the Scene7 upload job parameters configured under the scene7 config
        Returns:
        a String containing all Scene7 upload job parameters

      • setMimeTypeJobParams

        void setMimeTypeJobParams​(java.lang.String mimeType,
                          java.lang.String jobParams)
        sets the upload job Params of given mimetype
        Parameters:
        mimeType - asset MIME type
        jobParams - job params

      • getMimeTypeEnabled

        java.lang.Boolean getMimeTypeEnabled​(java.lang.String mimeType)
        Returns if enable the S7 uploading with given MIME type, by default return true if cannot find the value
        Parameters:
        mimeType - asset MIME type
        Returns:
        Boolean indicate if we sync such mimetype assets to S7

      • isSelectiveSyncEnabled

        boolean isSelectiveSyncEnabled()

      • close

        void close()
        Close ResourceResolver embedded into this S7Config instance, if necessary. You must call this method explicitly when this S7Config instance was obtained from factory methods which instantiate the new ResourceResolver (i.e. when factory method has no input ResourceResolver parameter).

      • setJCRContentProperty

        void setJCRContentProperty​(java.lang.String property,
                           java.lang.String value)
        Sets the param value at the Jcr:Content level
        Parameters:
        property - param name
        value - param value

      • isMimeTypeDenied

        boolean isMimeTypeDenied​(java.lang.String mimeType)
        Check if mimeType is denied or not
        Parameters:
        mimeType -