Package com.commercetools.sync.services.impl

Class ShoppingListServiceImpl

  • All Implemented Interfaces:
    ShoppingListService
    public final class ShoppingListServiceImpl
extends java.lang.Object
implements ShoppingListService
    Implementation of ShoppingListService interface.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.github.benmanes.caffeine.cache.Cache<java.lang.String,​java.lang.String> keyToIdCache  
      protected static int MAXIMUM_ALLOWED_UPDATE_ACTIONS  

    • Method Summary

      All Methods Instance Methods Concrete 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> shoppingListKeys)
      Filters out the keys which are already cached and fetches only the not-cached shopping list keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every shopping list to id in the cached map of keys -> ids and returns this cached map.
      java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIdsUsingGraphQl​(java.util.Set<java.lang.String> keysToCache, GraphQlQueryResource queryResource)  
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.shopping_list.ShoppingList>> createShoppingList​(com.commercetools.api.models.shopping_list.ShoppingListDraft shoppingListDraft)
      Given a resource draft of type ShoppingListDraft, this method attempts to create a resource ShoppingList based on it in the CTP project defined by the sync options.
      java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.shopping_list.ShoppingList>> fetchMatchingShoppingListsByKeys​(java.util.Set<java.lang.String> keys)
      Given a Set of shopping list keys, this method fetches a set of all the shopping lists, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot.
      java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.shopping_list.ShoppingList>> fetchShoppingList​(java.lang.String key)
      Given a shopping list key, this method fetches a shopping list that matches given key in the CTP project defined in a potentially injected ProjectApiRoot.
      protected java.util.Set<java.lang.String> getKeysNotCached​(java.util.Set<java.lang.String> keys)
      Given a set of keys this method collects all keys which aren't already contained in the cache keyToIdCache
      java.util.concurrent.CompletionStage<com.commercetools.api.models.shopping_list.ShoppingList> updateShoppingList​(com.commercetools.api.models.shopping_list.ShoppingList shoppingList, java.util.List<com.commercetools.api.models.shopping_list.ShoppingListUpdateAction> updateActions)
      Given a ShoppingList and a List<ShoppingListUpdateAction>, this method issues an update request with these update actions on this ShoppingList in the CTP project defined in a potentially injected ProjectApiRoot.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • keyToIdCache

        protected final com.github.benmanes.caffeine.cache.Cache<java.lang.String,​java.lang.String> keyToIdCache

      • MAXIMUM_ALLOWED_UPDATE_ACTIONS

        protected static final int MAXIMUM_ALLOWED_UPDATE_ACTIONS
        See Also:
        Constant Field Values

    • Constructor Detail

    • Method Detail

      • cacheKeysToIds

        @Nonnull
public java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIds​(@Nonnull
                                                                                                                   java.util.Set<java.lang.String> shoppingListKeys)
        Description copied from interface: ShoppingListService
        Filters out the keys which are already cached and fetches only the not-cached shopping list keys from the CTP project defined in an injected ProjectApiRoot and stores a mapping for every shopping list 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.

        Specified by:
        cacheKeysToIds in interface ShoppingListService
        Parameters:
        shoppingListKeys - the shopping list keys to fetch and cache the ids for.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a map of all shopping list keys -> ids

      • fetchMatchingShoppingListsByKeys

        @Nonnull
public java.util.concurrent.CompletionStage<java.util.Set<com.commercetools.api.models.shopping_list.ShoppingList>> fetchMatchingShoppingListsByKeys​(@Nonnull
                                                                                                                                                     java.util.Set<java.lang.String> keys)
        Description copied from interface: ShoppingListService
        Given a Set of shopping list keys, this method fetches a set of all the shopping lists, matching given set of keys in the CTP project, defined in an injected ProjectApiRoot. A mapping of the key to the id of the fetched shopping lists is persisted in an in-memory map.
        Specified by:
        fetchMatchingShoppingListsByKeys in interface ShoppingListService
        Parameters:
        keys - set of shopping list keys to fetch matching shopping lists by.
        Returns:
        CompletionStage<Map> in which the result of it's completion contains a Set of all matching shopping lists.

      • fetchShoppingList

        @Nonnull
public java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.shopping_list.ShoppingList>> fetchShoppingList​(@Nullable
                                                                                                                                           java.lang.String key)
        Description copied from interface: ShoppingListService
        Given a shopping list key, this method fetches a shopping list that matches given key in the CTP project defined in a potentially injected ProjectApiRoot. If there is no matching shopping list, an empty Optional will be returned in the returned future. A mapping of the key to the id of the fetched shopping list is persisted in an in-memory map.
        Specified by:
        fetchShoppingList in interface ShoppingListService
        Parameters:
        key - the key of the shopping list to fetch.
        Returns:
        CompletionStage<Optional> in which the result of its completion contains an Optional that contains the matching ShoppingList if exists, otherwise empty.

      • createShoppingList

        @Nonnull
public java.util.concurrent.CompletionStage<java.util.Optional<com.commercetools.api.models.shopping_list.ShoppingList>> createShoppingList​(@Nonnull
                                                                                                                                            com.commercetools.api.models.shopping_list.ShoppingListDraft shoppingListDraft)
        Description copied from interface: ShoppingListService
        Given a resource draft of type ShoppingListDraft, this method attempts to create a resource ShoppingList 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.

        Specified by:
        createShoppingList in interface ShoppingListService
        Parameters:
        shoppingListDraft - 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.

      • updateShoppingList

        @Nonnull
public java.util.concurrent.CompletionStage<com.commercetools.api.models.shopping_list.ShoppingList> updateShoppingList​(@Nonnull
                                                                                                                        com.commercetools.api.models.shopping_list.ShoppingList shoppingList,
                                                                                                                        @Nonnull
                                                                                                                        java.util.List<com.commercetools.api.models.shopping_list.ShoppingListUpdateAction> updateActions)
        Description copied from interface: ShoppingListService
        Given a ShoppingList and a List<ShoppingListUpdateAction>, this method issues an update request with these update actions on this ShoppingList in the CTP project defined in a potentially injected ProjectApiRoot. This method returns CompletionStage< ShoppingList> in which the result of it's completion contains an instance of the ShoppingList which was updated in the CTP project.
        Specified by:
        updateShoppingList in interface ShoppingListService
        Parameters:
        shoppingList - the ShoppingList to update.
        updateActions - the update actions to update the ShoppingList with.
        Returns:
        CompletionStage<ShoppingList> containing as a result of it's completion an instance of the ShoppingList which was updated in the CTP project or a CompletionException.

      • getKeysNotCached

        @Nonnull
protected java.util.Set<java.lang.String> getKeysNotCached​(@Nonnull
                                                           java.util.Set<java.lang.String> keys)
        Given a set of keys this method collects all keys which aren't already contained in the cache keyToIdCache
        Parameters:
        keys - Set of keys
        Returns:
        a Set of keys which aren't already contained in the cache or empty

      • cacheKeysToIdsUsingGraphQl

        @Nonnull
public java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,​java.lang.String>> cacheKeysToIdsUsingGraphQl​(@Nonnull
                                                                                                                               java.util.Set<java.lang.String> keysToCache,
                                                                                                                               @Nonnull
                                                                                                                               GraphQlQueryResource queryResource)