Package com.broadleafcommerce.datafeed.service

Class DefaultDataFeedProcessExecutionService<P extends DataFeedProcessExecution>

java.lang.Object

com.broadleafcommerce.data.tracking.core.service.BaseCrudEntityService<P>

com.broadleafcommerce.data.tracking.core.service.BaseRsqlCrudEntityService<P>

com.broadleafcommerce.datafeed.service.DefaultDataFeedProcessExecutionService<P>

Type Parameters:

P - business/projection type of DataFeedProcessExecution

All Implemented Interfaces:

com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>, DataFeedProcessExecutionService<P>

public class DefaultDataFeedProcessExecutionService<P extends DataFeedProcessExecution>
extends com.broadleafcommerce.data.tracking.core.service.BaseRsqlCrudEntityService<P>
implements DataFeedProcessExecutionService<P>

Default implementation of DataFeedProcessExecutionService

Constructor Summary

Constructors

Constructor	Description
DefaultDataFeedProcessExecutionService(DataFeedProcessExecutionRepository<com.broadleafcommerce.data.tracking.core.Trackable> repository, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityHelper helper, com.broadleafcommerce.common.messaging.notification.NotificationManager notificationManager)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.common.messaging.notification.NotificationManager	getNotificationManager()
protected DataFeedProcessExecutionRepository<com.broadleafcommerce.data.tracking.core.Trackable>	getProcessExecutionRepository()
P	initializeNotificationStateAndEmitMessage(String id, String messageType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Atomically finds the DataFeedProcessExecution for the given id, and initializes its NotificationState for messageType.
org.springframework.data.domain.Page<P>	readAllByDataFeedProcessId(String dataFeedProcessId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads the DataFeedProcessExecution instances for the specified data feed process id.
Optional<P>	readByContextIdAndDataFeedProcessId(String id, String dataFeedProcessId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads the DataFeedProcessExecution by id and the data feed process id.
Optional<P>	readByContextIdOpt(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Similar to CrudEntityService.readByContextId(String, ContextInfo), but returns an Optional instead of throwing EntityMissingException when not found.
P	setQueriedDataFileLocation(String id, String queriedDataFileLocation, String whereCurrentStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Atomically sets DataFeedProcessExecution.getQueriedDataFileLocation() on the specified execution.
P	setStatus(String id, String newStatus, String whereCurrentStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Atomically sets a new DataFeedProcessExecution.getStatus() on the specified execution.
P	setStatusAndCompletionDetails(String id, String newStatus, Instant endTime, boolean containsErrors, List<String> errorDetails, String whereCurrentStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Atomically sets a new DataFeedProcessExecution.getStatus() and completion details on the specified execution.
P	setStatusAndStartTime(String id, String newStatus, Instant startTime, String whereCurrentStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Atomically sets a new DataFeedProcessExecution.getStatus() and DataFeedProcessExecution.getStartTime() on the specified execution.

Methods inherited from class com.broadleafcommerce.data.tracking.core.service.BaseRsqlCrudEntityService

getRsqlHelper, readAll, readAll, readAll, readAll

Methods inherited from class com.broadleafcommerce.data.tracking.core.service.BaseCrudEntityService

convertFromPersistentDomain, convertToPersistentDomain, create, createAll, createAllAllowingPartialSuccess, delete, getHelper, getRepository, getSortPositionStrategy, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, setSortPositionStrategy, update, updateAll, updateAllAllowingPartialSuccess, updateSort

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

readAll, readAll, readAll, readAll

Constructor Details

DefaultDataFeedProcessExecutionService

public DefaultDataFeedProcessExecutionService(DataFeedProcessExecutionRepository<com.broadleafcommerce.data.tracking.core.Trackable> repository,
 com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityHelper helper,
 @Nullable
 com.broadleafcommerce.common.messaging.notification.NotificationManager notificationManager)

Method Details

readByContextIdOpt

public Optional<P> readByContextIdOpt(String id,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from interface: DataFeedProcessExecutionService

Similar to CrudEntityService.readByContextId(String, ContextInfo), but returns an Optional instead of throwing EntityMissingException when not found.

Specified by:

readByContextIdOpt in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

id - The context id for the entity. This is the id by which the business recognizes the item.

context - Context information used to discriminate the correct version of an entity by context id when multiple verions may be available across sandboxes, catalogs and applications.

Returns:

an Optional containing the narrowed entity instance in the form of a business instance, else Optional.empty()

readByContextIdAndDataFeedProcessId

public Optional<P> readByContextIdAndDataFeedProcessId(String id,
 String dataFeedProcessId,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from interface: DataFeedProcessExecutionService

Reads the DataFeedProcessExecution by id and the data feed process id.

Specified by:

readByContextIdAndDataFeedProcessId in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

id - The context id for the entity

dataFeedProcessId - the data feed process id

context - context information around multitenant state

Returns:

an Optional containing the narrowed entity instance in the form of a business instance, else Optional.empty()

readAllByDataFeedProcessId

public org.springframework.data.domain.Page<P> readAllByDataFeedProcessId(String dataFeedProcessId,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @Nullable
 org.springframework.data.domain.Pageable page,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from interface: DataFeedProcessExecutionService

Reads the DataFeedProcessExecution instances for the specified data feed process id.

Specified by:

readAllByDataFeedProcessId in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

dataFeedProcessId - the data feed process id

filters - the RSQL Node used to restrict result

page - the requested page of results from the database

context - context information around multitenant state

Returns:

the DataFeedProcessExecution instances for the specified data feed process id

initializeNotificationStateAndEmitMessage

@Nullable
public P initializeNotificationStateAndEmitMessage(String id,
 String messageType,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: DataFeedProcessExecutionService

Atomically finds the DataFeedProcessExecution for the given id, and initializes its NotificationState for messageType.

If the update is successful, calls NotificationManager.handle(NotificationStateRepository, NotificationStateAware, String) for the messageType, which will emit the message.

Specified by:

initializeNotificationStateAndEmitMessage in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

id - the DataFeedProcessExecution.getId() for which to initialize and emit the message

messageType - the message type (ex: NotificationState.getName()

contextInfo - context information around multitenant state

Returns:

the updated DataFeedProcessExecution if successfully found and updated, null otherwise

setStatus

@Nullable
public P setStatus(String id,
 String newStatus,
 @Nullable
 String whereCurrentStatus,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: DataFeedProcessExecutionService

Atomically sets a new DataFeedProcessExecution.getStatus() on the specified execution.

Specified by:

setStatus in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

id - the ID of the execution to update

newStatus - the new value to set for DataFeedProcessExecution.getStatus()

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

contextInfo - context information around multitenant state

Returns:

the updated execution if successfully updated, else null

setStatusAndStartTime

@Nullable
public P setStatusAndStartTime(String id,
 String newStatus,
 Instant startTime,
 @Nullable
 String whereCurrentStatus,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: DataFeedProcessExecutionService

Atomically sets a new DataFeedProcessExecution.getStatus() and DataFeedProcessExecution.getStartTime() on the specified execution.

Specified by:

setStatusAndStartTime in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

id - the ID of the execution to update

newStatus - the new value to set for DataFeedProcessExecution.getStatus()

startTime - the value to set for DataFeedProcessExecution.getStartTime()

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

contextInfo - context information around multitenant state

Returns:

the updated execution if successfully updated, else null

setStatusAndCompletionDetails

@Nullable
public P setStatusAndCompletionDetails(String id,
 String newStatus,
 Instant endTime,
 boolean containsErrors,
 @Nullable
 List<String> errorDetails,
 @Nullable
 String whereCurrentStatus,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: DataFeedProcessExecutionService

Atomically sets a new DataFeedProcessExecution.getStatus() and completion details on the specified execution.

Specified by:

setStatusAndCompletionDetails in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

id - the ID of the execution to update

newStatus - the new value to set for DataFeedProcessExecution.getStatus()

endTime - the value to set for DataFeedProcessExecution.getEndTime()

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()

contextInfo - context information around multitenant state

Returns:

the updated execution if successfully updated, else null

setQueriedDataFileLocation

@Nullable
public P setQueriedDataFileLocation(String id,
 String queriedDataFileLocation,
 @Nullable
 String whereCurrentStatus,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: DataFeedProcessExecutionService

Atomically sets DataFeedProcessExecution.getQueriedDataFileLocation() on the specified execution.

Specified by:

setQueriedDataFileLocation in interface DataFeedProcessExecutionService<P extends DataFeedProcessExecution>

Parameters:

id - the ID of the execution to update

queriedDataFileLocation - the value to set for DataFeedProcessExecution.getQueriedDataFileLocation()

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

contextInfo - context information around multitenant state

Returns:

the updated execution if successfully updated, else null

getProcessExecutionRepository

protected DataFeedProcessExecutionRepository<com.broadleafcommerce.data.tracking.core.Trackable> getProcessExecutionRepository()

getNotificationManager

@Nullable
protected com.broadleafcommerce.common.messaging.notification.NotificationManager getNotificationManager()