Package com.broadleafcommerce.datafeed.service.manager

Class DataFeedPublicationManager

java.lang.Object

com.broadleafcommerce.datafeed.service.manager.DataFeedPublicationManager

public class DataFeedPublicationManager
extends Object

Responsible for managing the lifecycle of a DataFeedPublication operation.

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

Constructor Summary

Constructors

Constructor	Description
DataFeedPublicationManager(DataFeedPublicationConfigurationService feedPublicationConfigurationService, DataFeedPublicationService<DataFeedPublication> publicationService, DataFeedProcessExecutionService<DataFeedProcessExecution> executionService, List<DataFeedPublisher> publishers, com.broadleafcommerce.common.extension.TypeFactory typeFactory, StorageService storageService)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	buildContextInfo(String tenantId, com.broadleafcommerce.data.tracking.core.type.OperationType operationType)
protected DataFeedPublishResponseDetails	buildPublishResponse(boolean containsErrors, List<String> errorDetails)
protected void	completePublication(String dataFeedPublicationId, DataFeedPublishResponseDetails publishResponse, String tenantId)
protected Path	copyQueriedDataToTemporaryFile(String uniqueFilenameInContext, String tenantId)
protected DataFeedPublisher	findEligibleFeedPublisher(DataFeedPublishRequestDetails request)
protected DataFeedProcessExecutionManager	getExecutionManager()	Lazy injection of this component since both are at a similar level of abstraction and we want to avoid circular dependency issues.
protected DataFeedProcessExecutionService<DataFeedProcessExecution>	getExecutionService()
protected DataFeedPublicationConfigurationService	getFeedPublicationConfigurationService()
protected DataFeedPublicationService<DataFeedPublication>	getPublicationService()
protected List<DataFeedPublisher>	getPublishers()
protected StorageService	getStorageService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected List<String>	preparePublishRequest(DataFeedPublishRequestDetails toInitialize, DataFeedPublication publication, String tenantId)	Prepares and initializes the given DataFeedPublishRequestDetails instance for the publication.
void	runPublication(String dataFeedPublicationId, String requestingTenantId)	Actually runs the provided existing data feed publication.
void	setExecutionManager(DataFeedProcessExecutionManager executionManager)	Lazy injection of this component since both are at a similar level of abstraction and we want to avoid circular dependency issues.

Methods inherited from class java.lang.Object

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

Constructor Details

DataFeedPublicationManager

public DataFeedPublicationManager(DataFeedPublicationConfigurationService feedPublicationConfigurationService,
 DataFeedPublicationService<DataFeedPublication> publicationService,
 DataFeedProcessExecutionService<DataFeedProcessExecution> executionService,
 List<DataFeedPublisher> publishers,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 StorageService storageService)

Method Details

runPublication

public void runPublication(String dataFeedPublicationId,
 String requestingTenantId)

Actually runs the provided existing data feed publication.

Parameters:

dataFeedPublicationId - the DataFeedPublication.getId() which needs to be run. This must exist in the datastore with status DefaultDataFeedPublicationStatuses.REQUESTED.

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

buildContextInfo

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

preparePublishRequest

protected List<String> preparePublishRequest(DataFeedPublishRequestDetails toInitialize,
 DataFeedPublication publication,
 String tenantId)

Prepares and initializes the given DataFeedPublishRequestDetails instance for the publication.

Parameters:

toInitialize - a newly instantiated DataFeedPublishRequestDetails instance that should have its fields initialized

publication - the publication for which this request is being built

tenantId - the current context tenant ID

Returns:

a list containing any error messages that may have occurred during preparation, else an empty list

copyQueriedDataToTemporaryFile

@Nullable
protected Path copyQueriedDataToTemporaryFile(@Nullable
 String uniqueFilenameInContext,
 String tenantId)

findEligibleFeedPublisher

@Nullable
protected DataFeedPublisher findEligibleFeedPublisher(DataFeedPublishRequestDetails request)

buildPublishResponse

protected DataFeedPublishResponseDetails buildPublishResponse(boolean containsErrors,
 List<String> errorDetails)

completePublication

protected void completePublication(String dataFeedPublicationId,
 DataFeedPublishResponseDetails publishResponse,
 String tenantId)

getFeedPublicationConfigurationService

protected DataFeedPublicationConfigurationService getFeedPublicationConfigurationService()

getPublicationService

protected DataFeedPublicationService<DataFeedPublication> getPublicationService()

getExecutionService

protected DataFeedProcessExecutionService<DataFeedProcessExecution> getExecutionService()

getPublishers

protected List<DataFeedPublisher> getPublishers()

getTypeFactory

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

getStorageService

protected StorageService getStorageService()

getExecutionManager

protected DataFeedProcessExecutionManager getExecutionManager()

Lazy injection of this component since both are at a similar level of abstraction and we want to avoid circular dependency issues.

setExecutionManager

@Autowired
@Lazy
public void setExecutionManager(DataFeedProcessExecutionManager executionManager)

Lazy injection of this component since both are at a similar level of abstraction and we want to avoid circular dependency issues.