Package com.adobe.cq.ui.wcm.commons.config

Interface NextGenDynamicMediaConfig

  • public interface NextGenDynamicMediaConfig
    Provides configuration properties for the Next Generation Dynamic Media integration

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean enabled()
      Checks if the configuration/feature is enabled.
      java.lang.String getApiKey()
      Gets the API key for accessing the asset selectors UI
      java.lang.String getAssetMetadataPath()
      Gets the path expression for getting the metadata of an asset.
      java.lang.String getAssetOriginalBinaryDeliveryPath()
      Gets the path expression for the the Original Asset Delivery which delivers the bitstream as-is {asset-id} - the uuid of the asset in the format 'urn:aaid:aem:UUID', e.g.
      java.lang.String getAssetSelectorsJsUrl()
      Gets the absolute URL for the javascript which contains the microfrontend for the remote asset selector.
      java.lang.String getEnv()
      Gets the environment string which should be 'PROD' or 'STAGE'
      java.lang.String getImageDeliveryBasePath()
      Gets the path expression for the image delivery path.
      java.lang.String getImsClient()
      Gets the IMS client identifier
      java.lang.String getImsEnv()
      Deprecated.
      No replacement.
      java.lang.String getImsOrg()
      Deprecated.
      No replacement.
      java.lang.String getRepositoryId()
      Gets the Next Generation Dynamic Media tenant (also known technically as the repository Id) This would typically be a host name with the format 'delivery-pXX-eYY.adobeaemcloud.com' for PROD environments and 'delivery-pXX-eYY-smstg.adobeaemcloud.com' for STAGE environments.
      java.lang.String getVideoDeliveryPath()
      Gets the path expression for the adaptive video manifest/player path.

    • Method Detail

      • enabled

        boolean enabled()
        Checks if the configuration/feature is enabled.
        Returns:
        true if enabled and false otherwise

      • getRepositoryId

        java.lang.String getRepositoryId()
        Gets the Next Generation Dynamic Media tenant (also known technically as the repository Id) This would typically be a host name with the format 'delivery-pXX-eYY.adobeaemcloud.com' for PROD environments and 'delivery-pXX-eYY-smstg.adobeaemcloud.com' for STAGE environments.
        Returns:
        the repository id

      • getApiKey

        java.lang.String getApiKey()
        Gets the API key for accessing the asset selectors UI
        Returns:
        the API key for accessing the asset selectors UI

      • getEnv

        java.lang.String getEnv()
        Gets the environment string which should be 'PROD' or 'STAGE'
        Returns:
        the environment string

      • getImsOrg

        @Deprecated
java.lang.String getImsOrg()
        Deprecated.
        No replacement. IMS Org need not be sent to discovery service. The access is determined based on the repository ID.
        Gets the Adobe IMS Organization ID the user is a part of
        Returns:
        the Adobe IMS Organization ID the user is a part of

      • getImsEnv

        @Deprecated
java.lang.String getImsEnv()
        Deprecated.
        No replacement. IMSenv is an invalid property from asset selector's point of view. The IMS environment is determined solely on the basis of env property which accepts values as STAGE or PROD.
        Gets the IMS environment string which should be "prd" for IMS PROD environments and "stg1" for IMS STAGE environments
        Returns:
        the IMS environment string

      • getImsClient

        java.lang.String getImsClient()
        Gets the IMS client identifier
        Returns:
        the IMS client identifier

      • getAssetSelectorsJsUrl

        java.lang.String getAssetSelectorsJsUrl()
        Gets the absolute URL for the javascript which contains the microfrontend for the remote asset selector.
        Returns:
        the absolute URL for the javascript which contains the microfrontend for the remote asset selector

      • getImageDeliveryBasePath

        java.lang.String getImageDeliveryBasePath()
        Gets the path expression for the image delivery path. The following placeholders with the below meaning are contained within that path:
        • {asset-id} - the uuid of the asset in the format 'urn:aaid:aem:UUID', e.g. urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
        • {seo-name} - any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots
        • {format} - output format
        Returns:
        the path expression for the image delivery path

      • getVideoDeliveryPath

        java.lang.String getVideoDeliveryPath()
        Gets the path expression for the adaptive video manifest/player path. The following placeholders with the below meaning are contained within that path:
        • {asset-id} - the uuid of the asset in the format 'urn:aaid:aem:UUID' along with optional format e.g. urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75 OR urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75.mp4
        Returns:
        the path expression for the video delivery path

      • getAssetOriginalBinaryDeliveryPath

        java.lang.String getAssetOriginalBinaryDeliveryPath()
        Gets the path expression for the the Original Asset Delivery which delivers the bitstream as-is
        • {asset-id} - the uuid of the asset in the format 'urn:aaid:aem:UUID', e.g. urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
        • {seo-name} - any url-encoded or alphanumeric, non-whitespace set of characters. may contain hyphens and dots
        Returns:
        the path expression for the asset (bitstream) delivery path

      • getAssetMetadataPath

        java.lang.String getAssetMetadataPath()
        Gets the path expression for getting the metadata of an asset. The following placeholders with the below meaning are contained within that path:
        • {asset-id} - the uuid of the asset in the format 'urn:aaid:aem:UUID', e.g. urn:aaid:aem:1a034bee-ebda-4787-bad3-f924d0772b75
        Returns:
        the path expression for the metadata path