Package com.commercetools.sync.services

Interface ProductService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIds​(java.util.Set<java.lang.String> productKeys)
      Filters out the keys which are already cached and fetches only the not-cached product keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every product to id in the cached map of keys -> ids and returns this cached map.
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.product.ProductProjection>> createProduct​(com.commercetools.api.models.product.ProductDraft productDraft)
      Given a resource draft of type ProductDraft, this method attempts to create a resource ProductProjection based on it in the CTP project defined by the sync options.
      java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.product.ProductProjection>> fetchMatchingProductsByKeys​(java.util.Set<java.lang.String> productKeys)
      Given a Set of product keys, this method fetches a set of all the products, matching this given set of keys in the CTP project, defined in an injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.product.ProductProjection>> fetchProduct​(java.lang.String key)
      Given a product key, this method fetches a product that matches this given key in the CTP project defined in a potentially injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> getIdFromCacheOrFetch​(java.lang.String key)
      Given a key, if it is blank (null/empty), a completed future with an empty optional is returned.
      java.util.concurrent.CompletionStage<com.commercetools.api.models.product.ProductProjection> updateProduct​(com.commercetools.api.models.product.ProductProjection product, java.util.List<com.commercetools.api.models.product.ProductUpdateAction> updateActions)
      Given a ProductProjection and a List<ProductUpdateAction>, this method issues an update request with these update actions on this ProductProjection in the CTP project defined in a potentially injected ProjectApiRoot.

    • Method Detail

      • getIdFromCacheOrFetch

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<java.lang.String>> getIdFromCacheOrFetch​(@Nullable
                                                                                                 java.lang.String key)
        Given a key, if it is blank (null/empty), a completed future with an empty optional is returned. This method then checks if the cached map of product keys -> ids contains the key. If it does, then an optional containing the mapped id is returned. If the cache doesn't contain the key; this method attempts to fetch the id of the key from the CTP project, caches it and returns a CompletionStage<Optional<String>> in which the result of it's completion could contain an Optional with the id inside of it or an empty Optional if no ProductProjection was found in the CTP project with this key.
        Parameters:
        key - the key by which a ProductProjection id should be fetched from the CTP project.
        Returns:
        CompletionStage<Optional<String>> in which the result of it's completion could contain an Optional with the id inside of it or an empty Optional if no ProductProjection was found in the CTP project with this key.

      • cacheKeysToIds

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIds​(@Nonnull
                                                                                                            java.util.Set<java.lang.String> productKeys)
        Filters out the keys which are already cached and fetches only the not-cached product keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every product to id in the cached map of keys -> ids and returns this cached map.

        Note: If all the supplied keys are already cached, the cached map is returned right away with no request to CTP.

        Parameters:
        productKeys - the product keys to fetch and cache the ids for.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a map of all product keys -> ids

      • fetchMatchingProductsByKeys

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.product.ProductProjection>> fetchMatchingProductsByKeys​(@Nonnull
                                                                                                                                        java.util.Set<java.lang.String> productKeys)
        Given a Set of product keys, this method fetches a set of all the products, matching this given set of keys in the CTP project, defined in an injected ProjectApiRoot. A mapping of the key to the id of the fetched products is persisted in an in-memory map.
        Parameters:
        productKeys - set of product keys to fetch matching products by.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a Set of all matching products.

      • fetchProduct

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.product.ProductProjection>> fetchProduct​(@Nullable
                                                                                                                              java.lang.String key)
        Given a product key, this method fetches a product that matches this given key in the CTP project defined in a potentially injected ProjectApiRoot. If there is no matching product an empty Optional will be returned in the returned future. A mapping of the key to the id of the fetched category is persisted in an in -memory map.
        Parameters:
        key - the key of the product to fetch.
        Returns:
        CompletionStage<Optional> in which the result of it's completion contains an Optional that contains the matching ProductProjection if exists, otherwise empty.

      • createProduct

        @Nonnull
java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.product.ProductProjection>> createProduct​(@Nonnull
                                                                                                                               com.commercetools.api.models.product.ProductDraft productDraft)
        Given a resource draft of type ProductDraft, this method attempts to create a resource ProductProjection based on it in the CTP project defined by the sync options.

        A completion stage containing an empty option and the error callback will be triggered in those cases:

        • the draft has a blank key
        • the create request fails on CTP

        On the other hand, if the resource gets created successfully on CTP, then the created resource's id and key are cached and the method returns a CompletionStage in which the result of it's completion contains an instance Optional of the resource which was created.

        Parameters:
        productDraft - the resource draft to create a resource based off of.
        Returns:
        a CompletionStage containing an optional with the created resource if successful otherwise an empty optional.

      • updateProduct

        @Nonnull
java.util.concurrent.CompletionStage<com.commercetools.api.models.product.ProductProjection> updateProduct​(@Nonnull
                                                                                                           com.commercetools.api.models.product.ProductProjection product,
                                                                                                           @Nonnull
                                                                                                           java.util.List<com.commercetools.api.models.product.ProductUpdateAction> updateActions)
        Given a ProductProjection and a List<ProductUpdateAction>, this method issues an update request with these update actions on this ProductProjection in the CTP project defined in a potentially injected ProjectApiRoot. This method returns CompletionStage<ProductProjection> in which the result of it's completion contains an instance of the ProductProjection which was updated in the CTP project.
        Parameters:
        product - the ProductProjection to update.
        updateActions - the update actions to update the ProductProjection with.
        Returns:
        CompletionStage<ProductProjection> containing as a result of it's completion an instance of the ProductProjection which was updated in the CTP project or a CompletionException.