lumis.portal.lock
Interface ILockManager

All Known Implementing Classes:

LockManager

@StableMinor(version="4.1",
             sinceVersion="4.0")
public interface ILockManager

Manager interface for lock-related operations

Since:

4.0.9

Method Summary

void	addLockType(SessionConfig sessionConfig, LockTypeConfig lockTypeConfig, ITransaction transaction) Add a type of lock.
void	addOrUpdateLockType(SessionConfig sessionConfig, LockTypeConfig lockTypeConfig, ITransaction transaction) Adds or updates a lockType entry
void	deleteLockType(SessionConfig sessionConfig, String lockTypeId, boolean force, ITransaction transaction) Remove a type of lock.
Collection<String>	getLockTypeIdsByServiceId(SessionConfig sessionConfig, String serviceId, ITransaction transaction) Returns the ids of the types of locks given the serviceId.
String	lock(SessionConfig sessionConfig, LockConfig lockConfig) Set lock on.
boolean	unlock(SessionConfig sessionConfig, String lockId) Set lock off.
void	unlockExpiredLocks(SessionConfig sessionConfig) Delete all the locks that have expired.
void	updateLockType(SessionConfig sessionConfig, LockTypeConfig lockTypeConfig, ITransaction transaction) Updates a lockType entry

Method Detail

addLockType

void addLockType(SessionConfig sessionConfig,
                 LockTypeConfig lockTypeConfig,
                 ITransaction transaction)
                 throws ManagerException,
                        PortalException

Add a type of lock.

Parameters:

sessionConfig -

lockTypeConfig -

transaction -

Throws:

ManagerException

PortalException

deleteLockType

void deleteLockType(SessionConfig sessionConfig,
                    String lockTypeId,
                    boolean force,
                    ITransaction transaction)
                    throws ManagerException,
                           PortalException

Remove a type of lock.

Parameters:

sessionConfig -

lockTypeId -

force -

transaction -

Throws:

ManagerException

PortalException

getLockTypeIdsByServiceId

Collection<String> getLockTypeIdsByServiceId(SessionConfig sessionConfig,
                                             String serviceId,
                                             ITransaction transaction)
                                             throws ManagerException,
                                                    PortalException

Returns the ids of the types of locks given the serviceId.

Parameters:

sessionConfig -

serviceId -

transaction -

Returns:

an array of Strings.

Throws:

ManagerException

PortalException

lock

String lock(SessionConfig sessionConfig,
            LockConfig lockConfig)
            throws ManagerException,
                   PortalException

Set lock on.

Parameters:

sessionConfig -

lockConfig -

Returns:

a String.

Throws:

ManagerException

PortalException

unlock

boolean unlock(SessionConfig sessionConfig,
               String lockId)
               throws ManagerException,
                      PortalException

Set lock off.

Parameters:

sessionConfig -

lockId -

Returns:

true, if the lock was released; false, if the lock was previously released

Throws:

ManagerException

PortalException

addOrUpdateLockType

void addOrUpdateLockType(SessionConfig sessionConfig,
                         LockTypeConfig lockTypeConfig,
                         ITransaction transaction)
                         throws ManagerException,
                                PortalException

Adds or updates a lockType entry

Parameters:

sessionConfig -

lockTypeConfig -

transaction -

Throws:

ManagerException

PortalException

updateLockType

void updateLockType(SessionConfig sessionConfig,
                    LockTypeConfig lockTypeConfig,
                    ITransaction transaction)
                    throws ManagerException,
                           PortalException

Updates a lockType entry

Parameters:

sessionConfig -

lockTypeConfig -

transaction -

Throws:

ManagerException

PortalException

unlockExpiredLocks

void unlockExpiredLocks(SessionConfig sessionConfig)
                        throws ManagerException,
                               PortalException

Delete all the locks that have expired.

Parameters:

sessionConfig -

Throws:

ManagerException

PortalException