EhcacheKeyLock (Gemma 1.32.0-SNAPSHOT API)

java.lang.Object
- ubic.gemma.persistence.cache.EhcacheKeyLock

All Implemented Interfaces:: CacheKeyLock

public class EhcacheKeyLock
extends Object
implements CacheKeyLock

Author:: poirigui

Nested Class Summary
- Nested classes/interfaces inherited from interface ubic.gemma.persistence.cache.CacheKeyLock
  CacheKeyLock.LockAcquisition

Constructor Summary

Constructors
Constructor Description

EhcacheKeyLock(net.sf.ehcache.Ehcache cache, Object key, boolean readOnly)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isReadOnly()`	Indicate if this lock is read-only.
`CacheKeyLock.LockAcquisition`	`lock()`	Acquire a lock on the cache key.
`CacheKeyLock.LockAcquisition`	`lockInterruptibly()`	Acquire a lock interruptibly on a cache key.
`void`	`setLockCheckIntervalMillis(long lockCheckIntervalMillis)`	Set the interval to check for lock acquisition in milliseconds when `lockInterruptibly()` is used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EhcacheKeyLock
```
public EhcacheKeyLock(net.sf.ehcache.Ehcache cache,
                      Object key,
                      boolean readOnly)
```
- Method Detail
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: CacheKeyLock
    
    Indicate if this lock is read-only.
    
    Specified by:
    
    isReadOnly in interface CacheKeyLock
  - setLockCheckIntervalMillis
```
public void setLockCheckIntervalMillis(long lockCheckIntervalMillis)
```
    Set the interval to check for lock acquisition in milliseconds when lockInterruptibly() is used.
    This defaults to 30000 ms.
  - lock
```
public CacheKeyLock.LockAcquisition lock()
```
    Description copied from interface: CacheKeyLock
    
    Acquire a lock on the cache key.
    
    Specified by:
    
    lock in interface CacheKeyLock
  - lockInterruptibly
```
public CacheKeyLock.LockAcquisition lockInterruptibly()
                                               throws InterruptedException
```
    Description copied from interface: CacheKeyLock
    
    Acquire a lock interruptibly on a cache key.
    
    Specified by:
    
    lockInterruptibly in interface CacheKeyLock
    
    Throws:
    
    InterruptedException - if the current thread was interrupted prior to or while waiting on the lock