Package com.broadleafcommerce.datafeed.messaging.payload

Class IncrementalDataFeedEntityUpdateEvent

java.lang.Object

com.broadleafcommerce.datafeed.messaging.payload.IncrementalDataFeedEntityUpdateEvent

All Implemented Interfaces:

Serializable

public class IncrementalDataFeedEntityUpdateEvent
extends Object
implements Serializable

Microservices such as catalog, pricing, and inventory will send this type of message to notify data feed services when an entity is updated in a way that should result in a product being 'republished' to interested data feeds. For example, if a SKU goes out of stock, we would want the product associated to that SKU to be re-processed such that its availability is up-to-date on the corresponding data feeds. Ideally, this would happen soon after receipt rather than waiting for the next DefaultDataFeedProcessTypes.FULL_AUTHORITATIVE execution.

Note that the actual change which occurred on the originating entity is not a concern of this mechanism - it is only interested in understanding which products are affected so that it can engage the full fetch + publish process for them (which would naturally obtain all the latest state).

Note that the entity change should have happened at a production (non-sandbox) level, since sandbox-level changes are not relevant to data feeds.

See Also:

• IncrementalDataFeedEntityUpdateRecord
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IncrementalDataFeedEntityUpdateEvent()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAffectedProductReferenceType()	Should contain a value from DefaultIncrementalEventProductReferenceTypes describing the type of product reference in getAffectedProductReferenceValue().
String	getAffectedProductReferenceValue()	The reference key value of the product affected by this entity update event.
String	getApplicationId()	The application ID in which the change occurred, if the change occurred at the application level.
Instant	getOriginalEventTime()	Notification events from other services should include timestamps describing when the actual update occurred, and we record it here.
String	getTenantId()	The tenant ID in which the change occurred.
int	hashCode()
void	setAffectedProductReferenceType(String affectedProductReferenceType)	Should contain a value from DefaultIncrementalEventProductReferenceTypes describing the type of product reference in getAffectedProductReferenceValue().
void	setAffectedProductReferenceValue(String affectedProductReferenceValue)	The reference key value of the product affected by this entity update event.
void	setApplicationId(String applicationId)	The application ID in which the change occurred, if the change occurred at the application level.
void	setOriginalEventTime(Instant originalEventTime)	Notification events from other services should include timestamps describing when the actual update occurred, and we record it here.
void	setTenantId(String tenantId)	The tenant ID in which the change occurred.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IncrementalDataFeedEntityUpdateEvent

public IncrementalDataFeedEntityUpdateEvent()

Method Details

getAffectedProductReferenceType

public String getAffectedProductReferenceType()

Should contain a value from DefaultIncrementalEventProductReferenceTypes describing the type of product reference in getAffectedProductReferenceValue().

Different services may use different mechanisms to reference products, which is why this is necessary.

Returns:

the type of product reference in getAffectedProductReferenceValue()

See Also:

• IncrementalDataFeedEntityUpdateRecord.getAffectedProductReferenceType()

getAffectedProductReferenceValue

public String getAffectedProductReferenceValue()

The reference key value of the product affected by this entity update event.

Returns:

the reference key value of the product affected by this entity update event

See Also:

• getAffectedProductReferenceType()
• IncrementalDataFeedEntityUpdateRecord.getAffectedProductReferenceValue()

getOriginalEventTime

public Instant getOriginalEventTime()

Notification events from other services should include timestamps describing when the actual update occurred, and we record it here.

Returns:

the timestamp describing when the actual update event occurred

See Also:

• IncrementalDataFeedEntityUpdateRecord.getOriginalEventTime()

getApplicationId

@Nullable
public String getApplicationId()

The application ID in which the change occurred, if the change occurred at the application level.

Returns:

the application ID in which the change occurred, if the change occurred at the application level

getTenantId

public String getTenantId()

The tenant ID in which the change occurred.

Returns:

the tenant ID in which the change occurred

setAffectedProductReferenceType

public void setAffectedProductReferenceType(String affectedProductReferenceType)

Should contain a value from DefaultIncrementalEventProductReferenceTypes describing the type of product reference in getAffectedProductReferenceValue().

Different services may use different mechanisms to reference products, which is why this is necessary.

Parameters:

affectedProductReferenceType - the type of product reference in getAffectedProductReferenceValue()

See Also:

• IncrementalDataFeedEntityUpdateRecord.getAffectedProductReferenceType()

setAffectedProductReferenceValue

public void setAffectedProductReferenceValue(String affectedProductReferenceValue)

The reference key value of the product affected by this entity update event.

Parameters:

affectedProductReferenceValue - the reference key value of the product affected by this entity update event

See Also:

• getAffectedProductReferenceType()
• IncrementalDataFeedEntityUpdateRecord.getAffectedProductReferenceValue()

setOriginalEventTime

public void setOriginalEventTime(Instant originalEventTime)

Notification events from other services should include timestamps describing when the actual update occurred, and we record it here.

Parameters:

originalEventTime - the timestamp describing when the actual update event occurred

See Also:

• IncrementalDataFeedEntityUpdateRecord.getOriginalEventTime()

setApplicationId

public void setApplicationId(@Nullable
 String applicationId)

The application ID in which the change occurred, if the change occurred at the application level.

Parameters:

applicationId - the application ID in which the change occurred, if the change occurred at the application level

setTenantId

public void setTenantId(String tenantId)

The tenant ID in which the change occurred.

Parameters:

tenantId - the tenant ID in which the change occurred

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object