li.strolch.agent.impl

Class DefaultLockHandler

java.lang.Object

li.strolch.agent.impl.DefaultLockHandler

All Implemented Interfaces:

LockHandler

public class DefaultLockHandler
extends Object
implements LockHandler

Author:

Robert von Burg

Constructor Summary

Constructors

Constructor and Description
DefaultLockHandler(String realm, TimeUnit tryLockTimeUnit, long tryLockTime)

Method Summary

Modifier and Type	Method and Description
String	getRealm()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultLockHandler

public DefaultLockHandler(String realm,
                          TimeUnit tryLockTimeUnit,
                          long tryLockTime)

Method Detail

getRealm

public String getRealm()

lock

public void lock(StrolchRootElement element)
          throws StrolchLockException

Description copied from interface: LockHandler

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

Specified by:

lock in interface LockHandler

Parameters:

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

Throws:

StrolchLockException

unlock

public void unlock(StrolchRootElement element)
            throws StrolchLockException

Description copied from interface: LockHandler

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 LockHandler.releaseLock(StrolchRootElement)

Specified by:

unlock in interface LockHandler

Parameters:

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

Throws:

StrolchLockException

releaseLock

public void releaseLock(StrolchRootElement element)
                 throws StrolchLockException

Description copied from interface: LockHandler

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

Specified by:

releaseLock in interface LockHandler

Parameters:

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

Throws:

StrolchLockException