Package com.broadleafcommerce.inventory.service.messaging.checkout

Class OrderSubmittedInventoryAdjustmentMessageListener

java.lang.Object

com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

com.broadleafcommerce.inventory.service.messaging.checkout.OrderSubmittedInventoryAdjustmentMessageListener

@DataRouteByKey("inventory")
public class OrderSubmittedInventoryAdjustmentMessageListener
extends AbstractInventoryAdjustmentListener

Message Listener to listen for submitted orders, parse them, and create HARD_RESERVATION InventoryTransaction (i.e. HARD Reservations).

Author:

Kelly Tisdell (ktisdell), Nathan Moore (nathandmoore)

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
static final String	CART_ID_PATH
static final String	CART_ITEM_LINK_PATH	The path to the cart item link.
static final String	CART_ITEMS_PATH	Deprecated. since 1.5.
static final String	FULFILLMENT_GROUP_LINK_PATH	The path to the fulfillment group link.
static final String	FULFILLMENT_GROUPS_PATH	Deprecated. since 1.5.
static final String	ORDER_STATUS_PATH
static final String	SUBMITTED_STATUS

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

APPLICATION_ID_PATH, INVENTORY_SERIALIZATION_VALUE, TENANT_ID_PATH

Constructor Summary

Constructors

Constructor	Description
OrderSubmittedInventoryAdjustmentMessageListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentMessageConsumptionService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, SkuInventoryService<SkuInventory> skuInventoryService, CartProvider cartProvider)

Method Summary

Modifier and Type	Method	Description
protected List<SkuInventoryAdjustmentRequestItem>	buildRequestedItems(@NonNull Map<String,? extends CartItem> cartItems, @NonNull List<? extends FulfillmentItem> fulfillmentItems)	Iterates over the fulfillmentItems to determine for which a SkuInventoryAdjustmentRequestItem should be made.
protected String	buildSerializedSku(CartItem cartItem)	Builds a sku with an appended serialization value parameter
protected SkuInventoryAdjustmentRequestItem	buildSkuInventoryAdjustmentItem(FulfillmentItem fulfillmentItem, CartItem cartItem)	Builds a SkuInventoryAdjustmentRequestItem with data from provided objects.
protected SkuInventoryReservationRequest	buildSkuInventoryReservationRequest(@NonNull com.jayway.jsonpath.DocumentContext jsonContext, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds the SkuInventoryReservationRequest based on the fulfillment info in the checkout completion message.
protected List<CartItem>	getCartItemsWithDependentItems(String cartItemLink, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected CartProvider	getCartProvider()
protected String	getInventorySerializationValue(CartItem cartItem)	Hook point to get the serialization value of a cart item
protected boolean	isSerialized(CartItem cartItem)	Determines whether the cart item has a serialized sku inventory object
void	listen(org.springframework.messaging.Message<String> message)
void	processMessage(@NonNull org.springframework.messaging.Message<String> message)	Processes the received message by extracting fields relevant for recording inventory adjustments.

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

SUBMITTED_STATUS

public static final String SUBMITTED_STATUS

See Also:

• Constant Field Values

CART_ID_PATH

public static final String CART_ID_PATH

See Also:

• Constant Field Values

ORDER_STATUS_PATH

public static final String ORDER_STATUS_PATH

See Also:

• Constant Field Values

CART_ITEMS_PATH

@Deprecated
public static final String CART_ITEMS_PATH

Deprecated.

since 1.5. Cart items now need to be read from the cart service. See CartProvider and CART_ITEM_LINK_PATH

See Also:

• Constant Field Values

FULFILLMENT_GROUPS_PATH

@Deprecated
public static final String FULFILLMENT_GROUPS_PATH

Deprecated.

since 1.5. Fulfillment groups now need to be read from the cart service. See CartProvider and FULFILLMENT_GROUP_LINK_PATH

See Also:

• Constant Field Values

CART_ITEM_LINK_PATH

public static final String CART_ITEM_LINK_PATH

The path to the cart item link. This link must be used to retrieve cart items via GET request to the cart service.

See Also:

• Constant Field Values

FULFILLMENT_GROUP_LINK_PATH

public static final String FULFILLMENT_GROUP_LINK_PATH

The path to the fulfillment group link. This link must be used to retrieve fulfillment groups via GET request to the cart service.

See Also:

• Constant Field Values

Constructor Details

OrderSubmittedInventoryAdjustmentMessageListener

public OrderSubmittedInventoryAdjustmentMessageListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentMessageConsumptionService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 SkuInventoryService<SkuInventory> skuInventoryService,
 CartProvider cartProvider)

Method Details

listen

@StreamListener("checkoutCompletionInputInventory")
public void listen(org.springframework.messaging.Message<String> message)

processMessage

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

Processes the received message by extracting fields relevant for recording inventory adjustments.

Parameters:

message - The checkout completion message received with payload

buildSkuInventoryReservationRequest

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

Builds the SkuInventoryReservationRequest based on the fulfillment info in the checkout completion message.

Parameters:

jsonContext - a DocumentContext representation of the checkout completion message payload

contextInfo - Context information around sandbox and multitenant state.

Returns:

The SkuInventoryReservationRequest based on the fulfillment info in the checkout completion message.

buildRequestedItems

protected List<SkuInventoryAdjustmentRequestItem> buildRequestedItems(@NonNull
 @NonNull Map<String,? extends CartItem> cartItems,
 @NonNull
 @NonNull List<? extends FulfillmentItem> fulfillmentItems)

Iterates over the fulfillmentItems to determine for which a SkuInventoryAdjustmentRequestItem should be made.

Parameters:

cartItems - The cart line items with the merchandise information

fulfillmentItems - The fulfillment items corresponding to the cartItems that represent the fulfillment information for those particular line items. These contain the information necessary to determine whether to build a SkuInventoryAdjustmentRequestItem.

Returns:

A list of SkuInventoryReservationRequestItems that should be handled by the inventory service

buildSkuInventoryAdjustmentItem

protected SkuInventoryAdjustmentRequestItem buildSkuInventoryAdjustmentItem(FulfillmentItem fulfillmentItem,
 CartItem cartItem)

Builds a SkuInventoryAdjustmentRequestItem with data from provided objects.

Parameters:

fulfillmentItem - the fulfillment item

cartItem - the cart item

Returns:

the built sku inventory adjustment item

isSerialized

protected boolean isSerialized(CartItem cartItem)

Determines whether the cart item has a serialized sku inventory object

Parameters:

cartItem - the cart item

Returns:

whether the cart item has a serialized sku inventory object

buildSerializedSku

protected String buildSerializedSku(CartItem cartItem)

Builds a sku with an appended serialization value parameter

Parameters:

cartItem - cart item to access values from

Returns:

sku with an appended serialization value parameter

getInventorySerializationValue

@Nullable
protected String getInventorySerializationValue(CartItem cartItem)

Hook point to get the serialization value of a cart item

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

Parameters:

cartItem - the cart item

Returns:

the serialization value

getCartItemsWithDependentItems

protected List<CartItem> getCartItemsWithDependentItems(String cartItemLink,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getCartProvider

protected CartProvider getCartProvider()