Package com.broadleafcommerce.datafeed.service

Class DefaultDataFeedPublicationService<P extends DataFeedPublication>

java.lang.Object

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

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

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

Type Parameters:

P - business/projection type of DataFeedPublication

All Implemented Interfaces:

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

public class DefaultDataFeedPublicationService<P extends DataFeedPublication>
extends com.broadleafcommerce.data.tracking.core.service.BaseRsqlCrudEntityService<P>
implements DataFeedPublicationService<P>

Default implementation of DataFeedPublicationService

Constructor Summary

Constructors

Constructor	Description
DefaultDataFeedPublicationService(DataFeedPublicationRepository<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 DataFeedPublicationRepository<com.broadleafcommerce.data.tracking.core.Trackable>	getPublicationRepository()
List<P>	initializeNotificationStateAndEmitMessage(List<String> ids, String messageType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Atomically finds the DataFeedPublication instances for the given ids, and initializes their NotificationState for messageType.
Optional<P>	readByContextIdAndDataFeedProcessExecutionId(String id, String dataFeedProcessExecutionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads the DataFeedPublication by id and the data feed process execution id.
List<P>	readByProcessExecutionId(String dataFeedProcessExecutionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads all DataFeedPublication instances belonging to the given DataFeedProcessExecution.
org.springframework.data.domain.Page<P>	readByProcessExecutionId(String dataFeedProcessExecutionId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads the DataFeedPublication instances for the specified data feed process execution id.
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 DataFeedPublication.getStatus() and completion details on the specified publication.
P	setStatusAndStartTime(String id, String newStatus, Instant startTime, String whereCurrentStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Atomically sets a new DataFeedPublication.getStatus() and DataFeedPublication.getStartTime() on the specified publication.

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

DefaultDataFeedPublicationService

public DefaultDataFeedPublicationService(DataFeedPublicationRepository<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

readByProcessExecutionId

public List<P> readByProcessExecutionId(String dataFeedProcessExecutionId,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: DataFeedPublicationService

Reads all DataFeedPublication instances belonging to the given DataFeedProcessExecution.

Specified by:

readByProcessExecutionId in interface DataFeedPublicationService<P extends DataFeedPublication>

Parameters:

dataFeedProcessExecutionId - the value of DataFeedPublication.getDataFeedProcessExecutionId() to match

contextInfo - context information around multitenant state

Returns:

a list of all found publication instances

readByProcessExecutionId

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

Description copied from interface: DataFeedPublicationService

Reads the DataFeedPublication instances for the specified data feed process execution id.

Specified by:

readByProcessExecutionId in interface DataFeedPublicationService<P extends DataFeedPublication>

Parameters:

dataFeedProcessExecutionId - the data feed process execution id

filters - the RSQL Node used to restrict result

page - the requested page of results from the database

contextInfo - context information around multitenant state

Returns:

the DataFeedPublication instances for the specified data feed process execution id

readByContextIdAndDataFeedProcessExecutionId

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

Description copied from interface: DataFeedPublicationService

Reads the DataFeedPublication by id and the data feed process execution id.

Specified by:

readByContextIdAndDataFeedProcessExecutionId in interface DataFeedPublicationService<P extends DataFeedPublication>

Parameters:

id - the data feed publication id

dataFeedProcessExecutionId - the data feed process execution id

contextInfo - context information around multitenant state

Returns:

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

initializeNotificationStateAndEmitMessage

public List<P> initializeNotificationStateAndEmitMessage(List<String> ids,
 String messageType,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: DataFeedPublicationService

Atomically finds the DataFeedPublication instances for the given ids, and initializes their NotificationState for messageType.

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

Specified by:

initializeNotificationStateAndEmitMessage in interface DataFeedPublicationService<P extends DataFeedPublication>

Parameters:

ids - the DataFeedPublication.getId() ids for which to initialize and emit the message. Cannot be empty.

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

contextInfo - context information around multitenant state

Returns:

the DataFeedPublication instances that were successfully found and updated (omitting those which were not successfully updated)

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: DataFeedPublicationService

Atomically sets a new DataFeedPublication.getStatus() and DataFeedPublication.getStartTime() on the specified publication.

Specified by:

setStatusAndStartTime in interface DataFeedPublicationService<P extends DataFeedPublication>

Parameters:

id - the ID of the publication to update

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

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

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

contextInfo - context information around multitenant state

Returns:

the updated publication 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: DataFeedPublicationService

Atomically sets a new DataFeedPublication.getStatus() and completion details on the specified publication.

Specified by:

setStatusAndCompletionDetails in interface DataFeedPublicationService<P extends DataFeedPublication>

Parameters:

id - the ID of the publication to update

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

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

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

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

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

contextInfo - context information around multitenant state

Returns:

the updated publication if successfully updated, else null

getPublicationRepository

protected DataFeedPublicationRepository<com.broadleafcommerce.data.tracking.core.Trackable> getPublicationRepository()

getNotificationManager

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