li.strolch.agent.api

Interface LockHandler

All Known Implementing Classes:

DefaultLockHandler

public interface LockHandler

In Strolch locking of objects is done by keeping a lock for every StrolchRootElement by using the Locator to find the lock. Instead of adding a lock to the model, the lock is stored by the LockHandler.

Since new StrolchRootElement might not be known by the ElementMaps but you still want to lock an object globally, then locking on the Locator solves this, as the locator is an immutable object and can easily be created before the actual object exists

See concrete implementations for which concrete locking implementation is used

Author:

Robert von Burg

See Also:

DefaultLockHandler

Method Summary

Modifier and Type	Method and Description
void	lock(StrolchRootElement element) Locks the given element by using the element's Locator and creating a lock on it.
void	releaseLock(StrolchRootElement element) Releases the lock on the given element, by unlocking all locks, i.e.
void	unlock(StrolchRootElement element) Unlocks the given element by finding the element's lock by its Locator.

Method Detail

lock

void lock(StrolchRootElement element)
   throws StrolchLockException

Locks the given element by using the element's Locator and creating a lock on it. Calling lock multiple times from the same thread will not lock, it is up to the concrete implementation to define if a lock counter is used

Parameters:

element - the element for which a Lock on its Locator is to be created and/or locked

Throws:

StrolchLockException

unlock

void unlock(StrolchRootElement element)
     throws StrolchLockException

Unlocks the given element by finding the element's lock by its Locator. It is up to the concrete implementation to define if unlocking an unlocked element will fail or not. This method might not completely unlock the element if a lock counter is used and the object was locked multiple times.

If the lock must be completely released, then use releaseLock(StrolchRootElement)

Parameters:

element - the element for which the current/last Lock is to be unlocked

Throws:

StrolchLockException

releaseLock

void releaseLock(StrolchRootElement element)
          throws StrolchLockException

Releases the lock on the given element, by unlocking all locks, i.e. after this method is called, no lock will be held anymore by the current thread

Parameters:

element - the element for which the Lock on the Locator is to be released

Throws:

StrolchLockException