com.helger.photon.basic.security.lock

Interface ILockManager<IDTYPE>

Type Parameters:

IDTYPE - The type of object to be locked. E.g. String or TypedObject. Must implement equals and hashCode!

All Known Implementing Classes:

DefaultLockManager, ObjectLockManager

public interface ILockManager<IDTYPE>

Base interface for a manager that handles object locking. See DefaultLockManager for a per-instance implementation and ObjectLockManager for a singleton version.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
Set<IDTYPE>	getAllLockedObjects()
Set<IDTYPE>	getAllLockedObjectsOfCurrentUser()
Set<IDTYPE>	getAllLockedObjectsOfUser(String sUserID)
Map<IDTYPE,ILockInfo>	getAllLockInfos()
org.joda.time.DateTime	getLockDateTime(IDTYPE aObjID) Get the date and time when the given object was locked.
ILockInfo	getLockInfo(IDTYPE aObjID) Get the lock information of the given object.
String	getLockUserID(IDTYPE aObjID) Get the user ID who locked the given object.
boolean	isObjectLockedByAnyUser(IDTYPE aObjID) Check if the object with the given ID is locked by any user.
boolean	isObjectLockedByCurrentUser(IDTYPE aObjID) Check if the object with the given ID is locked by the current user.
boolean	isObjectLockedByOtherUser(IDTYPE aObjID) Check if the object with the given ID is locked by any but the current user.
ELocked	lockObject(IDTYPE aObjID) Lock the object with the given ID.
ELocked	lockObject(IDTYPE aObjID, String sUserID) Lock the object with the given ID.
LockResult<IDTYPE>	lockObjectAndUnlockAllOthers(IDTYPE aObjID) Lock the object with the given ID and unlock all other objects.
LockResult<IDTYPE>	lockObjectAndUnlockAllOthers(IDTYPE aObjID, String sUserID) Lock the object with the given ID and unlock all other objects.
List<IDTYPE>	unlockAllObjectsOfCurrentUser() Unlock all objects of the current user.
List<IDTYPE>	unlockAllObjectsOfCurrentUserExcept(Set<IDTYPE> aObjectsToKeepLocked) Unlock all objects of the current user except for the passed objects.
List<IDTYPE>	unlockAllObjectsOfUser(String sUserID) Unlock all objects of the passed user.
List<IDTYPE>	unlockAllObjectsOfUserExcept(String sUserID, Set<IDTYPE> aObjectsToKeepLocked) Unlock all objects of the passed user except for the passed objects.
com.helger.commons.state.EChange	unlockObject(IDTYPE aObjID) Unlock the object with the given ID.
com.helger.commons.state.EChange	unlockObject(String sUserID, IDTYPE aObjID) Manually unlock a special object locked by a special user.

Method Detail

getLockInfo

@Nullable
ILockInfo getLockInfo(@Nullable
                             IDTYPE aObjID)

Get the lock information of the given object.

Parameters:

aObjID - The object to query for lock owner.

Returns:

null if the object is not locked, the lock information otherwise

getLockUserID

@Nullable
String getLockUserID(@Nullable
                            IDTYPE aObjID)

Get the user ID who locked the given object.

Parameters:

aObjID - The object to query for lock owner.

Returns:

null if the object is not locked, the user ID otherwise

getLockDateTime

@Nullable
org.joda.time.DateTime getLockDateTime(@Nullable
                                              IDTYPE aObjID)

Get the date and time when the given object was locked.

Parameters:

aObjID - The object to query for lock owner.

Returns:

null if the object is not locked, the locking date time otherwise

lockObject

@Nonnull
ELocked lockObject(@Nonnull
                         IDTYPE aObjID)

Lock the object with the given ID. If the passed object is already locked by this user, this method has no effect. This is an atomic action.

Parameters:

aObjID - The object ID to lock. May not be null.

Returns:

ELocked.LOCKED if the object is locked by the current user after the call to this method, ELocked.NOT_LOCKED if the object was already locked by another user.

lockObject

@Nonnull
ELocked lockObject(@Nonnull
                         IDTYPE aObjID,
                         @Nullable
                         String sUserID)

Lock the object with the given ID. If the passed object is already locked by this user, this method has no effect. This is an atomic action.

Parameters:

aObjID - The object ID to lock. May not be null.

sUserID - The id of the user who locked the object. May be null.

Returns:

ELocked.LOCKED if the object is locked by the specified user after the call to this method, ELocked.NOT_LOCKED if the object was already locked by another user or no user ID was provided.

lockObjectAndUnlockAllOthers

@Nonnull
LockResult<IDTYPE> lockObjectAndUnlockAllOthers(@Nonnull
                                                      IDTYPE aObjID)

Lock the object with the given ID and unlock all other objects. If the passed object is already locked by this user, this method has no effect. This is an atomic action.

Parameters:

aObjID - The object ID to lock. May not be null.

Returns:

The locking result and never null. If ILockedIndicator.isLocked() is true, the object is locked by the current user after the call to this method. If ILockedIndicator.isNotLocked() is true the object was already locked by another user.

lockObjectAndUnlockAllOthers

@Nonnull
LockResult<IDTYPE> lockObjectAndUnlockAllOthers(@Nonnull
                                                      IDTYPE aObjID,
                                                      @Nullable
                                                      String sUserID)

Lock the object with the given ID and unlock all other objects. If the passed object is already locked by this user, this method has no effect. This is an atomic action.

Parameters:

aObjID - The object ID to lock. May not be null.

sUserID - The id of the user who locked the object. May be null.

Returns:

ELocked.LOCKED if the object is locked by the specified user after the call to this method, ELocked.NOT_LOCKED if the object was already locked by another user or no user ID was provided.

unlockObject

@Nonnull
com.helger.commons.state.EChange unlockObject(@Nonnull
                                                    IDTYPE aObjID)

Unlock the object with the given ID. Unlocking is only possible, if the current session user locked the object.

Parameters:

aObjID - The object ID to unlock.

Returns:

true if the object was successfully unlocked, false if either the object is not locked or the object is locked by another user than the current session user.

unlockObject

@Nonnull
com.helger.commons.state.EChange unlockObject(@Nonnull
                                                    String sUserID,
                                                    @Nonnull
                                                    IDTYPE aObjID)

Manually unlock a special object locked by a special user. This manual version is only required for especially unlocking a user!

Parameters:

sUserID - The user who locked the object.

aObjID - The object to be unlocked.

Returns:

true if unlocking succeeded, false otherwise.

unlockAllObjectsOfCurrentUser

@Nonnull
@ReturnsMutableCopy
List<IDTYPE> unlockAllObjectsOfCurrentUser()

Unlock all objects of the current user.

Returns:

The list of all unlocked object IDs. Never null.

unlockAllObjectsOfCurrentUserExcept

@Nonnull
@ReturnsMutableCopy
List<IDTYPE> unlockAllObjectsOfCurrentUserExcept(@Nullable
                                                                          Set<IDTYPE> aObjectsToKeepLocked)

Unlock all objects of the current user except for the passed objects.

Parameters:

aObjectsToKeepLocked - An optional set of objects which should not be unlocked. May be null or empty.

Returns:

The list of all unlocked object IDs. Never null.

unlockAllObjectsOfUser

@Nonnull
@ReturnsMutableCopy
List<IDTYPE> unlockAllObjectsOfUser(@Nullable
                                                             String sUserID)

Unlock all objects of the passed user.

Parameters:

sUserID - The user ID who's object are to be unlocked. May be null or empty.

Returns:

The list of all unlocked object IDs. Never null.

unlockAllObjectsOfUserExcept

@Nonnull
@ReturnsMutableCopy
List<IDTYPE> unlockAllObjectsOfUserExcept(@Nullable
                                                                   String sUserID,
                                                                   @Nullable
                                                                   Set<IDTYPE> aObjectsToKeepLocked)

Unlock all objects of the passed user except for the passed objects.

Parameters:

sUserID - The user ID who's object are to be unlocked. May be null or empty.

aObjectsToKeepLocked - An optional set of objects which should not be unlocked. May be null or empty.

Returns:

The list of all unlocked object IDs. Never null.

isObjectLockedByCurrentUser

boolean isObjectLockedByCurrentUser(@Nullable
                                  IDTYPE aObjID)

Check if the object with the given ID is locked by the current user.

Parameters:

aObjID - The object ID to check.

Returns:

true if the object is locked by the current user, false if the object is either not locked or locked by another user.

isObjectLockedByOtherUser

boolean isObjectLockedByOtherUser(@Nullable
                                IDTYPE aObjID)

Check if the object with the given ID is locked by any but the current user.

Parameters:

aObjID - The object ID to check.

Returns:

true if the object is locked by any user that is not the currently logged in user, false if the object is either not locked or locked by the current user.

isObjectLockedByAnyUser

boolean isObjectLockedByAnyUser(@Nullable
                              IDTYPE aObjID)

Check if the object with the given ID is locked by any user.

Parameters:

aObjID - The object ID to check.

Returns:

true if the object is locked by any user, false if the object is not locked.

getAllLockedObjects

@Nonnull
@ReturnsMutableCopy
Set<IDTYPE> getAllLockedObjects()

Returns:

A non-null set of all locked objects of all users. Never null but maybe empty.

getAllLockInfos

@Nonnull
@ReturnsMutableCopy
Map<IDTYPE,ILockInfo> getAllLockInfos()

Returns:

A non-null map of all locked objects of all users. Never null but maybe empty.

getAllLockedObjectsOfCurrentUser

@Nonnull
@ReturnsMutableCopy
Set<IDTYPE> getAllLockedObjectsOfCurrentUser()

Returns:

A non-null set of all locked objects of the current user. Never null but maybe empty.

getAllLockedObjectsOfUser

@Nonnull
@ReturnsMutableCopy
Set<IDTYPE> getAllLockedObjectsOfUser(@Nullable
                                                               String sUserID)

Parameters:

sUserID - The user ID to be queried for all locked objects. May be null.

Returns:

A non-null set of all locked objects of the passed user. Never null but maybe empty.