com.helger.photon.basic.security.lock

Class ObjectLockManager

java.lang.Object

com.helger.commons.scopes.AbstractSingleton

com.helger.commons.scopes.singleton.GlobalSingleton

com.helger.photon.basic.security.lock.ObjectLockManager

All Implemented Interfaces:

com.helger.commons.scopes.IScopeDestructionAware, ILockManager<String>

@ThreadSafe
public final class ObjectLockManager
extends com.helger.commons.scopes.singleton.GlobalSingleton
implements ILockManager<String>

Singleton of ILockManager.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ObjectLockManager() Deprecated.

Method Summary

Methods

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

Methods inherited from class com.helger.commons.scopes.singleton.GlobalSingleton

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

Methods inherited from class com.helger.commons.scopes.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onDestroy, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInstantiated, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectLockManager

@Deprecated
@UsedViaReflection
public ObjectLockManager()

Deprecated.

Method Detail

getInstance

@Nonnull
public static ObjectLockManager getInstance()

getInstanceIfInstantiated

@Nullable
public static ObjectLockManager getInstanceIfInstantiated()

getDefaultLockMgr

@Nonnull
public DefaultLockManager<String> getDefaultLockMgr()

getLockInfo

@Nullable
public ILockInfo getLockInfo(@Nullable
                             String sObjID)

Description copied from interface: ILockManager

Get the lock information of the given object.

Specified by:

getLockInfo in interface ILockManager<String>

Parameters:

sObjID - The object to query for lock owner.

Returns:

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

getLockUserID

@Nullable
public String getLockUserID(@Nullable
                            String sObjID)

Description copied from interface: ILockManager

Get the user ID who locked the given object.

Specified by:

getLockUserID in interface ILockManager<String>

Parameters:

sObjID - The object to query for lock owner.

Returns:

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

getLockDateTime

@Nullable
public org.joda.time.DateTime getLockDateTime(@Nullable
                                              String sObjID)

Description copied from interface: ILockManager

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

Specified by:

getLockDateTime in interface ILockManager<String>

Parameters:

sObjID - The object to query for lock owner.

Returns:

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

lockObject

@Nonnull
public ELocked lockObject(@Nonnull
                         String sObjID)

Description copied from interface: ILockManager

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.

Specified by:

lockObject in interface ILockManager<String>

Parameters:

sObjID - 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
public ELocked lockObject(@Nonnull
                         String sObjID,
                         @Nullable
                         String sUserID)

Description copied from interface: ILockManager

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.

Specified by:

lockObject in interface ILockManager<String>

Parameters:

sObjID - 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
public LockResult<String> lockObjectAndUnlockAllOthers(@Nonnull
                                                      String sObjID)

Description copied from interface: ILockManager

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.

Specified by:

lockObjectAndUnlockAllOthers in interface ILockManager<String>

Parameters:

sObjID - 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
public LockResult<String> lockObjectAndUnlockAllOthers(@Nonnull
                                                      String sObjID,
                                                      @Nullable
                                                      String sUserID)

Description copied from interface: ILockManager

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.

Specified by:

lockObjectAndUnlockAllOthers in interface ILockManager<String>

Parameters:

sObjID - 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
public com.helger.commons.state.EChange unlockObject(@Nonnull
                                                    String sObjID)

Description copied from interface: ILockManager

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

Specified by:

unlockObject in interface ILockManager<String>

Parameters:

sObjID - 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
public com.helger.commons.state.EChange unlockObject(@Nonnull
                                                    String sUserID,
                                                    @Nonnull
                                                    String sObjID)

Description copied from interface: ILockManager

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

Specified by:

unlockObject in interface ILockManager<String>

Parameters:

sUserID - The user who locked the object.

sObjID - The object to be unlocked.

Returns:

true if unlocking succeeded, false otherwise.

unlockAllObjectsOfCurrentUser

@Nonnull
@ReturnsMutableCopy
public List<String> unlockAllObjectsOfCurrentUser()

Description copied from interface: ILockManager

Unlock all objects of the current user.

Specified by:

unlockAllObjectsOfCurrentUser in interface ILockManager<String>

Returns:

The list of all unlocked object IDs. Never null.

unlockAllObjectsOfCurrentUserExcept

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

Description copied from interface: ILockManager

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

Specified by:

unlockAllObjectsOfCurrentUserExcept in interface ILockManager<String>

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
public List<String> unlockAllObjectsOfUser(@Nullable
                                                             String sUserID)

Description copied from interface: ILockManager

Unlock all objects of the passed user.

Specified by:

unlockAllObjectsOfUser in interface ILockManager<String>

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
public List<String> unlockAllObjectsOfUserExcept(@Nullable
                                                                   String sUserID,
                                                                   @Nullable
                                                                   Set<String> aObjectsToKeepLocked)

Description copied from interface: ILockManager

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

Specified by:

unlockAllObjectsOfUserExcept in interface ILockManager<String>

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

public boolean isObjectLockedByCurrentUser(@Nullable
                                  String sObjID)

Description copied from interface: ILockManager

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

Specified by:

isObjectLockedByCurrentUser in interface ILockManager<String>

Parameters:

sObjID - 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

public boolean isObjectLockedByOtherUser(@Nullable
                                String sObjID)

Description copied from interface: ILockManager

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

Specified by:

isObjectLockedByOtherUser in interface ILockManager<String>

Parameters:

sObjID - 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

public boolean isObjectLockedByAnyUser(@Nullable
                              String sObjID)

Description copied from interface: ILockManager

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

Specified by:

isObjectLockedByAnyUser in interface ILockManager<String>

Parameters:

sObjID - 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
public Set<String> getAllLockedObjects()

Specified by:

getAllLockedObjects in interface ILockManager<String>

Returns:

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

getAllLockInfos

@Nonnull
@ReturnsMutableCopy
public Map<String,ILockInfo> getAllLockInfos()

Specified by:

getAllLockInfos in interface ILockManager<String>

Returns:

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

getAllLockedObjectsOfCurrentUser

@Nonnull
@ReturnsMutableCopy
public Set<String> getAllLockedObjectsOfCurrentUser()

Specified by:

getAllLockedObjectsOfCurrentUser in interface ILockManager<String>

Returns:

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

getAllLockedObjectsOfUser

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

Specified by:

getAllLockedObjectsOfUser in interface ILockManager<String>

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.

toString

public String toString()

Overrides:

toString in class com.helger.commons.scopes.AbstractSingleton