Package com.broadleafcommerce.datafeed.service.manager

Class DataFeedProcessExecutionManager

java.lang.Object

com.broadleafcommerce.datafeed.service.manager.DataFeedProcessExecutionManager

public class DataFeedProcessExecutionManager
extends Object

Responsible for managing the lifecycle of a DataFeedProcessExecution operation.

While DataFeedProcessExecutionService is in charge of CRUD-related operations on DataFeedProcessExecution, this service is a higher-level abstraction that performs the surrounding logic of processing execution operations. It internally delegates to DataFeedProcessExecutionService for CRUD operations.

Constructor Summary

Constructors

Constructor

Description

DataFeedProcessExecutionManager(DataFeedProcessService<DataFeedProcess> processService, DataFeedProcessExecutionService<DataFeedProcessExecution> processExecutionService, DataFeedPublicationService<DataFeedPublication> publicationService, IncrementalDataFeedEntityUpdateRecordService<IncrementalDataFeedEntityUpdateRecord> incrementalRecordService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, List<DataFeedCollector> dataFeedCollectors, StorageService storageService)

Method Summary

Modifier and Type	Method	Description
DataFeedProcessExecution	attemptCompletionOfExecution(String dataFeedProcessExecutionId, String requestingTenantId, boolean containsErrors, List<String> errorDetails, String whereCurrentStatus)	Attempt marking the given DataFeedProcessExecution as completed.
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	buildContextInfo(String tenantId, com.broadleafcommerce.data.tracking.core.type.OperationType operationType)
protected DataFeedProcessExecution	buildExecution(DataFeedProcess parent, String status)
protected DataFeedPublication	buildPublication(String dataFeedPublicationConfigurationId, DataFeedProcessExecution executionReadyForPublishing, String publicationStatus)	Builds a new DataFeedPublication instance.
protected List<DataFeedPublication>	buildPublications(DataFeedProcessExecution executionReadyForPublishing, String publicationStatus)
protected DataFeedCollectionResponse	engageCollection(DataFeedProcessExecution execution, String tenantId)
protected Optional<DataFeedCollector>	findDataFeedCollector(DataFeedCollectionRequest request)
protected List<DataFeedCollector>	getDataFeedCollectors()
protected IncrementalDataFeedEntityUpdateRecordService<IncrementalDataFeedEntityUpdateRecord>	getIncrementalRecordService()
protected DataFeedProcessExecutionService<DataFeedProcessExecution>	getProcessExecutionService()
protected DataFeedProcessService<DataFeedProcess>	getProcessService()
protected DataFeedPublicationService<DataFeedPublication>	getPublicationService()
protected StorageService	getStorageService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected DataFeedProcessExecution	handleCollectionResponse(DataFeedCollectionResponse dataFeedCollectionResponse, DataFeedProcessExecution execution, String tenantId)	Handles a data feed collection response.
protected void	handleRequestExecutionForFullAuthoritativeProcess(DataFeedProcess fullAuthoritativeProcess, String tenantId)	Handles requestExecution(String, String) for the given DefaultDataFeedProcessTypes.FULL_AUTHORITATIVE process.
protected void	handleRequestExecutionForPartialUpdateProcess(DataFeedProcess partialUpdateProcess, String tenantId)	Handles requestExecution(String, String) for the given DefaultDataFeedProcessTypes.PARTIAL_UPDATE process.
protected DataFeedCollectionRequest	prepareCollectionRequest(DataFeedProcessExecution execution, String tenantId)
void	requestExecution(String dataFeedProcessId, String requestingTenantId)	Prepares, creates, and initiates a DataFeedProcessExecution for the specified DataFeedProcess.
protected void	requestPublication(String dataFeedProcessExecutionId, String requestingTenantId)
void	runExecution(String dataFeedProcessExecutionId, String requestingTenantId)	Actually runs the provided existing data feed execution.

Methods inherited from class java.lang.Object

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

Constructor Details

DataFeedProcessExecutionManager

public DataFeedProcessExecutionManager(DataFeedProcessService<DataFeedProcess> processService,
 DataFeedProcessExecutionService<DataFeedProcessExecution> processExecutionService,
 DataFeedPublicationService<DataFeedPublication> publicationService,
 IncrementalDataFeedEntityUpdateRecordService<IncrementalDataFeedEntityUpdateRecord> incrementalRecordService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 List<DataFeedCollector> dataFeedCollectors,
 StorageService storageService)

Method Details

requestExecution

public void requestExecution(String dataFeedProcessId,
 String requestingTenantId)

Prepares, creates, and initiates a DataFeedProcessExecution for the specified DataFeedProcess.

This only creates and requests the execution - it does not actually begin running or processing that execution. For that, see runExecution(String, String)

Parameters:

dataFeedProcessId - the ID of the DataFeedProcess to start a new execution for

requestingTenantId - the tenant ID of where this execution request is coming from. This is important to prevent different tenants from requesting execution of processes in each other

buildContextInfo

protected com.broadleafcommerce.data.tracking.core.context.ContextInfo buildContextInfo(String tenantId,
 com.broadleafcommerce.data.tracking.core.type.OperationType operationType)

handleRequestExecutionForFullAuthoritativeProcess

protected void handleRequestExecutionForFullAuthoritativeProcess(DataFeedProcess fullAuthoritativeProcess,
 String tenantId)

Handles requestExecution(String, String) for the given DefaultDataFeedProcessTypes.FULL_AUTHORITATIVE process.

Parameters:

fullAuthoritativeProcess - the DefaultDataFeedProcessTypes.FULL_AUTHORITATIVE process to handle execution request for

tenantId - the tenant ID of the request

buildExecution

protected DataFeedProcessExecution buildExecution(DataFeedProcess parent,
 String status)

handleRequestExecutionForPartialUpdateProcess

protected void handleRequestExecutionForPartialUpdateProcess(DataFeedProcess partialUpdateProcess,
 String tenantId)

Handles requestExecution(String, String) for the given DefaultDataFeedProcessTypes.PARTIAL_UPDATE process.

Parameters:

partialUpdateProcess - the DefaultDataFeedProcessTypes.PARTIAL_UPDATE process to handle execution request for

tenantId - the tenant ID of the request

runExecution

public void runExecution(String dataFeedProcessExecutionId,
 String requestingTenantId)

Actually runs the provided existing data feed execution.

Parameters:

dataFeedProcessExecutionId - the DataFeedProcessExecution.getId() which needs to be run. This must exist in the datastore with status DefaultDataFeedExecutionStatuses.REQUESTED.

requestingTenantId - the tenant ID of where this run-execution request is coming from. This is important to prevent different tenants from running executions in each other

engageCollection

protected DataFeedCollectionResponse engageCollection(DataFeedProcessExecution execution,
 String tenantId)

prepareCollectionRequest

protected DataFeedCollectionRequest prepareCollectionRequest(DataFeedProcessExecution execution,
 String tenantId)

findDataFeedCollector

protected Optional<DataFeedCollector> findDataFeedCollector(DataFeedCollectionRequest request)

handleCollectionResponse

@Nullable
protected DataFeedProcessExecution handleCollectionResponse(DataFeedCollectionResponse dataFeedCollectionResponse,
 DataFeedProcessExecution execution,
 String tenantId)

Handles a data feed collection response. This includes transferring DataFeedCollectionResponse.getLocalCollectedDataFile() to the StorageService, as well as updating DataFeedProcessExecution in the data store as necessary.

Parameters:

dataFeedCollectionResponse - the data feed collection response

execution - the execution that this collection was originally happening for. This instance itself will not be directly mutated, and any changes will be directly applied in the data store.

tenantId - the tenant ID in which this process is happening

Returns:

a new instance of the execution after being updated in the data store (either with success or failure), or null if the instance could not be updated in the datastore altogether

requestPublication

protected void requestPublication(String dataFeedProcessExecutionId,
 String requestingTenantId)

buildPublications

protected List<DataFeedPublication> buildPublications(DataFeedProcessExecution executionReadyForPublishing,
 String publicationStatus)

buildPublication

protected DataFeedPublication buildPublication(String dataFeedPublicationConfigurationId,
 DataFeedProcessExecution executionReadyForPublishing,
 String publicationStatus)

Builds a new DataFeedPublication instance.

Parameters:

dataFeedPublicationConfigurationId - one of the values from DataFeedProcessExecution.getDataFeedPublicationConfigurationIds() to build the instance for

executionReadyForPublishing - the parent DataFeedProcessExecution to build the instance for

publicationStatus - a value from DefaultDataFeedPublicationStatuses to set on the publication

Returns:

the built instance

attemptCompletionOfExecution

@Nullable
public DataFeedProcessExecution attemptCompletionOfExecution(String dataFeedProcessExecutionId,
 String requestingTenantId,
 boolean containsErrors,
 @Nullable
 List<String> errorDetails,
 @Nullable
 String whereCurrentStatus)

Attempt marking the given DataFeedProcessExecution as completed.

Before calling this method, ensure that any DataFeedPublication instances for this execution are already marked completed.

Parameters:

dataFeedProcessExecutionId - the DataFeedProcessExecution.getId() which needs to be marked completed

requestingTenantId - the tenant ID of where this complete-execution request is coming from

containsErrors - the value to set for DataFeedProcessExecution.isContainsErrors()

errorDetails - (optional) the value to set for DataFeedProcessExecution.getErrorDetails()

whereCurrentStatus - (optional) if provided, the update will only be applied if the execution currently has this value for its DataFeedProcessExecution.getStatus()

Returns:

the DataFeedProcessExecution if successfully completed, null otherwise

getProcessService

protected DataFeedProcessService<DataFeedProcess> getProcessService()

getProcessExecutionService

protected DataFeedProcessExecutionService<DataFeedProcessExecution> getProcessExecutionService()

getPublicationService

protected DataFeedPublicationService<DataFeedPublication> getPublicationService()

getIncrementalRecordService

protected IncrementalDataFeedEntityUpdateRecordService<IncrementalDataFeedEntityUpdateRecord> getIncrementalRecordService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getDataFeedCollectors

protected List<DataFeedCollector> getDataFeedCollectors()

getStorageService

protected StorageService getStorageService()