org.adroitlogic.x.feature.lock.impl

Class LockFeatureImpl

java.lang.Object

org.adroitlogic.x.api.AbstractIntegrationFeature

org.adroitlogic.x.feature.lock.impl.LockFeatureImpl

All Implemented Interfaces:

org.adroitlogic.x.api.dec.Initializable, LockFeature

@IntegrationFeature(clazz=LockFeature.class,
                    name="lock")
public class LockFeatureImpl
extends org.adroitlogic.x.api.AbstractIntegrationFeature
implements LockFeature

This feature will facilitate the locking and sequence numbers for a given key. This will use the ClusterFeature to get both locks and sequence numbers if the clustering is enabled. If clustering is disabled this will get both functionalities via the SingleInstanceLockManager

Since:

17.01

Author:

dammina, Manjula Piyumal

Constructor Summary

Constructors

Constructor and Description
LockFeatureImpl()

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	getNextSequenceNumber(String key) Generate the next sequence number for the given keyPath
void	releaseLock(String lockKey) Release the acquired Semaphore based lock for the given lockPath
void	releaseReentrantLock(String lockKey) Release the acquired ReentrantLock lock for the given lockPath
boolean	tryLock(String lockKey) Attempts to get a Semaphore based lock for the given lockPath.
boolean	tryReentrantLock(String lockKey) Attempts to get a ReentrantLock lock for the given lockPath which won't be useful only for acquire and release using the same thread.

Methods inherited from class org.adroitlogic.x.api.AbstractIntegrationFeature

destroy, init, setProjectConfig, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

LockFeatureImpl

public LockFeatureImpl()

Method Detail

getNextSequenceNumber

public Optional<Integer> getNextSequenceNumber(String key)

Description copied from interface: LockFeature

Generate the next sequence number for the given keyPath

Specified by:

getNextSequenceNumber in interface LockFeature

Parameters:

key - the key to associate the sequence number

Returns:

the next generated sequence number for the given keyPath

tryLock

public boolean tryLock(String lockKey)

Description copied from interface: LockFeature

Attempts to get a Semaphore based lock for the given lockPath. In this method, it's not required to acquire and release the lock using the same thread

Specified by:

tryLock in interface LockFeature

Parameters:

lockKey - the key to get the ReentrantLock

Returns:

true if it's able to get acquire the lock for the given path, otherwise returns false

releaseLock

public void releaseLock(String lockKey)

Description copied from interface: LockFeature

Release the acquired Semaphore based lock for the given lockPath

Specified by:

releaseLock in interface LockFeature

Parameters:

lockKey - the key to find the lock which should be acquired before

tryReentrantLock

public boolean tryReentrantLock(String lockKey)

Description copied from interface: LockFeature

Attempts to get a ReentrantLock lock for the given lockPath which won't be useful only for acquire and release using the same thread. If it's going to acquire the lock from one thread and release from anther thread, then this API won't help to facilitate the required synchronization. For those type of scenarios instead of this, use the tryLock() API

Specified by:

tryReentrantLock in interface LockFeature

Parameters:

lockKey - the key to get the ReentrantLock

Returns:

true if it's able to get acquire the lock for the given path, otherwise returns false

releaseReentrantLock

public void releaseReentrantLock(String lockKey)

Description copied from interface: LockFeature

Release the acquired ReentrantLock lock for the given lockPath

Specified by:

releaseReentrantLock in interface LockFeature

Parameters:

lockKey - the key to find the lock which should be acquired before