Package com.broadleafcommerce.dataexchange.service.product

Class ProductBatchItemHandler<T extends ComprehensiveProduct>

java.lang.Object

com.broadleafcommerce.dataexchange.service.AbstractBatchItemHandler<T,T>

com.broadleafcommerce.dataexchange.service.product.ProductBatchItemHandler<T>

All Implemented Interfaces:

BatchItemHandler<T,T>

public class ProductBatchItemHandler<T extends ComprehensiveProduct>
extends AbstractBatchItemHandler<T,T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXISTING_PRODUCT_TAGS
static final String	PRODUCT_TRANSLATIONS_MAP
static final String	VARIANTS_TO_CREATE
static final String	VARIANTS_TO_DELETE
static final String	VARIANTS_TO_UPDATE

Constructor Summary

Constructors

Constructor

Description

ProductBatchItemHandler(CatalogProvider<T,Variant> catalogProvider, ProductBatchItemHandlerHelper<T> helper, VariantBatchItemHandler<Variant> variantBatchItemHandler, AdvancedTagProvider<AdvancedTag,ProductTag> tagProvider, ProductTagBatchItemHandler<ProductTag> tagBatchItemHandler, List<ProductRelatedBatchItemHandler<T,?>> childItemHandlers, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<Void>	buildProductTranslationsMap(HandlerArgs<T,T> args)
protected Function<? super Void,? extends CompletionStage<Void>>	buildSaveTagFutures(HandlerArgs<T,T> args)
protected @NotNull Function<Void,CompletionStage<Void>>	buildSaveTranslationFutures(HandlerArgs<T,T> args)
boolean	canHandle(ExchangeObject exchangeObject)	Determines if this handler can handle the given exchange object.
CompletableFuture<Void>	createSupplementalFutures(HandlerArgs<T,T> args)	Create any supplemental futures that should be executed after the main future.
protected CompletableFuture<Void>	deleteVariantsFuture(HandlerArgs<T,T> args, BatchContext<T> tBatchContext)
protected BatchItemOperationType	findVariantOperationType(HandlerArgs<T,T> args, ExchangeObject exchangeObject)
protected CatalogProvider<T,Variant>	getCatalogProvider()
protected List<ProductRelatedBatchItemHandler<T,?>>	getChildItemHandlers()
protected ProductBatchItemHandlerHelper<T>	getHelper()
protected ProductTagBatchItemHandler<ProductTag>	getTagBatchItemHandler()
protected AdvancedTagProvider<AdvancedTag,ProductTag>	getTagProvider()
protected VariantBatchItemHandler<Variant>	getVariantBatchItemHandler()
Supplier<T>	handle(HandlerArgs<T,T> args)	Perform the necessary actions on the item in the batch.
T	handleCreate(HandlerArgs<T,T> args)	Handle the create operation.
protected CompletableFuture<Void>	handleProductTags(HandlerArgs<T,T> args)
T	handleUpdate(HandlerArgs<T,T> args)	Handle the update operation.
protected void	initTranslationsList(T savedProduct)
protected CompletableFuture<Void>	loadExistingTags(HandlerArgs<T,T> args)
Runnable	postHandle(HandlerArgs<T,T> args)	This method is called after the item has been saved.
Runnable	preHandle(HandlerArgs<T,T> handlerArgs)	Perform any necessary actions before the item is handled (e.g.
protected T	resolveExistingProducts(T product, BatchContext<T> batchContext)
CompletableFuture<Void>	saveProduct(T product, BatchContext<T> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate)
protected Runnable	saveProductTranslationRunnable(List<Translation> translations, Locale locale, HandlerArgs<T,T> args)
protected CompletableFuture<Void>	saveTranslationsFuture(HandlerArgs<T,T> args)

Methods inherited from class com.broadleafcommerce.dataexchange.service.AbstractBatchItemHandler

applyHandle, applyPostOperations, buildTranslationMap, createFutureInternal, execute, execute, execute, execute, getSavedTopLevel, getTypeFactory, isNewlyCreated

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.dataexchange.service.BatchItemHandler

completedFuture, createCompletableFuture, createCompletableFuture, handleDelete, populateCorrelationId, retryableRunnable, retryableSupplier, shouldAbort

Field Details

VARIANTS_TO_CREATE

public static final String VARIANTS_TO_CREATE

See Also:

• Constant Field Values

VARIANTS_TO_UPDATE

public static final String VARIANTS_TO_UPDATE

See Also:

• Constant Field Values

VARIANTS_TO_DELETE

public static final String VARIANTS_TO_DELETE

See Also:

• Constant Field Values

PRODUCT_TRANSLATIONS_MAP

public static final String PRODUCT_TRANSLATIONS_MAP

See Also:

• Constant Field Values

EXISTING_PRODUCT_TAGS

public static final String EXISTING_PRODUCT_TAGS

See Also:

• Constant Field Values

Constructor Details

ProductBatchItemHandler

public ProductBatchItemHandler(CatalogProvider<T,Variant> catalogProvider,
 ProductBatchItemHandlerHelper<T> helper,
 VariantBatchItemHandler<Variant> variantBatchItemHandler,
 AdvancedTagProvider<AdvancedTag,ProductTag> tagProvider,
 ProductTagBatchItemHandler<ProductTag> tagBatchItemHandler,
 List<ProductRelatedBatchItemHandler<T,?>> childItemHandlers,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

saveProduct

public CompletableFuture<Void> saveProduct(T product,
 BatchContext<T> batchContext,
 org.springframework.core.task.AsyncTaskExecutor executor,
 org.springframework.retry.support.RetryTemplate retryTemplate)

preHandle

public Runnable preHandle(HandlerArgs<T,T> handlerArgs)

Description copied from interface: BatchItemHandler

Perform any necessary actions before the item is handled (e.g. fetching data, determining save/delete, etc.).

Parameters:

handlerArgs - The handler arguments

Returns:

A runnable that will be executed before the item is handled. If no action is necessary, returns null.

handle

public Supplier<T> handle(HandlerArgs<T,T> args)

Description copied from interface: BatchItemHandler

Perform the necessary actions on the item in the batch. Accepts an instance of HandlerArgs and returns the handled item, which is then passed to BatchItemHandler.postHandle(HandlerArgs).

Returns:

A function that accepts an instance of HandlerArgs. If no further handling is necessary, this method or the supplier may return null.

handleCreate

public T handleCreate(HandlerArgs<T,T> args)

Description copied from interface: BatchItemHandler

Handle the create operation. This method is called when HandlerArgs.getOperationType() is BatchItemOperationType.CREATE.

handleUpdate

public T handleUpdate(HandlerArgs<T,T> args)

Description copied from interface: BatchItemHandler

Handle the update operation. This method is called when HandlerArgs.getOperationType() is BatchItemOperationType.UPDATE.

createSupplementalFutures

public CompletableFuture<Void> createSupplementalFutures(HandlerArgs<T,T> args)

Description copied from interface: BatchItemHandler

Create any supplemental futures that should be executed after the main future. This should be implemented to handle any child entities that need to be processed after the main entity is handled. CompletableFuture<Void> future1 = ... CompletableFuture<Void> future2 = ... return CompletableFuture.allOf(future1, future2);

NOTE: See class level documentation for important information about composing futures.

Parameters:

args - The handler arguments

Returns:

A completable future that will execute any supplemental futures. By default, this returns a completed future.

findVariantOperationType

protected BatchItemOperationType findVariantOperationType(HandlerArgs<T,T> args,
 ExchangeObject exchangeObject)

deleteVariantsFuture

protected CompletableFuture<Void> deleteVariantsFuture(HandlerArgs<T,T> args,
 BatchContext<T> tBatchContext)

postHandle

public Runnable postHandle(HandlerArgs<T,T> args)

Description copied from interface: BatchItemHandler

This method is called after the item has been saved. Any items that should be done after the item is saved should be done here. At minimum, the implementation should set the savedItem result on the parent. At this point, the item is considered "done" and no high risk operations (e.g. API calls) should be done here.

Parameters:

args - the handler arguments. Returns null if no action is necessary.

handleProductTags

protected CompletableFuture<Void> handleProductTags(HandlerArgs<T,T> args)

buildSaveTagFutures

protected Function<? super Void,? extends CompletionStage<Void>> buildSaveTagFutures(HandlerArgs<T,T> args)

loadExistingTags

protected CompletableFuture<Void> loadExistingTags(HandlerArgs<T,T> args)

saveTranslationsFuture

protected CompletableFuture<Void> saveTranslationsFuture(HandlerArgs<T,T> args)

buildProductTranslationsMap

protected CompletableFuture<Void> buildProductTranslationsMap(HandlerArgs<T,T> args)

buildSaveTranslationFutures

@NotNull
protected @NotNull Function<Void,CompletionStage<Void>> buildSaveTranslationFutures(HandlerArgs<T,T> args)

saveProductTranslationRunnable

protected Runnable saveProductTranslationRunnable(List<Translation> translations,
 Locale locale,
 HandlerArgs<T,T> args)

initTranslationsList

protected void initTranslationsList(T savedProduct)

canHandle

public boolean canHandle(ExchangeObject exchangeObject)

Description copied from interface: BatchItemHandler

Determines if this handler can handle the given exchange object.

Parameters:

exchangeObject - the exchange object

Returns:

true if this handler can handle the exchange object, false otherwise

resolveExistingProducts

@Nullable
protected T resolveExistingProducts(T product,
 BatchContext<T> batchContext)

getCatalogProvider

protected CatalogProvider<T,Variant> getCatalogProvider()

getChildItemHandlers

protected List<ProductRelatedBatchItemHandler<T,?>> getChildItemHandlers()

getHelper

protected ProductBatchItemHandlerHelper<T> getHelper()

getVariantBatchItemHandler

protected VariantBatchItemHandler<Variant> getVariantBatchItemHandler()

getTagProvider

protected AdvancedTagProvider<AdvancedTag,ProductTag> getTagProvider()

getTagBatchItemHandler

protected ProductTagBatchItemHandler<ProductTag> getTagBatchItemHandler()