com.broadleafcommerce.enterprise.workflow.site

Interface EnterpriseOrderDao

All Known Implementing Classes:

EnterpriseOrderDaoImpl

public interface EnterpriseOrderDao

Responsible for finding a cart for a Customer instance. This cart retrieval is further enhanced with code to detect if the current Hibernate L2 cached version of the cart is stale compared to the database version. This staleness detection includes not only the cart, but all important, subordinate associations and collections.

This functionality is primarily useful in conjunction with stateless clusters (i.e. no session affinity), or with node failover when session affinity is in play. It would allow a customer to retain appropriate order state, for example, in the following use case:

• Customer begins an order on node 1 as a registered user
• Customer logs out
• Customer logs back in, presumably on a new node (2)
• Customer makes a change to the order
• Customer logs out
• Customer logs back in, presumably back on node 1

In the above use case, the customer would normally be the recipient of a stale, cached version of the order on the final step. The functionality provided in EnterpriseOrderDao serves to make sure the cart state is fresh during any node switching.

This functionality is disabled by default. To enable, set the 'order.outOfSyncCache.refresh' property to true in your installation's property file. Please note, this functionality comes at the cost of a new, albeit optimized, query at the beginning of every request thread to check for the DB node affiliation for the current cart. This information is used to compare against the cart pulled from L2 cache.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.core.order.domain.Order	findStaleCacheAwareCartForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer) Find the current IN_PROCESS cart for the customer.
org.broadleafcommerce.core.order.domain.Order	findStaleCacheAwareCartForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer, org.broadleafcommerce.core.order.domain.Order candidateCart) Confirm the candidate cart is not stale in comparison to the current DB state.
CartInfo	readCartInfoForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer) Retrieve information about the customer's current cart that is relevant for making a staleness determination.

Method Detail

findStaleCacheAwareCartForCustomer

org.broadleafcommerce.core.order.domain.Order findStaleCacheAwareCartForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer)

Find the current IN_PROCESS cart for the customer. Confirm the cart that pulled from cache, if any, is not stale in comparison to the current DB state. If so, refresh the cart state.

Parameters:

customer - the user for whom the cart is retrieved

Returns:

the up-to-date cart

findStaleCacheAwareCartForCustomer

org.broadleafcommerce.core.order.domain.Order findStaleCacheAwareCartForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer,
                                                                                 org.broadleafcommerce.core.order.domain.Order candidateCart)

Confirm the candidate cart is not stale in comparison to the current DB state. If so, refresh the cart state.

Parameters:

customer - the user to whom the candidate cart belongs

candidateCart - the cart instance that was already retrieved and for which verification should be performed

Returns:

the up-to-date cart

readCartInfoForCustomer

CartInfo readCartInfoForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer)

Retrieve information about the customer's current cart that is relevant for making a staleness determination. This generally includes the cart id and node affiliation of the cart.

Parameters:

customer - the user for whom the cart info is retrieved

Returns:

the cart staleness information