com.konakart.bl

Class KKDBLockMgrEE

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.KKDBLockMgrEE

All Implemented Interfaces:

KKLockMgrIf

public class KKDBLockMgrEE
extends BaseMgr
implements KKLockMgrIf

Implements the KKLockMgrIf for distributed locking using the DB

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	initialised Initialised?
protected static java.lang.String	LOCK_APIS_ENABLED Configuration Key values
protected static boolean	LOCK_APIS_ENABLED_DEFAULT Configuration Key Defaults
protected static java.lang.String	LOCK_FAILURE_RE
protected static java.lang.String	LOCK_FAILURE_RE_DEFAULT
protected static java.lang.String	LOCK_SLEEP_MS
protected static int	LOCK_SLEEP_MS_DEFAULT
protected static java.lang.String	LOCK_TIMEOUT_MS
protected static int	LOCK_TIMEOUT_MS_DEFAULT
protected static java.lang.String	lockFailureRE Lock Failure RE
protected static boolean	lockingEnabled Is locking enabled?
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex Mutex for the Manager
protected static java.lang.String	RELEASE_FAILURE_RE
protected static java.lang.String	RELEASE_FAILURE_RE_DEFAULT
protected static java.lang.String	releaseFailureRE Release Failure RE
protected static int	sleepTimeMS Sleep time in MS
protected static int	timeoutMS Timeout in MS

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
KKDBLockMgrEE(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	acquire(java.lang.String lockName) Acquire a lock.
boolean	acquire(java.lang.String lockName, int sleepMS, int _timeoutMS) Acquire a lock.
protected boolean	acquireLockSQL(java.lang.String lockname, java.sql.Date now)
static java.lang.String	getLockFailureRE()
static java.lang.String	getReleaseFailureRE()
static int	getSleepTimeMS()
static int	getTimeoutMS()
protected void	initialise()
static boolean	isInitialised()
static boolean	isLockingEnabled()
void	refreshConfigs() Refresh the configuration of the manager
void	release(java.lang.String lockName) Release a lock for the specified object.
protected boolean	releaseLockSQL(java.lang.String lockName)
static void	setInitialised(boolean initialised)
static void	setLockFailureRE(java.lang.String lockFailureRE)
static void	setLockingEnabled(boolean lockingEnabled)
static void	setReleaseFailureRE(java.lang.String releaseFailureRE)
static void	setSleepTimeMS(int sleepTimeMS)
static void	setTimeoutMS(int timeoutMS)

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

LOCK_APIS_ENABLED

protected static final java.lang.String LOCK_APIS_ENABLED

Configuration Key values

See Also:

Constant Field Values

LOCK_TIMEOUT_MS

protected static final java.lang.String LOCK_TIMEOUT_MS

See Also:

Constant Field Values

LOCK_SLEEP_MS

protected static final java.lang.String LOCK_SLEEP_MS

See Also:

Constant Field Values

LOCK_FAILURE_RE

protected static final java.lang.String LOCK_FAILURE_RE

See Also:

Constant Field Values

RELEASE_FAILURE_RE

protected static final java.lang.String RELEASE_FAILURE_RE

See Also:

Constant Field Values

LOCK_APIS_ENABLED_DEFAULT

protected static final boolean LOCK_APIS_ENABLED_DEFAULT

Configuration Key Defaults

See Also:

Constant Field Values

LOCK_TIMEOUT_MS_DEFAULT

protected static final int LOCK_TIMEOUT_MS_DEFAULT

See Also:

Constant Field Values

LOCK_SLEEP_MS_DEFAULT

protected static final int LOCK_SLEEP_MS_DEFAULT

See Also:

Constant Field Values

LOCK_FAILURE_RE_DEFAULT

protected static final java.lang.String LOCK_FAILURE_RE_DEFAULT

See Also:

Constant Field Values

RELEASE_FAILURE_RE_DEFAULT

protected static final java.lang.String RELEASE_FAILURE_RE_DEFAULT

See Also:

Constant Field Values

log

protected static org.apache.commons.logging.Log log

the log

mutex

protected static java.lang.String mutex

Mutex for the Manager

lockingEnabled

protected static boolean lockingEnabled

Is locking enabled?

sleepTimeMS

protected static int sleepTimeMS

Sleep time in MS

timeoutMS

protected static int timeoutMS

Timeout in MS

lockFailureRE

protected static java.lang.String lockFailureRE

Lock Failure RE

releaseFailureRE

protected static java.lang.String releaseFailureRE

Release Failure RE

initialised

protected static boolean initialised

Initialised?

Constructor Detail

KKDBLockMgrEE

public KKDBLockMgrEE(KKEngIf eng)
              throws java.lang.Exception

Constructor

Parameters:

eng - An object that implements KKEngIf

Throws:

java.lang.Exception - an unexpected exception

Method Detail

acquire

public boolean acquire(java.lang.String lockName)
                throws com.konakart.app.KKException

Description copied from interface: KKLockMgrIf

Acquire a lock.

Guarantees to return a lock for the specified object (if locking is enabled).

It will sleep and retry until the timeout at which point it will remove any existing lock and acquire it for the current thread.

If locking is disabled this will return false without doing anything. The enabled/disabled state is set by the konakart.lockAPIs.enabled property in konakart.properties.

The sleep quantity is defined by the konakart.lockAPIs.sleepMS property in konakart.properties.

The timeout quantity is defined by the konakart.lockAPIs.timeoutMS property in konakart.properties.

Specified by:

acquire in interface KKLockMgrIf

Parameters:

lockName - the name of the object to acquire the lock for. Use any String less than 32 characters in length.

Returns:

true if a lock was acquired otherwise false

Throws:

com.konakart.app.KKException - an unexpected KKException exception

acquire

public boolean acquire(java.lang.String lockName,
                       int sleepMS,
                       int _timeoutMS)
                throws com.konakart.app.KKException

Description copied from interface: KKLockMgrIf

Acquire a lock.

Guarantees to return a lock for the specified object (if locking is enabled).

It will sleep and retry until the timeout at which point it will remove any existing lock and acquire it for the current thread.

If locking is disabled this will return false without doing anything. The enabled/disabled state is set by the konakart.lockAPIs.enabled property in konakart.properties.

Specified by:

acquire in interface KKLockMgrIf

Parameters:

lockName - the name of the object to acquire the lock for. Use any String less than 32 characters in length.

sleepMS - number of milliseconds to sleep between attempts to acquire the lock

_timeoutMS - number of milliseconds to wait before forcibly acquiring the lock

Returns:

true if a lock was acquired otherwise false

Throws:

com.konakart.app.KKException - an unexpected KKException exception

acquireLockSQL

protected boolean acquireLockSQL(java.lang.String lockname,
                                 java.sql.Date now)
                          throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

release

public void release(java.lang.String lockName)
             throws com.konakart.app.KKException

Description copied from interface: KKLockMgrIf

Release a lock for the specified object.

Specified by:

release in interface KKLockMgrIf

Parameters:

lockName - the name of the object to release the lock on

Throws:

com.konakart.app.KKException - an unexpected KKException exception

releaseLockSQL

protected boolean releaseLockSQL(java.lang.String lockName)
                          throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

initialise

protected void initialise()
                   throws com.konakart.app.KKException

Throws:

com.konakart.app.KKException

refreshConfigs

public void refreshConfigs()
                    throws com.konakart.app.KKException

Description copied from interface: KKLockMgrIf

Refresh the configuration of the manager

Specified by:

refreshConfigs in interface KKLockMgrIf

Throws:

com.konakart.app.KKException - an unexpected KKException exception

isLockingEnabled

public static boolean isLockingEnabled()

Returns:

the lockingEnabled

setLockingEnabled

public static void setLockingEnabled(boolean lockingEnabled)

Parameters:

lockingEnabled - the lockingEnabled to set

getSleepTimeMS

public static int getSleepTimeMS()

Returns:

the sleepTimeMS

setSleepTimeMS

public static void setSleepTimeMS(int sleepTimeMS)

Parameters:

sleepTimeMS - the sleepTimeMS to set

getTimeoutMS

public static int getTimeoutMS()

Returns:

the timeoutMS

setTimeoutMS

public static void setTimeoutMS(int timeoutMS)

Parameters:

timeoutMS - the timeoutMS to set

isInitialised

public static boolean isInitialised()

Returns:

the initialised

setInitialised

public static void setInitialised(boolean initialised)

Parameters:

initialised - the initialised to set

getLockFailureRE

public static java.lang.String getLockFailureRE()

Returns:

the lockFailureRE

setLockFailureRE

public static void setLockFailureRE(java.lang.String lockFailureRE)

Parameters:

lockFailureRE - the lockFailureRE to set

getReleaseFailureRE

public static java.lang.String getReleaseFailureRE()

Returns:

the releaseFailureRE

setReleaseFailureRE

public static void setReleaseFailureRE(java.lang.String releaseFailureRE)

Parameters:

releaseFailureRE - the releaseFailureRE to set