com.j_spaces.kernel.locks

Interface IBasicLockManager<T extends ILockedSubject>

All Known Implementing Classes:

AllInCacheLockManager, BasicEvictableLockManager, BlobStoreLockManager

public interface IBasicLockManager<T extends ILockedSubject>

TODO add Javadoc

Since:

6.5 contains the basic methods for acuring a lock object- i.e. an object that will be locked in order to lock the entity (entry or template) represented by it

Version:

1.0

Author:

Yechiel Fefer

Method Summary

Modifier and Type	Method and Description
void	freeLockObject(ILockObject lockObject) free the lock object- no more needed by this thread
ILockObject	getLockObject(String subjectUid) based only on subject's uid, return a lock object in order to lock the represented subject this method is relevant only for evictable objects
ILockObject	getLockObject(T subject) based on subject, return a lock object in order to lock the represented subject
ILockObject	getLockObject(T subject, boolean isEvictable) based on subject, return a lock object in order to lock the subject
boolean	isPerLogicalSubjectLockObject(boolean isEvictable) do we use per-logical subject a different object for locking ?

Method Detail

getLockObject

ILockObject getLockObject(T subject)

based on subject, return a lock object in order to lock the represented subject

Returns:

the lock object

getLockObject

ILockObject getLockObject(T subject,
                          boolean isEvictable)

based on subject, return a lock object in order to lock the subject

Parameters:

isEvictable - = true if the subject is part of evictable cache (like lru)

Returns:

the lock object

getLockObject

ILockObject getLockObject(String subjectUid)

based only on subject's uid, return a lock object in order to lock the represented subject this method is relevant only for evictable objects

Returns:

the lock object

freeLockObject

void freeLockObject(ILockObject lockObject)

free the lock object- no more needed by this thread

Parameters:

lockObject - the lock object

isPerLogicalSubjectLockObject

boolean isPerLogicalSubjectLockObject(boolean isEvictable)

do we use per-logical subject a different object for locking ?

Parameters:

isEvictable - - is subject evictable

Returns:

true if we use subject