com.commercetools.sync.products

Class ProductSync

java.lang.Object

com.commercetools.sync.commons.BaseSync<io.sphere.sdk.products.ProductDraft,ProductSyncStatistics,ProductSyncOptions>

com.commercetools.sync.products.ProductSync

public class ProductSync
extends BaseSync<io.sphere.sdk.products.ProductDraft,ProductSyncStatistics,ProductSyncOptions>

Field Summary

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

statistics, syncOptions

Constructor Summary

Constructors

Constructor and Description
ProductSync(ProductSyncOptions productSyncOptions) Takes a ProductSyncOptions instance to instantiate a new ProductSync instance that could be used to sync product drafts with the given products in the CTP project specified in the injected ProductSyncOptions instance.

Method Summary

Modifier and Type	Method and Description
protected java.util.concurrent.CompletionStage<ProductSyncStatistics>	process(java.util.List<io.sphere.sdk.products.ProductDraft> resourceDrafts) Given a list of resource (e.g.
protected java.util.concurrent.CompletionStage<ProductSyncStatistics>	processBatch(java.util.List<io.sphere.sdk.products.ProductDraft> batch)
protected java.util.concurrent.CompletionStage<ProductSyncStatistics>	syncBatches(java.util.List<java.util.List<io.sphere.sdk.products.ProductDraft>> batches, java.util.concurrent.CompletionStage<ProductSyncStatistics> 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

ProductSync

public ProductSync(@Nonnull
                   ProductSyncOptions productSyncOptions)

Takes a ProductSyncOptions instance to instantiate a new ProductSync instance that could be used to sync product drafts with the given products in the CTP project specified in the injected ProductSyncOptions instance.

Parameters:

productSyncOptions - 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

protected java.util.concurrent.CompletionStage<ProductSyncStatistics> process(@Nonnull
                                                                              java.util.List<io.sphere.sdk.products.ProductDraft> resourceDrafts)

Description copied from class: BaseSync

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.products.ProductDraft,ProductSyncStatistics,ProductSyncOptions>

Parameters:

resourceDrafts - the list of new resources as drafts.

Returns:

an instance of CompletionStage<U> which contains as a result an instance of U which is a subclass of BaseSyncStatistics representing the statistics instance attribute of this BaseSync.

syncBatches

protected java.util.concurrent.CompletionStage<ProductSyncStatistics> syncBatches(@Nonnull
                                                                                  java.util.List<java.util.List<io.sphere.sdk.products.ProductDraft>> batches,
                                                                                  @Nonnull
                                                                                  java.util.concurrent.CompletionStage<ProductSyncStatistics> 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.products.ProductDraft,ProductSyncStatistics,ProductSyncOptions>

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<ProductSyncStatistics> processBatch(@Nonnull
                                                                                   java.util.List<io.sphere.sdk.products.ProductDraft> batch)

Specified by:

processBatch in class BaseSync<io.sphere.sdk.products.ProductDraft,ProductSyncStatistics,ProductSyncOptions>