de.innovationgate.webgate.api.locking

Class LockManager

java.lang.Object

de.innovationgate.webgate.api.locking.LockManager

public class LockManager
extends java.lang.Object

used by WGDatabase to manage locks each WGDatabase has its own LockManager

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_LOCK_WAIT_TIMEOUT Default time an owner waits for obtaining an lock

Constructor Summary

Constructors

Constructor and Description
LockManager()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	foreignChildLocksExists(Lockable lockable, LockOwner owner) checks if foreign locks exists on decendant objects of the given lockable
int	getLockStatus(Lockable lockable, LockOwner owner) returns the lockstatus of the given lockable for the given owner if the given lockable is not locked, the lockstatus is retrieved hierarchically by the parent-lockable
void	obtainLock(Lockable lockable, LockOwner owner) obtains a lock on the given lockable for the given owner
void	releaseAllLocks(LockOwner owner) releases all locks obtained from the given owner
void	releaseLock(Lockable lockable, LockOwner owner) releases the lock obtained on the given lockable by the given owner

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOCK_WAIT_TIMEOUT

public static final long DEFAULT_LOCK_WAIT_TIMEOUT

Default time an owner waits for obtaining an lock

See Also:

Constant Field Values

Constructor Detail

LockManager

public LockManager()

Method Detail

getLockStatus

public int getLockStatus(Lockable lockable,
                LockOwner owner)
                  throws WGAPIException

returns the lockstatus of the given lockable for the given owner if the given lockable is not locked, the lockstatus is retrieved hierarchically by the parent-lockable

Parameters:

lockable -

owner -

Returns:

Lock.NOT_LOCKED, Lock.LOCKED_BY_FOREIGN_OBJECT, Lock.LOCKED_BY_THIS_OBJECT

Throws:

WGAPIException

obtainLock

public void obtainLock(Lockable lockable,
              LockOwner owner)
                throws WGAPIException

obtains a lock on the given lockable for the given owner

Parameters:

lockable -

owner -

Throws:

WGAPIException

releaseLock

public void releaseLock(Lockable lockable,
               LockOwner owner)

releases the lock obtained on the given lockable by the given owner

Parameters:

lockable -

owner -

releaseAllLocks

public void releaseAllLocks(LockOwner owner)

releases all locks obtained from the given owner

Parameters:

owner -

foreignChildLocksExists

public boolean foreignChildLocksExists(Lockable lockable,
                              LockOwner owner)
                                throws WGAPIException

checks if foreign locks exists on decendant objects of the given lockable

Parameters:

lockable -

owner -

Returns:

true/ false

Throws:

WGAPIException