Package lumis.portal.lock

Class LockManager

  • All Implemented Interfaces:
    ILockManager, ILockManagerSPI
    public class LockManager
extends Object
implements ILockManagerSPI
    Manager implementation for lock-related operations
    Since:
    4.2.0
    Version:
    $Revision: 24618 $ $Date: 2021-07-28 14:43:22 -0300 (Wed, 28 Jul 2021) $

    • Constructor Detail

      • LockManager

        public LockManager()

    • Method Detail

      • getLock

        @Deprecated
public Lock getLock​(String resourceId)
        Deprecated.
        Description copied from interface: ILockManager
        Returns a cluster-wide exclusive 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.

        Specified by:
        getLock in interface ILockManager
        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.
        See Also:
        lumis.portal.lock

      • getReadLock

        public Lock getReadLock​(String resourceId)
        Description copied from interface: ILockManager
        Returns a non-exclusive read 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.

        This kind of lock requires that there's no write lock holding the lock of the same resource. In the other hand, multiple read locks may be holding the lock for the same resource at the same time.

        This lock is indicated when some resource must be read but it will not be changed. This way, multiple processes that must read the same resource will not block each other.

        Specified by:
        getReadLock in interface ILockManager
        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.
        See Also:
        lumis.portal.lock

      • getWriteLock

        public Lock getWriteLock​(String resourceId)
        Description copied from interface: ILockManager
        Returns an exclusive write 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.

        This kind of lock requires that there's no other lock holding the lock of the same resource. Once this lock has been locked, no other lock will be able to access the specified resource until this lock has been unlocked.

        This lock is indicated when some resource must be changed. This way, the owner of this lock can change the resource exclusively, avoiding other processes to read or change the specified resource erroneously.

        Specified by:
        getWriteLock in interface ILockManager
        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.
        See Also:
        lumis.portal.lock

      • forceUnlock

        public void forceUnlock​(String resourceId)
                 throws PortalException
        Forces the unlock of the specified lock resource, independently of the current owner.
        Parameters:
        resourceId - the lock resource identifier.
        Throws:
        PortalException
        Since:
        5.6.0

      • forceSingleUnlock

        public void forceSingleUnlock​(String id)
                       throws PortalException
        Force the unlock of a single lock with the specified identifier (database id).
        Parameters:
        id - the lock identifier.
        Throws:
        PortalException
        Since:
        8.0.0