com.commercetools.sync.inventories

Class InventorySync

java.lang.Object

com.commercetools.sync.commons.BaseSync<io.sphere.sdk.inventory.InventoryEntryDraft,InventorySyncStatistics,InventorySyncOptions>

com.commercetools.sync.inventories.InventorySync

public final class InventorySync
extends BaseSync<io.sphere.sdk.inventory.InventoryEntryDraft,InventorySyncStatistics,InventorySyncOptions>

Default implementation of inventories sync process.

Field Summary

Fields inherited from class com.commercetools.sync.commons.BaseSync

statistics, syncOptions

Constructor Summary

Constructors

Constructor and Description
InventorySync(InventorySyncOptions syncOptions) Takes a InventorySyncOptions instance to instantiate a new InventorySync instance that could be used to sync inventory drafts with the given inventory entries in the CTP project specified in the injected InventorySyncOptions instance.

Method Summary

Modifier and Type	Method and Description
protected java.util.concurrent.CompletionStage<InventorySyncStatistics>	process(java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft> inventories) Iterates through the whole inventories list and accumulates its valid drafts to batches.
protected java.util.concurrent.CompletionStage<InventorySyncStatistics>	processBatch(java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft> batchOfDrafts) Fetches existing InventoryEntry objects from CTP project that correspond to passed batchOfDrafts.
protected java.util.concurrent.CompletionStage<InventorySyncStatistics>	syncBatches(java.util.List<java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft>> batches, java.util.concurrent.CompletionStage<InventorySyncStatistics> result) Given a list of resource (e.g.

Methods inherited from class com.commercetools.sync.commons.BaseSync

executeSupplierIfConcurrentModificationException, getStatistics, getSyncOptions, sync

Methods inherited from class java.lang.Object

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

Constructor Detail

InventorySync

public InventorySync(@Nonnull
                     InventorySyncOptions syncOptions)

Takes a InventorySyncOptions instance to instantiate a new InventorySync instance that could be used to sync inventory drafts with the given inventory entries in the CTP project specified in the injected InventorySyncOptions instance.

Parameters:

syncOptions - the container of all the options of the sync process including the CTP project client and/or configuration and other sync-specific options.

Method Detail

process

@Nonnull
protected java.util.concurrent.CompletionStage<InventorySyncStatistics> process(@Nonnull
                                                                                         java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft> inventories)

Iterates through the whole inventories list and accumulates its valid drafts to batches. Every batch is then processed by processBatch(List).

Inherited doc: Given a list of resource (e.g. categories, products, etc..) drafts. This method compares each new resource in this list with it's corresponding old resource in a given CTP project, and in turn it either issues update actions on the existing resource if it exists or create it if it doesn't.

Specified by:

process in class BaseSync<io.sphere.sdk.inventory.InventoryEntryDraft,InventorySyncStatistics,InventorySyncOptions>

Parameters:

inventories - List of InventoryEntryDraft resources that would be synced into CTP project.

Returns:

CompletionStage with InventorySyncStatistics holding statistics of all sync processes performed by this sync instance

syncBatches

protected java.util.concurrent.CompletionStage<InventorySyncStatistics> syncBatches(@Nonnull
                                                                                    java.util.List<java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft>> batches,
                                                                                    @Nonnull
                                                                                    java.util.concurrent.CompletionStage<InventorySyncStatistics> result)

Description copied from class: BaseSync

Given a list of resource (e.g. categories, products, etc.. batches represented by a List<List> of resources, this method recursively calls BaseSync.processBatch(List) on each batch, then removes it, until there are no more batches, in other words, all batches have been synced.

Specified by:

syncBatches in class BaseSync<io.sphere.sdk.inventory.InventoryEntryDraft,InventorySyncStatistics,InventorySyncOptions>

Parameters:

batches - the batches of resources to sync.

result - in the first call of this recursive method, this result is normally a completed future, it used from within the method to recursively sync each batch once the previous batch has finished syncing.

Returns:

an instance of CompletionStage<U> which contains as a result an instance of BaseSyncStatistics representing the statistics of the sync process executed on the given list of batches.

processBatch

protected java.util.concurrent.CompletionStage<InventorySyncStatistics> processBatch(@Nonnull
                                                                                     java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft> batchOfDrafts)

Fetches existing InventoryEntry objects from CTP project that correspond to passed batchOfDrafts. Having existing inventory entries fetched, batchOfDrafts is compared and synced with fetched objects by syncBatch(List, List) function. When fetching existing inventory entries results in an empty optional then batchOfDrafts isn't processed.

Specified by:

processBatch in class BaseSync<io.sphere.sdk.inventory.InventoryEntryDraft,InventorySyncStatistics,InventorySyncOptions>

Parameters:

batchOfDrafts - batch of drafts that need to be synced

Returns:

CompletionStage of Void that indicates method progress.