ehcache-core 2.10.9.2 · net.sf.ehcache.transaction.SoftLock

Method Summary

Modifier and Type	Method and Description
public void	clearTryLock() Clear the state of the soft lock after a tryLock() call succeeded.
public void	freeze() Freeze the soft lock.
public Element	Returns: the Element visible to the current transaction getElement(TransactionID the current transaction under which this call is executed currentTransactionId, SoftLockID the soft lock ID softLockId) Get the element the current transaction is supposed to see.
public Object	Returns: the key getKey() Get the key of the element this soft lock is guarding
public boolean	Returns: true if the soft lock is orphan and should be cleaned up, false otherwise isExpired() Check if the soft lock expired, ie: that the thread which locked it died
public void	lock() Lock the soft lock
public boolean	Returns: true if the soft lock was locked, false otherwise tryLock(long the time in milliseconds before this method gives up ms) Attempt to lock the soft lock
public void	unfreeze() Unfreeze the soft lock
public void	unlock() Unlock the soft lock.

clearTryLock	back to summary
public void clearTryLock() Clear the state of the soft lock after a tryLock() call succeeded.

freeze	back to summary
public void freeze() Freeze the soft lock. A soft lock should only be frozen for a very short period of time as this blocks the `getElement(TransactionID, SoftLockID)` method calls. Freeze is used to mark the start of a commit / rollback phase

getElement	back to summary
public Element getElement(TransactionID currentTransactionId, SoftLockID softLockId) Get the element the current transaction is supposed to see. Parameters currentTransactionId:TransactionID the current transaction under which this call is executed softLockId:SoftLockID the soft lock ID Returns:Element the Element visible to the current transaction

getElement

public Element getElement(TransactionID currentTransactionId, SoftLockID softLockId)

Get the element the current transaction is supposed to see.

Parameters

currentTransactionId:TransactionID: the current transaction under which this call is executed
softLockId:SoftLockID: the soft lock ID

Returns:Element

the Element visible to the current transaction

getKey	back to summary
public Object getKey() Get the key of the element this soft lock is guarding Returns:Object the key

getKey

public Object getKey()

Get the key of the element this soft lock is guarding

isExpired	back to summary
public boolean isExpired() Check if the soft lock expired, ie: that the thread which locked it died Returns:boolean true if the soft lock is orphan and should be cleaned up, false otherwise

isExpired

public boolean isExpired()

Check if the soft lock expired, ie: that the thread which locked it died

Returns:boolean: true if the soft lock is orphan and should be cleaned up, false otherwise

lock	back to summary
public void lock() Lock the soft lock

tryLock	back to summary
public boolean tryLock(long ms) throws InterruptedException Attempt to lock the soft lock Parameters ms:long the time in milliseconds before this method gives up Returns:boolean true if the soft lock was locked, false otherwise Exceptions InterruptedException: if the thread calling this method was interrupted

tryLock

public boolean tryLock(long ms) throws InterruptedException

Attempt to lock the soft lock

Parameters

Returns:boolean

true if the soft lock was locked, false otherwise

Exceptions

unfreeze	back to summary
public void unfreeze() Unfreeze the soft lock

unlock	back to summary
public void unlock() Unlock the soft lock. Once a soft lock got unlocked, it is considered 'dead': it cannot be locked again and must be cleaned up