org.broadleafcommerce.core.web.order

Class SessionOrderLockManager

java.lang.Object

org.broadleafcommerce.core.web.order.SessionOrderLockManager

All Implemented Interfaces:

EventListener, OrderLockManager, org.springframework.context.ApplicationListener<org.springframework.security.web.session.HttpSessionDestroyedEvent>

public class SessionOrderLockManager
extends Object
implements OrderLockManager, org.springframework.context.ApplicationListener<org.springframework.security.web.session.HttpSessionDestroyedEvent>

An HttpSession based OrderLockManager. This implementation is less concerned with the given Order and instead will lock on the user's session to serialize order modification requests.

Author:

Andre Azzolini (apazzolini)

Constructor Summary

Constructors

Constructor and Description
SessionOrderLockManager()

Method Summary

Methods

Modifier and Type	Method and Description
Object	acquireLock(Order order) Note that although this method accepts an Order parameter, it does not use it in any way.
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 javax.servlet.http.HttpServletRequest	getRequest()
protected ReentrantLock	getSessionLock()
boolean	isActive() This method indicates if the lock manager is active.
void	onApplicationEvent(org.springframework.security.web.session.HttpSessionDestroyedEvent event)
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

Constructor Detail

SessionOrderLockManager

public SessionOrderLockManager()

Method Detail

acquireLock

public Object acquireLock(Order order)

Note that although this method accepts an Order parameter, it does not use it in any way. This session-based lock manager implementation will prevent all operations that are identified as requiring a lock from happening in parallel. Instead, it will execute them sequentially as locks are released from previous implementations.

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

onApplicationEvent

public void onApplicationEvent(org.springframework.security.web.session.HttpSessionDestroyedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.security.web.session.HttpSessionDestroyedEvent>

getRequest

protected javax.servlet.http.HttpServletRequest getRequest()

getSessionLock

protected ReentrantLock getSessionLock()

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: