Package com.atlassian.jira.issue.index

Class IndexLock

java.lang.Object

com.atlassian.jira.issue.index.IndexLock

public class IndexLock
extends Object

An index lock that can be acquired using a configurable time out.

Constructor Summary

Constructors

Constructor	Description
IndexLock(Lock lock)

Method Summary

Modifier and Type	Method	Description
boolean	obtain(Awaitable waitFor, int lockWaitTimeMs)	Obtains a lock by waiting for the specified time (in milliseconds).
boolean	tryLock(int lockWaitTime)	Tries to acquire this lock using a timeout of IndexingConfiguration.getIndexLockWaitTime() milliseconds.
void	unlock()	Unlocks this lock.

Methods inherited from class java.lang.Object

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

Constructor Details

IndexLock

public IndexLock(Lock lock)

Method Details

tryLock

public boolean tryLock(int lockWaitTime)

Tries to acquire this lock using a timeout of IndexingConfiguration.getIndexLockWaitTime() milliseconds.

Returns:

a boolean indicating whether the lock was acquired within the timeout

unlock

public void unlock()

Unlocks this lock.

obtain

public boolean obtain(Awaitable waitFor,
 int lockWaitTimeMs)

Obtains a lock by waiting for the specified time (in milliseconds).

Parameters:

waitFor - the awaitable to wait for

lockWaitTimeMs - the time to wait for the lock in milliseconds

Returns:

a boolean indicating whether the lock was acquired within the timeout or not