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

Interface Scene7AEMBridge

  • @ProviderType
public interface Scene7AEMBridge
    This API bridges some of the functionality from the Scene7 bundle for usage in the S7dam bundle.

    • Method Detail

      • getAllMembersOfBatchSetByAssetHandle

        java.util.List<Scene7Asset> getAllMembersOfBatchSetByAssetHandle​(java.lang.String assetHandle,
                                                                 Resource ipsCompanySharedDirectory)
        Parameters:
        assetHandle - asset metadata property imported from IPS during asset ingestion
        ipsCompanySharedDirectory - directory in AEM that maps to the company in IPS that is to be queried
        Returns:
        ArrayList containing all members assets of the set whose handle is being queried against

      • getAllBatchSetsContainingAsset

        java.util.List<Scene7Asset> getAllBatchSetsContainingAsset​(Resource asset)
        Parameters:
        asset - AEM Asset which has been ingested by IPS and has appropriate IPS metadata on it
        Returns:
        ArrayList containing all sets that contain asset

      • getS7configFromResource

        @Deprecated
S7Config getS7configFromResource​(Resource resource)
        Deprecated.
        Warning: this method leaks ResourceResolver! Use S7ConfigResolver service instead!
        Parameters:
        resource - AEM resource that has relevant IPS ingestion metadata. If not, we recursively look at the resource's directory structure to see if any of the parent folders have the necessary metadata
        Returns:
        S7Config object derived from IPS ingestion metadata

      • getAssetsByHandles

        java.util.List<Scene7Asset> getAssetsByHandles​(java.lang.String[] assetHandles,
                                               Resource ipsCompanySharedDirectory)
        Parameters:
        assetHandles - IPS ingestion metadata used to query IPS for these assets
        ipsCompanySharedDirectory - directory in AEM that maps to the company in IPS that is to be queried
        Returns:
        ArrayList containing Scene7 object representations of the assets as they exist in IPS

      • getS7AssetPublishUrl

        java.lang.String getS7AssetPublishUrl​(Resource resource)
        Parameters:
        resource - AEM resource that ingest into S7
        Returns:
        Asset's publish URL

      • getS7AssetPreviewUrl

        java.lang.String getS7AssetPreviewUrl​(Resource resource)
        Parameters:
        resource - AEM resource that ingest into S7
        Returns:
        Asset's preview URL