Package com.broadleafcommerce.dataexchange.service.product

Class PriceDataBatchItemHandler<T extends Prices>

java.lang.Object

com.broadleafcommerce.dataexchange.service.AbstractBatchItemHandler<T1,T2>

com.broadleafcommerce.dataexchange.service.product.ProductRelatedBatchItemHandler<ComprehensiveProduct,T>

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

Type Parameters:

T -

All Implemented Interfaces:

BatchItemHandler<ComprehensiveProduct,T>

public class PriceDataBatchItemHandler<T extends Prices>
extends ProductRelatedBatchItemHandler<ComprehensiveProduct,T>

Handles the processing of price data for a product. This works a little different from typical handlers in that we process all price data associated with a price list rather than a single price data object. The reason for this is we treat the Prices object as all price data for a given price list. This informs the handler on how to update all price data for a product and given price list.

For example, if there are 4 existing price data for a product, but the request only contains 1 price data, we will delete the other 3 price data.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CREATE_PRICE_DATA_KEY	Price data that needs to be created is stored in the batch properties under this key.
protected static final String	DELETE_PRICE_DATA_KEY	IDs of price data that need to be deleted are stored in the batch properties under this key.
static final String	EXISTING_PRICE_DATA_KEY	Existing price data fetched at the beginning of the batch process.
protected static final String	LOCAL_PRICE_DATA_KEY	Key used to store the existing price data for the product currently being handled.
protected static final String	SAVED_PRICE_DATA_KEY	Saved price data is stored in the batch properties under this key.
protected static final String	UPDATE_PRICE_DATA_KEY	Price data that needs to be updated is stored in the batch properties under this key.

Constructor Summary

Constructors

Constructor	Description
PriceDataBatchItemHandler(PriceProvider<PriceData> priceProvider, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<Void>	applyHandle(HandlerArgs<ComprehensiveProduct,T> args, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate, CompletableFuture<Void> result)	Create a completable future that will apply the handle method.
boolean	canHandle(ExchangeObject exchangeObject)	Determines if this handler can handle the given exchange object.
protected <R> R	getDataFromProps(String key, Map<String,Object> batchProperties)
protected List<PriceData>	getExistingPriceData(Map<String,Object> batchProperties)
protected List<PriceData>	getPriceDataToCreate(Map<String,Object> batchProperties)
protected Set<String>	getPriceDataToDelete(Map<String,Object> batchProperties)
protected List<PriceData>	getPriceDataToUpdate(Map<String,Object> batchProperties)
Supplier<T>	handle(HandlerArgs<ComprehensiveProduct,T> args)	Perform the necessary actions on the item in the batch.
protected CompletableFuture<Void>	handleCreates(HandlerArgs<ComprehensiveProduct,T> args)
protected CompletableFuture<Void>	handleDeletes(HandlerArgs<ComprehensiveProduct,T> args)
protected CompletableFuture<Void>	handleUpdates(HandlerArgs<ComprehensiveProduct,T> args)
protected void	initPricesList(ComprehensiveProduct product)	Add the given price data to the list of saved price data for the product.
Runnable	postHandle(HandlerArgs<ComprehensiveProduct,T> args)	This method is called after the item has been saved.
Runnable	preHandle(HandlerArgs<ComprehensiveProduct,T> handlerArgs)	Perform any necessary actions before the item is handled (e.g.
protected void	prepareCreatesAndUpdates(List<PriceData> prices, Map<String,Object> batchProperties, List<PriceData> existingPriceData)
protected T	prepareDeleteAll(T prices, Map<String,Object> batchProperties, List<PriceData> existingPriceData)
protected void	prepareDeletes(List<PriceData> prices, Map<String,Object> batchProperties, List<PriceData> existingPriceData)

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

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, createSupplementalFutures, handleCreate, handleDelete, handleUpdate, populateCorrelationId, retryableRunnable, retryableSupplier, shouldAbort

Field Details

EXISTING_PRICE_DATA_KEY

public static final String EXISTING_PRICE_DATA_KEY

Existing price data fetched at the beginning of the batch process. Available on the batch context. Will be in a Map<String, Map<String, List<PriceData>>. The key is the price data target. The value is a map of price data for the product, keyed by the price list id. See DefaultPriceDataPreloadProcessor

See Also:

• Constant Field Values

SAVED_PRICE_DATA_KEY

protected static final String SAVED_PRICE_DATA_KEY

Saved price data is stored in the batch properties under this key.

See Also:

• Constant Field Values

DELETE_PRICE_DATA_KEY

protected static final String DELETE_PRICE_DATA_KEY

IDs of price data that need to be deleted are stored in the batch properties under this key. Will be a Set<String>.

See Also:

• Constant Field Values

CREATE_PRICE_DATA_KEY

protected static final String CREATE_PRICE_DATA_KEY

Price data that needs to be created is stored in the batch properties under this key.

See Also:

• Constant Field Values

UPDATE_PRICE_DATA_KEY

protected static final String UPDATE_PRICE_DATA_KEY

Price data that needs to be updated is stored in the batch properties under this key.

See Also:

• Constant Field Values

LOCAL_PRICE_DATA_KEY

protected static final String LOCAL_PRICE_DATA_KEY

Key used to store the existing price data for the product currently being handled. Will be a List<PriceData>.

See Also:

• Constant Field Values

Constructor Details

PriceDataBatchItemHandler

public PriceDataBatchItemHandler(PriceProvider<PriceData> priceProvider,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

preHandle

public Runnable preHandle(HandlerArgs<ComprehensiveProduct,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.

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

applyHandle

protected CompletableFuture<Void> applyHandle(HandlerArgs<ComprehensiveProduct,T> args,
 org.springframework.core.task.AsyncTaskExecutor executor,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 CompletableFuture<Void> result)

Description copied from class: AbstractBatchItemHandler

Create a completable future that will apply the handle method. If performing more complex operations that require multiple steps that need to be executed, this is most likely the method that should be overridden.

Overrides:

applyHandle in class AbstractBatchItemHandler<ComprehensiveProduct,T extends Prices>

Parameters:

args - the handler arguments

executor - the executor to run the completable future

retryTemplate - the retry template to use

result - the completable future to apply the handle method to

Returns:

the completable future

handle

public Supplier<T> handle(HandlerArgs<ComprehensiveProduct,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.

postHandle

public Runnable postHandle(HandlerArgs<ComprehensiveProduct,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.

handleCreates

protected CompletableFuture<Void> handleCreates(HandlerArgs<ComprehensiveProduct,T> args)

handleDeletes

protected CompletableFuture<Void> handleDeletes(HandlerArgs<ComprehensiveProduct,T> args)

handleUpdates

protected CompletableFuture<Void> handleUpdates(HandlerArgs<ComprehensiveProduct,T> args)

prepareDeletes

protected void prepareDeletes(List<PriceData> prices,
 Map<String,Object> batchProperties,
 @Nullable
 List<PriceData> existingPriceData)

prepareDeleteAll

protected T prepareDeleteAll(T prices,
 Map<String,Object> batchProperties,
 @Nullable
 List<PriceData> existingPriceData)

prepareCreatesAndUpdates

protected void prepareCreatesAndUpdates(List<PriceData> prices,
 Map<String,Object> batchProperties,
 @Nullable
 List<PriceData> existingPriceData)

getExistingPriceData

@Nullable
protected List<PriceData> getExistingPriceData(Map<String,Object> batchProperties)

initPricesList

protected void initPricesList(ComprehensiveProduct product)

Add the given price data to the list of saved price data for the product.

getPriceDataToUpdate

@Nullable
protected List<PriceData> getPriceDataToUpdate(Map<String,Object> batchProperties)

getPriceDataToDelete

@Nullable
protected Set<String> getPriceDataToDelete(Map<String,Object> batchProperties)

getPriceDataToCreate

@Nullable
protected List<PriceData> getPriceDataToCreate(Map<String,Object> batchProperties)

getDataFromProps

@Nullable
protected <R> R getDataFromProps(String key,
 Map<String,Object> batchProperties)