Package com.broadleafcommerce.dataexchange.service

Interface BatchExtensionProcessor

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

AbstractPriceDataPreloadProcessor, DataDrivenEnumBatchLoaderProcessor, DefaultAdvancedTagPreloader, DefaultOptionTemplatePreloader, DefaultPriceDataPreloadProcessor

public interface BatchExtensionProcessor
extends org.springframework.core.Ordered

Component to allow an implementor to register this as a Spring Bean. It will then be injected into all services and used for pre/post-processing of the batch.

Author:

Kelly Tisdell (ktisdell)

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(Class<?> test)	Method to determine if this handler should execute.
default int	getOrder()
default void	postProcess(BatchContext<?> batchContext)	This method will be executed to allow further processing prior to a response being composed and returned.
default void	preProcess(BatchContext<?> batchContext)	This method will be executed to allow customers to fetch, for example, data that is required for future processing.

Method Details

canHandle

boolean canHandle(Class<?> test)

Method to determine if this handler should execute.

Parameters:

test -

Returns:

preProcess

default void preProcess(BatchContext<?> batchContext)

This method will be executed to allow customers to fetch, for example, data that is required for future processing. This is good in situations where you want to pre-fetch or batch fetch and pre-cache data for use within this batch context. Generally, implementors should save any results that they want to save and use later in BatchContext#getAdditionalProperties(). This method is called only if canHandle(Class) returns true. It is executed in AbstractDataExchangeService.saveAll(List, ContextInfo) after AbstractDataExchangeService.split(List, BatchContext) and before AbstractDataExchangeService.aggregate(BatchContext).

Parameters:

batchContext -

postProcess

default void postProcess(BatchContext<?> batchContext)

This method will be executed to allow further processing prior to a response being composed and returned. This will be called immediately prior to AbstractDataExchangeService.aggregate(BatchContext). Generally, implementors should make use of any results that they need in BatchContext.

Parameters:

batchContext -

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered