bboss.org.jgroups.blocks.LockManager Maven / Gradle / Ivy
The newest version!
package bboss.org.jgroups.blocks;
import bboss.org.jgroups.ChannelException;
/**
* LockManager represents generic lock manager that allows
* obtaining and releasing locks on objects.
*
* @author Roman Rokytskyy ([email protected])
* @author Robert Schaffar-Taurok ([email protected])
* @version $Id: LockManager.java,v 1.2 2005/06/08 15:56:54 publicnmi Exp $
*/
public interface LockManager {
/**
* Obtain lock on obj for specified owner.
* Implementation should try to obtain lock few times within the
* specified timeout.
*
* @param obj obj to lock, usually not full object but object's ID.
* @param owner object identifying entity that will own the lock.
* @param timeout maximum time that we grant to obtain a lock.
*
* @throws LockNotGrantedException if lock is not granted within
* specified period.
*
* @throws ClassCastException if obj and/or
* owner is not of type that implementation expects to get
* (for example, when distributed lock manager obtains non-serializable
* obj or owner).
*
* @throws ChannelException if something bad happened to communication
* channel.
*/
void lock(Object obj, Object owner, int timeout)
throws LockNotGrantedException, ClassCastException, ChannelException;
/**
* Release lock on obj owned by specified owner.
*
* since 2.2.9 this method is only a wrapper for
* unlock(Object lockId, Object owner, boolean releaseMultiLocked).
* Use that with releaseMultiLocked set to true if you want to be able to
* release multiple locked locks (for example after a merge)
*
* @param obj obj to lock, usually not full object but object's ID.
* @param owner object identifying entity that will own the lock.
*
* @throws LockOwnerMismatchException if lock is owned by another object.
*
* @throws ClassCastException if obj and/or
* owner is not of type that implementation expects to get
* (for example, when distributed lock manager obtains non-serializable
* obj or owner).
*
* @throws ChannelException if something bad happened to communication
* channel.
*/
void unlock(Object obj, Object owner)
throws LockNotReleasedException, ClassCastException, ChannelException;
/**
* Release lock on obj owned by specified owner.
*
* @param obj obj to lock, usually not full object but object's ID.
* @param owner object identifying entity that will own the lock.
* @param releaseMultiLocked force unlocking of the lock if the local
* lockManager owns the lock even if another lockManager owns the same lock
*
* @throws LockOwnerMismatchException if lock is owned by another object.
*
* @throws ClassCastException if obj and/or
* owner is not of type that implementation expects to get
* (for example, when distributed lock manager obtains non-serializable
* obj or owner).
*
* @throws ChannelException if something bad happened to communication
* channel.
*
* @throws LockMultiLockedException if the lock was unlocked, but another
* node already held the lock
*/
void unlock(Object obj, Object owner, boolean releaseMultiLocked)
throws LockNotReleasedException, ClassCastException, ChannelException, LockMultiLockedException;
}