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

Interface ImageUrlApi

@ProviderType @NotNullApi public interface ImageUrlApi

  • Method Details

    • getImageServerPreviewURL

      @Deprecated @Nullable @Nullable String getImageServerPreviewURL(Resource resource, ResourceResolver resolver)
      Deprecated.
      Use getImageServerPreviewURL(Resource resource)
      Retrieve the preview server url of the asset if it is on the ips server
      Parameters:
      resource - Resource for asset instance
      resolver - Resource's resolver
      Returns:
      The url of the publish server, or null if could not get

    • getImageServerDeliveryURL

      @Deprecated @Nullable @Nullable String getImageServerDeliveryURL(Resource resource, ResourceResolver resolver)
      Deprecated.
      Use getImageServerDeliveryURL(Resource resource)
      Retrieve the delivery server url of the asset if it is on the ips server
      Parameters:
      resource - Resource for asset instance
      resolver - Resource's resolver
      Returns:
      The url of the publish server, or null if could not get

    • getImageRootPath

      @Deprecated @Nullable @Nullable String getImageRootPath(Resource resource, ResourceResolver resolver)
      Deprecated.
      Use getImageRootPath(Resource resource)
      Retrieve the path of the asset on the ips server
      Parameters:
      resource - Resource for asset instance
      resolver - Resource's resolver
      Returns:
      The path of the resource, or null if could not get

    • getImageServerPreviewURL

      @Nullable @Nullable String getImageServerPreviewURL(Resource resource)
      Retrieve the preview server url of the asset if it is on the ips server
      Parameters:
      resource - Resource for asset instance
      Returns:
      The url of the publish server, or null if could not get

    • getImageServerPreviewToken

      @Nullable @Nullable String getImageServerPreviewToken(Resource resource)
      Retrieve the auth token for preview server for the asset
      Parameters:
      resource - Resource for asset instance
      Returns:
      The jwt for secure preview, or null if could not get

    • getImageServerDeliveryURL

      @Nullable @Nullable String getImageServerDeliveryURL(Resource resource)
      Retrieve the delivery server url of the asset if it is on the ips server
      Parameters:
      resource - Resource for asset instance
      Returns:
      The url of the publish server, or null if could not get

    • getImageRootPath

      @Nullable @Nullable String getImageRootPath(Resource resource)
      Retrieve the path of the asset on the ips server
      Parameters:
      resource - Resource for asset instance
      Returns:
      The path of the resource, or null if could not get

    • getRemoteAssetPublishURL

      @Nullable @Nullable String getRemoteAssetPublishURL(Resource resource, ImageUrlApi.RemoteUrlType urlType)
      Returns published ("delivery") world-visible URL link to remote DM asset linked to the given JCR Resource.
      Parameters:
      resource - JCR resource pointing to the asset
      urlType - format of URL
      Returns:
      publish URL string, or null if given resource is not DM-synchronized asset, or asset is not published, or any other error.

    • getRemoteAssetPreviewURL

      @Nullable @Nullable String getRemoteAssetPreviewURL(Resource resource, ImageUrlApi.RemoteUrlType urlType)
      Returns secure-preview URL link to remote DM asset linked to the given JCR Resource.
      Parameters:
      resource - JCR resource pointing to the asset
      urlType - format of URL
      Returns:
      preview URL string, or null if given resource is not DM-synchronized asset, or any other error.