Package com.broadleafcommerce.inventory.service.messaging.fulfillments

Class AbstractFulfillmentStatusChangeInventoryAdjustmentListener

java.lang.Object

com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

com.broadleafcommerce.inventory.service.messaging.fulfillments.AbstractFulfillmentStatusChangeInventoryAdjustmentListener

Direct Known Subclasses:

FulfillmentCancelledInventoryAdjustmentListener, FulfillmentFulfilledInventoryAdjustmentListener

public abstract class AbstractFulfillmentStatusChangeInventoryAdjustmentListener
extends AbstractInventoryAdjustmentListener

Listens for fulfillment status changes to create InventoryTransactions and update SkuInventory.

Nested Class Summary

Nested classes/interfaces inherited from class com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

AbstractInventoryAdjustmentListener.OrderFulfillment, AbstractInventoryAdjustmentListener.OrderFulfillmentItem, AbstractInventoryAdjustmentListener.OrderItem

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	FULFILLMENT_ID_PATH
protected static final String	FULFILLMENT_ITEMS_PATH
protected static final String	FULFILLMENT_STATUS_PATH
static final String	NEVER_RESERVATION_STRATEGY
protected static final String	ORDER_ITEMS_PATH

Fields inherited from class com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

APPLICATION_ID_PATH, INVENTORY_SERIALIZATION_VALUE, TENANT_ID_PATH

Constructor Summary

Constructors

Constructor	Description
AbstractFulfillmentStatusChangeInventoryAdjustmentListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, SkuInventoryService<SkuInventory> skuInventoryService)

Method Summary

Modifier and Type	Method	Description
protected List<SkuInventoryAdjustmentRequestItem>	buildRequestedItems(List<AbstractInventoryAdjustmentListener.OrderFulfillmentItem> fulfillmentItems, List<AbstractInventoryAdjustmentListener.OrderItem> orderItems)	Builds SkuInventoryAdjustmentRequestItems for each of the fulfillmentItems.
protected String	buildSerializedSku(AbstractInventoryAdjustmentListener.OrderItem orderItem)	Builds a sku with an appended serialization value parameter
protected SkuInventoryAdjustmentRequestItem	buildSkuInventoryAdjustmentItem(AbstractInventoryAdjustmentListener.OrderFulfillmentItem fulfillmentItem, AbstractInventoryAdjustmentListener.OrderItem orderItem)	Builds a SkuInventoryAdjustmentRequestItem with data from provided objects.
protected SkuInventoryAdjustmentRequest	buildSkuInventoryAdjustmentRequest(@NonNull com.jayway.jsonpath.DocumentContext jsonContext, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds the SkuInventoryAdjustmentRequest based on the fulfillment info in the status change message.
protected String	getInventorySerializationValue(AbstractInventoryAdjustmentListener.OrderItem orderItem)	Hook point to get the serialization value of an order item
List<AbstractInventoryAdjustmentListener.OrderItem>	getOrderItemsIncludingDependents(@NonNull com.jayway.jsonpath.DocumentContext jsonContext)	Gets a list of OrderItems along with their dependent items.
protected abstract String	getValidFulfillmentStatus()	Supplies the valid fulfillment status which can be handled.
protected boolean	isSerialized(AbstractInventoryAdjustmentListener.OrderItem orderItem)	Determines whether the order item has a serialized sku inventory object
protected abstract void	performInventoryAdjustment(SkuInventoryAdjustmentRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Execute the required inventory adjustment for the status change.
void	process(@NonNull org.springframework.messaging.Message<String> message)	Extracts the message, creates InventoryTransactions and updates SkuInventory.

Methods inherited from class com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

buildContextInfo, buildContextInfo, getDocumentContext, getIdempotentConsumptionService, getSkuInventoryService, getSkuReferenceFieldType, getTypeFactory

Methods inherited from class java.lang.Object

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

Field Details

FULFILLMENT_ID_PATH

protected static final String FULFILLMENT_ID_PATH

See Also:

• Constant Field Values

FULFILLMENT_STATUS_PATH

protected static final String FULFILLMENT_STATUS_PATH

See Also:

• Constant Field Values

FULFILLMENT_ITEMS_PATH

protected static final String FULFILLMENT_ITEMS_PATH

See Also:

• Constant Field Values

ORDER_ITEMS_PATH

protected static final String ORDER_ITEMS_PATH

See Also:

• Constant Field Values

NEVER_RESERVATION_STRATEGY

public static final String NEVER_RESERVATION_STRATEGY

See Also:

• Constant Field Values

Constructor Details

AbstractFulfillmentStatusChangeInventoryAdjustmentListener

public AbstractFulfillmentStatusChangeInventoryAdjustmentListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 SkuInventoryService<SkuInventory> skuInventoryService)

Method Details

process

public void process(@NonNull
 @NonNull org.springframework.messaging.Message<String> message)

Extracts the message, creates InventoryTransactions and updates SkuInventory.

Parameters:

message - The fulfillment cancelled event message

getValidFulfillmentStatus

protected abstract String getValidFulfillmentStatus()

Supplies the valid fulfillment status which can be handled.

Returns:

the valid fulfillment status which can be handled

buildSkuInventoryAdjustmentRequest

protected SkuInventoryAdjustmentRequest buildSkuInventoryAdjustmentRequest(@NonNull
 @NonNull com.jayway.jsonpath.DocumentContext jsonContext,
 @NonNull
 @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds the SkuInventoryAdjustmentRequest based on the fulfillment info in the status change message.

Parameters:

jsonContext - a DocumentContext representation of the fulfillment message payload

contextInfo - Context information around sandbox and multitenant state.

Returns:

The SkuInventoryAdjustmentRequest based on the fulfillment info in the status change message.

getOrderItemsIncludingDependents

public List<AbstractInventoryAdjustmentListener.OrderItem> getOrderItemsIncludingDependents(@NonNull
 @NonNull com.jayway.jsonpath.DocumentContext jsonContext)

Gets a list of OrderItems along with their dependent items.

buildRequestedItems

protected List<SkuInventoryAdjustmentRequestItem> buildRequestedItems(List<AbstractInventoryAdjustmentListener.OrderFulfillmentItem> fulfillmentItems,
 List<AbstractInventoryAdjustmentListener.OrderItem> orderItems)

Builds SkuInventoryAdjustmentRequestItems for each of the fulfillmentItems.

Parameters:

fulfillmentItems - the fulfillment items to build adjustment request items for

orderItems - the order items from the fulfillment's order which contain item SKU data

Returns:

inventory adjustment request items for the fulfillmentItems

buildSkuInventoryAdjustmentItem

protected SkuInventoryAdjustmentRequestItem buildSkuInventoryAdjustmentItem(AbstractInventoryAdjustmentListener.OrderFulfillmentItem fulfillmentItem,
 AbstractInventoryAdjustmentListener.OrderItem orderItem)

Builds a SkuInventoryAdjustmentRequestItem with data from provided objects.

Parameters:

fulfillmentItem - the fulfillment item

orderItem - the order item

Returns:

the built sku inventory adjustment item

isSerialized

protected boolean isSerialized(AbstractInventoryAdjustmentListener.OrderItem orderItem)

Determines whether the order item has a serialized sku inventory object

Parameters:

orderItem - the order item

Returns:

whether the order item has a serialized sku inventory object

buildSerializedSku

protected String buildSerializedSku(AbstractInventoryAdjustmentListener.OrderItem orderItem)

Builds a sku with an appended serialization value parameter

Parameters:

orderItem - order item to access values from

Returns:

sku with an appended serialization value parameter

getInventorySerializationValue

@Nullable
protected String getInventorySerializationValue(AbstractInventoryAdjustmentListener.OrderItem orderItem)

Hook point to get the serialization value of an order item

By default, accesses a respective entry inside AbstractInventoryAdjustmentListener.OrderItem.getInternalAttributes().

Parameters:

orderItem - the order item

Returns:

the serialization value

performInventoryAdjustment

protected abstract void performInventoryAdjustment(SkuInventoryAdjustmentRequest request,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                            throws InventoryUnavailableException,
InventoryNotReservedException

Execute the required inventory adjustment for the status change.

Parameters:

request - the request to adjust inventory

contextInfo - context information surrounding sandboxing and multitenant state

Throws:

InventoryUnavailableException - if inventory could not be decremented

InventoryNotReservedException - if inventory was not already reserved