Package org.broadleafcommerce.core.inventory.service

Class InventoryServiceImpl

java.lang.Object

org.broadleafcommerce.core.inventory.service.InventoryServiceImpl

All Implemented Interfaces:

ContextualInventoryService, InventoryService

@Service("blInventoryService")
public class InventoryServiceImpl
extends Object
implements ContextualInventoryService

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected CatalogService	catalogService
protected InventoryServiceExtensionManager	extensionManager

Fields inherited from interface org.broadleafcommerce.core.inventory.service.ContextualInventoryService

CHANGE_ORDER_KEY, ORDER_KEY, ROLLBACK_STATE_KEY

Constructor Summary

Constructors

Constructor	Description
InventoryServiceImpl()

Method Summary

Modifier and Type	Method	Description
Map<Sku,Integer>	buildSkuInventoryMap(Order order)	Convenience method to build the sku inventory map given an Order
boolean	checkBasicAvailablility(Sku sku)	Without worrying about quantities, just checks to see if the given Sku is available.
void	checkSkuAvailability(Order order, Sku sku, Integer requestedQuantity)
void	decrementInventory(Map<Sku,Integer> skuQuantities)	Attempts to decrement inventory for a map of Skus and quantities
void	decrementInventory(Map<Sku,Integer> skuQuantities, Map<String,Object> context)	Usually invoked from DecrementInventoryActivity
void	decrementInventory(Sku sku, int quantity)	Attempts to decrement inventory if it is available.
void	decrementInventory(Sku sku, int quantity, Map<String,Object> context)	Pass through for ContextualInventoryService.decrementInventory(Map, Map)
protected void	decrementSku(Map<Sku,Integer> skuQuantities, Map<String,Object> context)
void	incrementInventory(Map<Sku,Integer> skuQuantities)	Attempts to increment inventory for a map of Skus and quantities.
void	incrementInventory(Map<Sku,Integer> skuQuantities, Map<String,Object> context)	Callers that invoke this method directly should check for a ContextualInventoryService.ROLLBACK_STATE_KEY in the given context.
void	incrementInventory(Sku sku, int quantity)	Attempts to increment inventory.
void	incrementInventory(Sku sku, int quantity, Map<String,Object> context)
protected void	incrementSku(Map<Sku,Integer> skuQuantities, Map<String,Object> context)
protected void	invalidateEntity(Class<?> clazz, String id)	Given the class and identifier of an entity, invalidates the cache for that entity
protected void	invalidateSkuInventory(Sku sku)	Invalidates the cache for a given sku
boolean	isAvailable(Sku sku, int quantity)	Indicates whether the given quantity is available for the particular skuId.
boolean	isAvailable(Sku sku, int quantity, Map<String,Object> context)
void	reconcileChangeOrderInventory(Map<Sku,Integer> decrementSkuQuantities, Map<Sku,Integer> incrementSkuQuantities, Map<String,Object> context)	Explicit method that defines exactly how to reconcile inventory in the event of a change order.
Map<Sku,Integer>	retrieveQuantitiesAvailable(Collection<Sku> skus)	Retrieves the quantity available for a given sku.
Map<Sku,Integer>	retrieveQuantitiesAvailable(Collection<Sku> skus, Map<String,Object> context)
Integer	retrieveQuantityAvailable(Sku sku)	Retrieves the quantity available for a given sku.
Integer	retrieveQuantityAvailable(Sku sku, Map<String,Object> context)

Methods inherited from class java.lang.Object

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

Field Details

catalogService

protected CatalogService catalogService

extensionManager

protected InventoryServiceExtensionManager extensionManager

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

Constructor Details

InventoryServiceImpl

public InventoryServiceImpl()

Method Details

checkBasicAvailablility

public boolean checkBasicAvailablility(Sku sku)

Description copied from interface: InventoryService

Without worrying about quantities, just checks to see if the given Sku is available. A Sku is generally available if any of these is true:

1. Sku.getInventoryType() is null
2. Sku.getInventoryType() is anything but InventoryType.UNAVAILABLE
3. Sku.isActive() is is true or null
4. Does not consider the now-deprecated Sku.isAvailable()

* @param sku the Sku whose availability is being checked

Specified by:

checkBasicAvailablility in interface InventoryService

Returns:

true or false according to the rules above

retrieveQuantityAvailable

public Integer retrieveQuantityAvailable(Sku sku)

Description copied from interface: InventoryService

Retrieves the quantity available for a given sku. May return null if no inventory is maintained for the given sku when Sku.getInventoryType() == null or the InventoryType of the given sku is InventoryType.ALWAYS_AVAILABLE. Effectively, if the quantity returned is null, inventory is undefined, which most likely means it is available. However, rather than returning an arbitrary integer values (like Integer.MAX_VALUE), which has specific meaning, we return null as this can be interpreted by the client to mean whatever they define it as (including infinitely available), which is the most likely scenario.

In practice, this is a convenience method to wrap InventoryService.retrieveQuantitiesAvailable(Collection)

Specified by:

retrieveQuantityAvailable in interface InventoryService

Returns:

null if there is no inventory strategy defined (meaning, Sku.getInventoryType() is null or InventoryType.ALWAYS_AVAILABLE). Otherwise, this returns the quantity of the Sku

retrieveQuantitiesAvailable

public Map<Sku,Integer> retrieveQuantitiesAvailable(Collection<Sku> skus)

Description copied from interface: InventoryService

Retrieves the quantity available for a given sku. May return null if no inventory is maintained for the given sku when Sku.getInventoryType() == null or the InventoryType of the given sku is InventoryType.ALWAYS_AVAILABLE. Effectively, if the quantity returned is null, inventory is undefined, which most likely means it is available. However, rather than returning an arbitrary integer values (like Integer.MAX_VALUE), which has specific meaning, we return null as this can be interpreted by the client to mean whatever they define it as (including infinitely available), which is the most likely scenario.

Specified by:

retrieveQuantitiesAvailable in interface InventoryService

Parameters:

skus - the set of Skus to return inventory for

Returns:

a map of the given set of skus to the quantity as represented in the inventory system. The Map.keySet() is the same collection of given skus

isAvailable

public boolean isAvailable(Sku sku,
 int quantity)

Description copied from interface: InventoryService

Indicates whether the given quantity is available for the particular skuId. The result will be true if Sku.getInventoryType() == null or Sku.getInventoryType().equals(InventoryType.ALWAYS_AVAILABLE).

The result will be false if the InventoryService.checkBasicAvailablility(Sku) returns false, or if the quantity field is null, or if the quantity requested exceeds the quantity available.

Specified by:

isAvailable in interface InventoryService

Parameters:

sku - the Sku to see if enough quantity is available

quantity - the quantity to check for the given sku

Returns:

true if there is available quantity

decrementInventory

@Transactional(value="blTransactionManager",
               rollbackFor=InventoryUnavailableException.class)
public void decrementInventory(Sku sku,
 int quantity)
                        throws InventoryUnavailableException

Description copied from interface: InventoryService

Attempts to decrement inventory if it is available. If the Sku is marked as InventoryType.ALWAYS_AVAILABLE then this will be a no-op.

This method is a convenience method to wrap InventoryService.decrementInventory(Map)

Specified by:

decrementInventory in interface InventoryService

Parameters:

sku - the Sku to decrement inventory from

quantity - the quantity to take inventory from

Throws:

InventoryUnavailableException - if there is not enough of the given quantity for the given sku

decrementInventory

@Transactional(value="blTransactionManager",
               rollbackFor=InventoryUnavailableException.class)
public void decrementInventory(Map<Sku,Integer> skuQuantities)
                        throws InventoryUnavailableException

Description copied from interface: InventoryService

Attempts to decrement inventory for a map of Skus and quantities

Quantities must be greater than zero or an IllegalArgumentException will be thrown.

If any of the given Skus inventory type is not InventoryType.CHECK_QUANTITY then this is a no-op and nothing actually happens

Specified by:

decrementInventory in interface InventoryService

Parameters:

skuQuantities - a map from a Sku to the quantity attempting to decrement

Throws:

InventoryUnavailableException - if there is not enough inventory to decrement from any of the given skus or if InventoryService.checkBasicAvailablility(Sku) returns false

incrementInventory

@Transactional("blTransactionManager")
public void incrementInventory(Sku sku,
 int quantity)

Description copied from interface: InventoryService

Attempts to increment inventory. Quantity must be greater than zero or an IllegalArgumentException will be thrown.

This is a convenience method to wrap InventoryService.incrementInventory(Map)

Specified by:

incrementInventory in interface InventoryService

Parameters:

sku - the Sku whose inventory should be incremented

quantity - greater than zero

incrementInventory

@Transactional("blTransactionManager")
public void incrementInventory(Map<Sku,Integer> skuQuantities)

Description copied from interface: InventoryService

Attempts to increment inventory for a map of Skus and quantities. All must not be null and must be greater than zero or an IllegalArgumentException will be thrown.

If any of the given Skus inventory type is not InventoryType.CHECK_QUANTITY then this is a no-op and nothing actually happens

Specified by:

incrementInventory in interface InventoryService

Parameters:

skuQuantities - the map of a Sku to the quantity that should be incremented

retrieveQuantityAvailable

public Integer retrieveQuantityAvailable(Sku sku,
 Map<String,Object> context)

Specified by:

retrieveQuantityAvailable in interface ContextualInventoryService

context - can be null. If not null, this should at least contain the #CART_CONTEXT_KEY

retrieveQuantitiesAvailable

public Map<Sku,Integer> retrieveQuantitiesAvailable(Collection<Sku> skus,
 Map<String,Object> context)

Specified by:

retrieveQuantitiesAvailable in interface ContextualInventoryService

context - can be null. If not null, this should at least contain the #CART_CONTEXT_KEY

isAvailable

public boolean isAvailable(Sku sku,
 int quantity,
 Map<String,Object> context)

Specified by:

isAvailable in interface ContextualInventoryService

context - can be null. If not null, this should at least contain the #CART_CONTEXT_KEY

decrementInventory

@Transactional(value="blTransactionManager",
               rollbackFor=InventoryUnavailableException.class)
public void decrementInventory(Sku sku,
 int quantity,
 Map<String,Object> context)
                        throws InventoryUnavailableException

Description copied from interface: ContextualInventoryService

Pass through for ContextualInventoryService.decrementInventory(Map, Map)

Specified by:

decrementInventory in interface ContextualInventoryService

Throws:

InventoryUnavailableException

decrementInventory

@Transactional(value="blTransactionManager",
               rollbackFor=InventoryUnavailableException.class)
public void decrementInventory(Map<Sku,Integer> skuQuantities,
 Map<String,Object> context)
                        throws InventoryUnavailableException

Description copied from interface: ContextualInventoryService

Usually invoked from DecrementInventoryActivity

Callers that invoke this method directly should check the given context object for a ContextualInventoryService.ROLLBACK_STATE_KEY. This will contain information about what actually happened in terms of decrementing inventory. For implementers of this interface

Implementers of this method (explicitly those that are utilizing the InventoryServiceExtensionHandler) should populate a ContextualInventoryService.ROLLBACK_STATE_KEY within the given context in order to communicate back to the caller what actually happened while decrementing inventory so that it can be undone later

Specified by:

decrementInventory in interface ContextualInventoryService

context - can be null. If not null, this should at least contain the ContextualInventoryService.ORDER_KEY and/or the ContextualInventoryService.ROLLBACK_STATE_KEY

Throws:

InventoryUnavailableException

decrementSku

protected void decrementSku(Map<Sku,Integer> skuQuantities,
 Map<String,Object> context)
                     throws InventoryUnavailableException

Throws:

InventoryUnavailableException

incrementInventory

@Transactional("blTransactionManager")
public void incrementInventory(Sku sku,
 int quantity,
 Map<String,Object> context)

Specified by:

incrementInventory in interface ContextualInventoryService

incrementInventory

@Transactional("blTransactionManager")
public void incrementInventory(Map<Sku,Integer> skuQuantities,
 Map<String,Object> context)

Description copied from interface: ContextualInventoryService

Callers that invoke this method directly should check for a ContextualInventoryService.ROLLBACK_STATE_KEY in the given context. This will contain information about what actually happened in terms of decrementing inventory

Implementers of this method (explicitly those that are utilizing the InventoryServiceExtensionHandler) should populate a ContextualInventoryService.ROLLBACK_STATE_KEY within the given context in order to communicate back to the caller what actually happened while decrementing inventory so that it can be undone later

Specified by:

incrementInventory in interface ContextualInventoryService

context - can be null. If not null, this should at least contain the ContextualInventoryService.ROLLBACK_STATE_KEY

incrementSku

protected void incrementSku(Map<Sku,Integer> skuQuantities,
 Map<String,Object> context)

reconcileChangeOrderInventory

public void reconcileChangeOrderInventory(Map<Sku,Integer> decrementSkuQuantities,
 Map<Sku,Integer> incrementSkuQuantities,
 Map<String,Object> context)
                                   throws InventoryUnavailableException

Description copied from interface: ContextualInventoryService

Explicit method that defines exactly how to reconcile inventory in the event of a change order. This usually occurs after an order has been submitted and any inventory changes and reservations/holds have already been committed.

Implementers of this method should assume that the quantities passed in are deltas and represent the changed quantities (either incremented or decremented) from the old order to the newly changed order.

Specified by:

reconcileChangeOrderInventory in interface ContextualInventoryService

Parameters:

decrementSkuQuantities - - the delta change of sku quantities to decrement

incrementSkuQuantities - - the delta change of sku quantities to increment

Throws:

InventoryUnavailableException

buildSkuInventoryMap

public Map<Sku,Integer> buildSkuInventoryMap(Order order)

Description copied from interface: ContextualInventoryService

Convenience method to build the sku inventory map given an Order

Specified by:

buildSkuInventoryMap in interface ContextualInventoryService

Returns:

a SKU to Quantity map represented by the items and quantities on the fulfillment group and fulfillment group items in the order.

invalidateSkuInventory

protected void invalidateSkuInventory(Sku sku)

Invalidates the cache for a given sku

Parameters:

sku - The Sku to be invalidated from cache

invalidateEntity

protected void invalidateEntity(Class<?> clazz,
 String id)

Given the class and identifier of an entity, invalidates the cache for that entity

Parameters:

clazz - The class of the entity to invalidate the cache for

id - The id of the entity to invalidate the cache for

checkSkuAvailability

public void checkSkuAvailability(Order order,
 Sku sku,
 Integer requestedQuantity)
                          throws InventoryUnavailableException

Specified by:

checkSkuAvailability in interface ContextualInventoryService

Throws:

InventoryUnavailableException