com.commercetools.sync.inventories.utils.InventoryReferenceResolutionUtils Maven / Gradle / Ivy

Go to download
package com.commercetools.sync.inventories.utils;

import static com.commercetools.sync.commons.utils.CustomTypeReferenceResolutionUtils.mapToCustomFieldsDraft;
import static com.commercetools.sync.commons.utils.SyncUtils.getResourceIdentifierWithKey;
import static java.util.stream.Collectors.toList;

import com.commercetools.api.models.channel.Channel;
import com.commercetools.api.models.channel.ChannelReference;
import com.commercetools.api.models.channel.ChannelResourceIdentifier;
import com.commercetools.api.models.channel.ChannelResourceIdentifierBuilder;
import com.commercetools.api.models.inventory.InventoryEntry;
import com.commercetools.api.models.inventory.InventoryEntryDraft;
import com.commercetools.api.models.inventory.InventoryEntryDraftBuilder;
import com.commercetools.api.models.type.CustomFieldsDraft;
import com.commercetools.api.models.type.Type;
import com.commercetools.api.models.type.TypeReference;
import com.commercetools.api.models.type.TypeResourceIdentifier;
import com.commercetools.sync.commons.utils.ReferenceIdToKeyCache;
import java.util.List;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Util class which provides utilities that can be used when syncing resources from a source
 * commercetools project to a target one.
 */
public final class InventoryReferenceResolutionUtils {

  /**
   * Returns an {@link List}<{@link InventoryEntryDraft}> consisting of the results of
   * applying the mapping from {@link InventoryEntry} to {@link InventoryEntryDraft} with
   * considering reference resolution.
   *
   * 
   *   
   *   
   *     
   *       
   *       
   *       
   *     
   *   
   *   
   *     
   *       
   *       
   *       
   *     
   *     
   *        
   *        
   *        
   *     
   *   
   * Mapping of Reference fields for the reference resolutionReference field from to
supplyChannel {@link ChannelReference} {@link ChannelResourceIdentifier}
custom.type {@link TypeReference} {@link TypeResourceIdentifier}
   *
   * Note: The {@link Channel} and {@link Type} reference should contain Id in the
   * map(cache) with a key value. Any reference, which have its id in place and not replaced by the
   * key, it would not be found in the map. In this case, this reference will be considered as
   * existing resources on the target commercetools project and the library will issues an
   * update/create API request without reference resolution.
   *
   * @param inventoryEntries the inventory entries without expansion of references.
   * @param referenceIdToKeyCache the instance that manages cache.
   * @return a {@link List} of {@link InventoryEntryDraft} built from the supplied {@link List} of
   *     {@link InventoryEntry}.
   */
  @Nonnull
  public static List mapToInventoryEntryDrafts(
      @Nonnull final List inventoryEntries,
      @Nonnull final ReferenceIdToKeyCache referenceIdToKeyCache) {

    return inventoryEntries.stream()
        .map(inventoryEntry -> mapToInventoryEntryDraft(inventoryEntry, referenceIdToKeyCache))
        .collect(toList());
  }

  @Nonnull
  private static InventoryEntryDraft mapToInventoryEntryDraft(
      @Nonnull final InventoryEntry inventoryEntry,
      @Nonnull final ReferenceIdToKeyCache referenceIdToKeyCache) {
    final ChannelResourceIdentifier channelResourceIdentifier =
        getResourceIdentifierWithKey(
            inventoryEntry.getSupplyChannel(),
            referenceIdToKeyCache,
            (id, key) -> ChannelResourceIdentifierBuilder.of().key(key).id(id).build());
    final CustomFieldsDraft customFieldsDraft =
        mapToCustomFieldsDraft(inventoryEntry, referenceIdToKeyCache);
    return getInventoryEntryDraft(inventoryEntry, customFieldsDraft, channelResourceIdentifier);
  }

  /**
   * Creates a new {@link InventoryEntryDraft} from given {@link InventoryEntry}, already mapped
   * {@link CustomFieldsDraft} and channel as {@link ChannelResourceIdentifier}.
   *
   * @param inventoryEntry - a template inventoryEntry to build the draft from
   * @param mappedCustomFields - a customFieldsDraft or null
   * @param channel - a resource identifier representing the supply channel or null
   * @return a new {@link InventoryEntryDraft} with all fields copied from the {@param
   *     inventoryEntry} and custom fields set {@param mappedCustomFields} and supply channel with
   *     {@param channel} resource identifier - it will return empty InventoryEntryDraft if sku or
   *     quantityOnStock are missing.
   */
  private static InventoryEntryDraft getInventoryEntryDraft(
      @Nonnull final InventoryEntry inventoryEntry,
      @Nullable final CustomFieldsDraft mappedCustomFields,
      @Nullable final ChannelResourceIdentifier channel) {
    if (inventoryEntry.getSku() != null && inventoryEntry.getQuantityOnStock() != null) {
      return InventoryEntryDraftBuilder.of()
          .sku(inventoryEntry.getSku())
          .quantityOnStock(inventoryEntry.getQuantityOnStock())
          .expectedDelivery(inventoryEntry.getExpectedDelivery())
          .restockableInDays(inventoryEntry.getRestockableInDays())
          .key(inventoryEntry.getKey())
          .custom(mappedCustomFields)
          .supplyChannel(channel)
          .build();
    } else {
      return InventoryEntryDraft.of();
    }
  }

  private InventoryReferenceResolutionUtils() {}
}
Reference field	from	to
supplyChannel	{@link ChannelReference}	{@link ChannelResourceIdentifier}
custom.type	{@link TypeReference}	{@link TypeResourceIdentifier}