com.broadleafcommerce.inventory.advanced.service

Class AdvancedInventoryServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler

com.broadleafcommerce.inventory.advanced.service.AdvancedInventoryServiceExtensionHandler

All Implemented Interfaces:

org.broadleafcommerce.common.extension.ExtensionHandler, org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionHandler

@Component(value="blAdvancedInventoryServiceExtensionHandler")
public class AdvancedInventoryServiceExtensionHandler
extends org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler
implements org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionManager	extensionManager
protected AdvancedInventoryService	inventoryService
protected InventoryLocationResolver	locationResolver
protected List<InventoryReservationStrategy>	reservationStrategies Injects all of the InventoryReservationStrategy types
static String	ROLLBACK_BLC_ADVANCED_INVENTORY_DECREMENTED
static String	ROLLBACK_BLC_ADVANCED_INVENTORY_INCREMENTED
static String	ROLLBACK_BLC_ADVANCED_INVENTORY_ORDER_ID
protected InventoryReservationStrategy	selectedStrategy

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AdvancedInventoryServiceExtensionHandler()

Method Summary

Modifier and Type	Method and Description
protected void	buildReservationsAndInventoryMap(org.broadleafcommerce.core.order.domain.Order order, Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventoryMap, List<InventoryReservation> inventoryReservations)
protected Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>	buildSkuQuantityMapFromLocationMap(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> locationMap)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	decrementInventory(Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> skuQuantities, Map<String,Object> context)
protected void	decrementInventoryFromLocations(Map<String,Object> context, org.broadleafcommerce.core.order.domain.Order order, Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventoryMap, List<InventoryReservation> inventoryReservations, Map<String,Object> rollbackState)
protected org.broadleafcommerce.core.order.domain.Order	getChangeOrderFromContext(Map<String,Object> context)
int	getMaxRetries()
protected org.broadleafcommerce.core.order.domain.Order	getOrderFromContext(Map<String,Object> context)
protected InventoryReservationStrategy	getReservationStrategy()
protected Map<String,Object>	getRollbackStateFromContext(Map<String,Object> context)
protected org.broadleafcommerce.core.catalog.domain.Sku	getSkuForItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	incrementInventory(Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> skuQuantities, Map<String,Object> context)
void	init()
org.broadleafcommerce.common.extension.ExtensionResultStatusType	reconcileChangeOrderInventory(Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> decrementSkuQuantities, Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> incrementSkuQuantities, Map<String,Object> context) In the case of a change order (i.e from the OMS workflow), we need to rollback existing reservations and start over in order to reconcile the difference in inventory and reservations that have already been committed.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	retrieveQuantitiesAvailable(Collection<org.broadleafcommerce.core.catalog.domain.Sku> skus, Map<String,Object> context, org.broadleafcommerce.common.extension.ExtensionResultHolder<Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> result)
protected Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>>	reverseLocationQuantityMapFromReservations(List<InventoryReservation> reservations) Given a list of reservations (e.g.
protected void	validateReservationQuantities(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item, List<InventoryReservation> reservations)

Methods inherited from class org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler

isProductBundleAvailable

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionHandler

isProductBundleAvailable

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Field Detail

ROLLBACK_BLC_ADVANCED_INVENTORY_DECREMENTED

public static final String ROLLBACK_BLC_ADVANCED_INVENTORY_DECREMENTED

See Also:

Constant Field Values

ROLLBACK_BLC_ADVANCED_INVENTORY_INCREMENTED

public static final String ROLLBACK_BLC_ADVANCED_INVENTORY_INCREMENTED

See Also:

Constant Field Values

ROLLBACK_BLC_ADVANCED_INVENTORY_ORDER_ID

public static final String ROLLBACK_BLC_ADVANCED_INVENTORY_ORDER_ID

See Also:

Constant Field Values

locationResolver

protected InventoryLocationResolver locationResolver

inventoryService

protected AdvancedInventoryService inventoryService

extensionManager

protected org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionManager extensionManager

reservationStrategies

@Autowired
protected List<InventoryReservationStrategy> reservationStrategies

Injects all of the InventoryReservationStrategy types

selectedStrategy

protected InventoryReservationStrategy selectedStrategy

Constructor Detail

AdvancedInventoryServiceExtensionHandler

public AdvancedInventoryServiceExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

retrieveQuantitiesAvailable

public org.broadleafcommerce.common.extension.ExtensionResultStatusType retrieveQuantitiesAvailable(Collection<org.broadleafcommerce.core.catalog.domain.Sku> skus,
                                                                                                    Map<String,Object> context,
                                                                                                    org.broadleafcommerce.common.extension.ExtensionResultHolder<Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> result)

Specified by:

retrieveQuantitiesAvailable in interface org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionHandler

Overrides:

retrieveQuantitiesAvailable in class org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler

decrementInventory

public org.broadleafcommerce.common.extension.ExtensionResultStatusType decrementInventory(Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> skuQuantities,
                                                                                           Map<String,Object> context)
                                                                                    throws org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

Specified by:

decrementInventory in interface org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionHandler

Overrides:

decrementInventory in class org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler

Throws:

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

decrementInventoryFromLocations

protected void decrementInventoryFromLocations(Map<String,Object> context,
                                               org.broadleafcommerce.core.order.domain.Order order,
                                               Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventoryMap,
                                               List<InventoryReservation> inventoryReservations,
                                               Map<String,Object> rollbackState)
                                        throws org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

Throws:

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

buildReservationsAndInventoryMap

protected void buildReservationsAndInventoryMap(org.broadleafcommerce.core.order.domain.Order order,
                                                Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventoryMap,
                                                List<InventoryReservation> inventoryReservations)
                                         throws org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

Throws:

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

reverseLocationQuantityMapFromReservations

protected Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> reverseLocationQuantityMapFromReservations(List<InventoryReservation> reservations)

Given a list of reservations (e.g. from an originally submitted order), reverse engineer the skuQuantitiesMap in order to perform a rollback

Parameters:

reservations -

Returns:

buildSkuQuantityMapFromLocationMap

protected Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> buildSkuQuantityMapFromLocationMap(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> locationMap)

validateReservationQuantities

protected void validateReservationQuantities(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item,
                                             @Nullable
                                             List<InventoryReservation> reservations)
                                      throws org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

Throws:

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

getSkuForItem

protected org.broadleafcommerce.core.catalog.domain.Sku getSkuForItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item)

incrementInventory

public org.broadleafcommerce.common.extension.ExtensionResultStatusType incrementInventory(Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> skuQuantities,
                                                                                           Map<String,Object> context)

Specified by:

incrementInventory in interface org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionHandler

Overrides:

incrementInventory in class org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler

reconcileChangeOrderInventory

public org.broadleafcommerce.common.extension.ExtensionResultStatusType reconcileChangeOrderInventory(Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> decrementSkuQuantities,
                                                                                                      Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer> incrementSkuQuantities,
                                                                                                      Map<String,Object> context)
                                                                                               throws org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

In the case of a change order (i.e from the OMS workflow), we need to rollback existing reservations and start over in order to reconcile the difference in inventory and reservations that have already been committed. Once rolled back, the default implementation is to re-build all reservations given the state and quantities of the new change order.

Specified by:

reconcileChangeOrderInventory in interface org.broadleafcommerce.core.inventory.service.InventoryServiceExtensionHandler

Overrides:

reconcileChangeOrderInventory in class org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler

Parameters:

decrementSkuQuantities -

incrementSkuQuantities -

context -

Returns:

Throws:

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

getReservationStrategy

protected InventoryReservationStrategy getReservationStrategy()

getOrderFromContext

protected org.broadleafcommerce.core.order.domain.Order getOrderFromContext(Map<String,Object> context)

getChangeOrderFromContext

protected org.broadleafcommerce.core.order.domain.Order getChangeOrderFromContext(Map<String,Object> context)

getRollbackStateFromContext

protected Map<String,Object> getRollbackStateFromContext(Map<String,Object> context)

getMaxRetries

public int getMaxRetries()