lumis.portal.lock
Interface ILockManager

All Known Implementing Classes:

LockManager

@StableMinor(version="5.5",
             sinceVersion="4.2")
public interface ILockManager

Manager interface for lock-related operations.

Since:

4.2.0

See Also:

lumis.portal.lock

Method Summary

Lock	getLock(String resourceId) Returns a cluster-wide lock object for the specified resource.
void	unlockExpiredLocks() Deletes all the locks that have expired.

Method Detail

getLock

Lock getLock(String resourceId)

Returns a cluster-wide lock object for the specified resource.

See lumis.portal.lock for details about the consequences of the lock scope being cluster-wide.

The lock implementation returned does not support conditions. The Lock.newCondition() method throws UnsupportedOperationException.

If this method is called multiple times with the same resourceId value, the lock objects returned use a common synchronizing resource. This way, calling Lock.lock() on any of these lock objects will generate a lock in the same resource (and these locks will block each other). But a Lock.unlock() must still be executed in the same Lock instance on which the lock was acquired, since it is considered the owner of that lock.

Parameters:

resourceId - the identifier of the resource the lock refers to. It is recommended to name the identifier using Java class name style (e.g. com.company.module.etc.MyResource) to prevent naming conflicts on different implementations.

Returns:

the lock object.

Since:

4.2.0

See Also:

lumis.portal.lock

unlockExpiredLocks

void unlockExpiredLocks()
                        throws PortalException

Deletes all the locks that have expired.

Throws:

PortalException

Since:

4.2.0