com.atlassian.crowd.dao.cluster

Class ClusterLockDAOHibernate

java.lang.Object

com.atlassian.crowd.util.persistence.hibernate.StatelessDao

com.atlassian.crowd.util.persistence.hibernate.HibernateDao<ClusterLockEntity>

com.atlassian.crowd.dao.cluster.ClusterLockDAOHibernate

public class ClusterLockDAOHibernate
extends HibernateDao<ClusterLockEntity>

Hibernate DAO to store cluster locks

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUPPRESS_LOGGING_MDC_KEY

Fields inherited from class com.atlassian.crowd.util.persistence.hibernate.HibernateDao

batchFinder, batchProcessor, logger, statelessSessionBatchProcessor, timeSource

Fields inherited from class com.atlassian.crowd.util.persistence.hibernate.StatelessDao

sessionFactory

Constructor Summary

Constructors

Constructor and Description
ClusterLockDAOHibernate()

Method Summary

Modifier and Type	Method and Description
void	deleteLocksHeldByNode(String nodeId)
List<ClusterLockEntity>	getAllHeldClusterLocks()
ClusterLockEntity	getLockByName(String lockName)
Class<ClusterLockEntity>	getPersistentClass() All subclasses of HibernateDao must implement this method for HibernateDao.load(Serializable) to work correctly.
void	insertEmptyClusterLock(String lockName, long currentTime) Attempt to insert an "unlocked" DB row for the named lock.
List<ClusterLockEntity>	list()
void	renewLease(String lockName, String nodeId, long currentTime)
boolean	tryUpdateAcquireLock(String lockName, String nodeId, long currentTime, long lockExpiryTimeout) Attempt to acquire an existing named lock for the given nodeId.
void	unlock(String lockName, String nodeId, long currentTime) Unlock the named lock, if this node still holds the lock.

Methods inherited from class com.atlassian.crowd.util.persistence.hibernate.HibernateDao

createDeleteQuery, createDeleteQuery, createQuery, createQuery, executeHQLQuery, findAllInternal, findByProperties, findByPropertiesOptional, findByProperty, findByProperty, findByPropertyOptional, findByPropertyOrThrow, getCountByProperties, load, load, loadOptional, loadReference, loadReference, remove, removeByIdIfPresent, save, saveOrUpdate, session, setBatchFinder, setBatchProcessor, setClock, setStatelessSessionBatchProcessor, toPredicates, update

Methods inherited from class com.atlassian.crowd.util.persistence.hibernate.StatelessDao

setSessionFactory, withStatelessSession

Methods inherited from class java.lang.Object

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

Field Detail

SUPPRESS_LOGGING_MDC_KEY

public static final String SUPPRESS_LOGGING_MDC_KEY

See Also:

Constant Field Values

Constructor Detail

ClusterLockDAOHibernate

public ClusterLockDAOHibernate()

Method Detail

getPersistentClass

public Class<ClusterLockEntity> getPersistentClass()

Description copied from class: HibernateDao

All subclasses of HibernateDao must implement this method for HibernateDao.load(Serializable) to work correctly.

Specified by:

getPersistentClass in class HibernateDao<ClusterLockEntity>

Returns:

the entity class for this DAO

getAllHeldClusterLocks

public List<ClusterLockEntity> getAllHeldClusterLocks()

getLockByName

public ClusterLockEntity getLockByName(String lockName)

tryUpdateAcquireLock

public boolean tryUpdateAcquireLock(@Nonnull
                                    String lockName,
                                    @Nonnull
                                    String nodeId,
                                    long currentTime,
                                    long lockExpiryTimeout)

Attempt to acquire an existing named lock for the given nodeId.

Parameters:

lockName - the globally unique id of the lock

nodeId - This node's ID

currentTime - the time in milliseconds that this update was written

lockExpiryTimeout - the timeout for the lock expiry, should be sourced from com.atlassian.beehive.db.LockExpiryConfiguration#getExpiryPeriodDurationSeconds()

Returns:

true if we acquired the lock, false if the row exists but is already locked.

renewLease

public void renewLease(@Nonnull
                       String lockName,
                       @Nonnull
                       String nodeId,
                       long currentTime)

insertEmptyClusterLock

public void insertEmptyClusterLock(@Nonnull
                                   String lockName,
                                   long currentTime)

Attempt to insert an "unlocked" DB row for the named lock.

Parameters:

lockName - the lock identifier

currentTime - the time in milliseconds that this insert was written

unlock

public void unlock(String lockName,
                   String nodeId,
                   long currentTime)

Unlock the named lock, if this node still holds the lock.

Parameters:

lockName - the lock identifier

nodeId - This node's ID

currentTime - the time in milliseconds that this update was written

list

public List<ClusterLockEntity> list()

deleteLocksHeldByNode

public void deleteLocksHeldByNode(String nodeId)