com.neurosys.ecom.strategy.service

Class DefaultLockStrategy<P extends Product,U extends IGenericEcomUser>

java.lang.Object

com.neurosys.ecom.strategy.service.DefaultLockStrategy<P,U>

All Implemented Interfaces:

LockStrategy<P,U>

public class DefaultLockStrategy<P extends Product,U extends IGenericEcomUser>
extends Object
implements LockStrategy<P,U>

A default implementation for LockStrategy
WARNING : This implementation is suited for a Single VM type installation, not for a multi-node architecture.

Author:

Arjun Dhar

Nested Class Summary

Nested classes/interfaces inherited from interface com.neurosys.ecom.strategy.service.LockStrategy

LockStrategy.Lock, LockStrategy.LockException

Constructor Summary

Constructors

Constructor and Description
DefaultLockStrategy()

Method Summary

Modifier and Type	Method and Description
Collection<LockStrategy.Lock>	getLocksForProducts(Collection<P> products) Get LockStrategy.Lock for a Product
Collection<LockStrategy.Lock>	getLocksForProducts(Collection<P> products, U user, String sessionId) Get LockStrategy.Lock for a Product
Collection<LockStrategy.Lock>	getLocksForUser(U user, String sessionId) Get the LockStrategy.Locks for a User
int	getMinutesForLockExpire() Default time to keep a Lock alive; from last user Action Ideally, this value should match session time out value If value is < = 0 then no locks will be applied.
boolean	isLockValid(LockStrategy.Lock lock) While processing locks, check if a LockStrategy.Lock is valid or not @ the given instance of time By default a LockStrategy.Lock more than #minutesForLockExpire minutes is invalid.
LockStrategy.Lock	lockUnitsForUser(P product, U user, String sessionId, Number units) During the purchase process allow the ability to lock away certain units for a User.
void	remove(P product) Clear entries for A Product
void	setMinutesForLockExpire(int minutesForLockExpire) Default time to keep a Lock alive; from last user Action Ideally, this value should match session time out value If value is < = 0 then no locks will be applied.
void	unlock(Collection<LockStrategy.Lock> locks) If a transaction was abandoned, not completed or forced out then one can unlock it.
void	unlock(LockStrategy.Lock lock) If a transaction was abandoned, not completed or forced out then one can unlock it.
void	unlockSession(U user, String sessionId) Convenience/Consistent method; commonly used to Unlock all Locks for a Users session

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLockStrategy

public DefaultLockStrategy()

Method Detail

isLockValid

public boolean isLockValid(LockStrategy.Lock lock)

Description copied from interface: LockStrategy

While processing locks, check if a LockStrategy.Lock is valid or not @ the given instance of time By default a LockStrategy.Lock more than #minutesForLockExpire minutes is invalid.

Specified by:

isLockValid in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

Returns:

lockUnitsForUser

public LockStrategy.Lock lockUnitsForUser(P product,
                                          U user,
                                          String sessionId,
                                          Number units)

Description copied from interface: LockStrategy

During the purchase process allow the ability to lock away certain units for a User. The LOCK may have a t

Specified by:

lockUnitsForUser in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

user - @nullable true

sessionId - @nullable true

getLocksForUser

public Collection<LockStrategy.Lock> getLocksForUser(U user,
                                                     String sessionId)

Description copied from interface: LockStrategy

Get the LockStrategy.Locks for a User

Specified by:

getLocksForUser in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

Parameters:

user - as U

Returns:

unlock

public void unlock(LockStrategy.Lock lock)
            throws LockStrategy.LockException

Description copied from interface: LockStrategy

If a transaction was abandoned, not completed or forced out then one can unlock it.

Specified by:

unlock in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

Parameters:

lock - as LockStrategy.Lock

Throws:

LockStrategy.LockException - if unable to LockStrategy.Lock

unlock

public void unlock(Collection<LockStrategy.Lock> locks)
            throws LockStrategy.LockException

Description copied from interface: LockStrategy

If a transaction was abandoned, not completed or forced out then one can unlock it.

Specified by:

unlock in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

Parameters:

locks - as Collection of LockStrategy.Lock

Throws:

LockStrategy.LockException - if unable to LockStrategy.Lock

unlockSession

public void unlockSession(U user,
                          String sessionId)

Description copied from interface: LockStrategy

Convenience/Consistent method; commonly used to Unlock all Locks for a Users session

Specified by:

unlockSession in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

Parameters:

user - as U

sessionId - as String

getLocksForProducts

public Collection<LockStrategy.Lock> getLocksForProducts(Collection<P> products,
                                                         U user,
                                                         String sessionId)

Description copied from interface: LockStrategy

Get LockStrategy.Lock for a Product

Specified by:

getLocksForProducts in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

user - as U

sessionId - as String

Returns:

Collection of LockStrategy.Lock @nullable true

getLocksForProducts

public Collection<LockStrategy.Lock> getLocksForProducts(Collection<P> products)

Description copied from interface: LockStrategy

Get LockStrategy.Lock for a Product

Specified by:

getLocksForProducts in interface LockStrategy<P extends Product,U extends IGenericEcomUser>

Returns:

Collection of LockStrategy.Lock @nullable true

getMinutesForLockExpire

public int getMinutesForLockExpire()

Default time to keep a Lock alive; from last user Action
Ideally, this value should match session time out value
If value is < = 0 then no locks will be applied.

Default value:

30

setMinutesForLockExpire

public void setMinutesForLockExpire(int minutesForLockExpire)

Default time to keep a Lock alive; from last user Action
Ideally, this value should match session time out value
If value is < = 0 then no locks will be applied.

Default value:

30

remove

public void remove(P product)

Description copied from interface: LockStrategy

Clear entries for A Product

Specified by:

remove in interface LockStrategy<P extends Product,U extends IGenericEcomUser>