Class AssetReferenceResolver


  • public final class AssetReferenceResolver
    extends CustomReferenceResolver<com.commercetools.api.models.common.AssetDraft,​com.commercetools.api.models.common.AssetDraftBuilder,​BaseSyncOptions>
    • Constructor Detail

      • AssetReferenceResolver

        public AssetReferenceResolver​(@Nonnull
                                      BaseSyncOptions options,
                                      @Nonnull
                                      TypeService typeService)
        Takes a BaseSyncOptions instance and a TypeService to instantiate a AssetReferenceResolver instance that could be used to resolve the asset drafts in the CTP project specified in the injected BaseSyncOptions instance.
        Parameters:
        options - the container of all the options of the sync process including the CTP project client and/or configuration and other sync-specific options.
        typeService - the service to fetch the custom types for reference resolution.
    • Method Detail

      • resolveReferences

        @Nonnull
        public java.util.concurrent.CompletionStage<com.commercetools.api.models.common.AssetDraft> resolveReferences​(@Nonnull
                                                                                                                      com.commercetools.api.models.common.AssetDraft assetDraft)
        Description copied from class: BaseReferenceResolver
        Given a draft this method attempts to resolve the all the references on the draft to return a CompletionStage which contains a new instance of the draft with the resolved references.
        Specified by:
        resolveReferences in class BaseReferenceResolver<com.commercetools.api.models.common.AssetDraft,​BaseSyncOptions>
        Parameters:
        assetDraft - the productDraft to resolve it's references.
        Returns:
        a CompletionStage that contains as a result a new draft instance with resolved references or, in case an error occurs during reference resolution, a ReferenceResolutionException.
      • resolveCustomTypeReference

        @Nonnull
        protected java.util.concurrent.CompletionStage<com.commercetools.api.models.common.AssetDraftBuilder> resolveCustomTypeReference​(@Nonnull
                                                                                                                                         com.commercetools.api.models.common.AssetDraftBuilder assetDraftBuilder)
        Description copied from class: CustomReferenceResolver
        Given a draft of D (e.g. CategoryDraft) this method attempts to resolve it's custom type reference to return CompletionStage which contains a new instance of the draft with the resolved custom type reference.

        The method then tries to fetch the key of the custom type, optimistically from a cache. If the key is is not found, the resultant draft would remain exactly the same as the passed draft (without a custom type reference resolution).

        Specified by:
        resolveCustomTypeReference in class CustomReferenceResolver<com.commercetools.api.models.common.AssetDraft,​com.commercetools.api.models.common.AssetDraftBuilder,​BaseSyncOptions>
        Parameters:
        assetDraftBuilder - the draft builder to resolve it's references.
        Returns:
        a CompletionStage that contains as a result a new draft instance with resolved custom type references or, in case an error occurs during reference resolution, a ReferenceResolutionException.