org.broadleafcommerce.core.web.order

Class DatabaseOrderLockManager

java.lang.Object

org.broadleafcommerce.core.web.order.DatabaseOrderLockManager

All Implemented Interfaces:

OrderLockManager

public class DatabaseOrderLockManager
extends Object
implements OrderLockManager

An implementation of the OrderLockManager that relies on the database to provide synchronization for locks on Orders. This class leverages the OrderLock domain object to provide this functionality.

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	LOG
protected OrderService	orderService

Constructor Summary

Constructors

Constructor and Description
DatabaseOrderLockManager()

Method Summary

Methods

Modifier and Type	Method and Description
Object	acquireLock(Order order) Blocks the requesting thread until able to acquire a lock for the given order.
Object	acquireLockIfAvailable(Order order) This method differs from OrderLockManager.acquireLock(Order) in that it will not block if the lock is currently held by a different caller.
protected int	getDatabaseLockAcquisitionNumRetries()
protected long	getDatabaseLockPollingIntervalMs()
boolean	isActive() This method indicates if the lock manager is active.
void	releaseLock(Object lockObject) Releases the given lockObject and notifies any threads that are waiting on that object that they are able to attempt to acquire the lock.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

orderService

protected OrderService orderService

Constructor Detail

DatabaseOrderLockManager

public DatabaseOrderLockManager()

Method Detail

acquireLock

public Object acquireLock(Order order)

Description copied from interface: OrderLockManager

Blocks the requesting thread until able to acquire a lock for the given order. NOTE: Callers of this method MUST call OrderLockManager.releaseLock(Object), passing in the Object returned from this call once their critical section has executed. The suggested idiom for this operation is: Object lockObject = null; try { lockObject = orderLockManager.acquireLock(order); // Do something } finally { orderLockManager.releaseLock(lockObject); }

Specified by:

acquireLock in interface OrderLockManager

Returns:

the lock object, which should be passed in as the parameter to OrderLockManager.releaseLock(Object) once the operation that required a lock has completed.

acquireLockIfAvailable

public Object acquireLockIfAvailable(Order order)

Description copied from interface: OrderLockManager

This method differs from OrderLockManager.acquireLock(Order) in that it will not block if the lock is currently held by a different caller. In the case that the lock was not able to be immediately acquired, this method will return null.

Specified by:

acquireLockIfAvailable in interface OrderLockManager

Returns:

the lock if it was immediately acquireable, null otherwise

See Also:

OrderLockManager.acquireLock(Order)

releaseLock

public void releaseLock(Object lockObject)

Description copied from interface: OrderLockManager

Releases the given lockObject and notifies any threads that are waiting on that object that they are able to attempt to acquire the lock.

Specified by:

releaseLock in interface OrderLockManager

getDatabaseLockPollingIntervalMs

protected long getDatabaseLockPollingIntervalMs()

getDatabaseLockAcquisitionNumRetries

protected int getDatabaseLockAcquisitionNumRetries()

isActive

public boolean isActive()

Description copied from interface: OrderLockManager

This method indicates if the lock manager is active. It can return a static value or a dynamic one based on values in the BroadleafRequestContext or other stateful mechanism. A good example of when this might be dynamic is when there is a session-based lock and the request indicates that it is not OK to use sessions.

Specified by:

isActive in interface OrderLockManager

Returns: