Package io.goobi.viewer.model.security.recordlock

Class RecordLockManager

java.lang.Object

io.goobi.viewer.model.security.recordlock.RecordLockManager

public class RecordLockManager
extends Object

Constructor Summary

Constructors

Constructor	Description
RecordLockManager()

Method Summary

Modifier and Type	Method	Description
void	emptyCacheForRecord(String pi)
Map<String,List<String>>	getRecordAccessConditionsCache()
Map<String,List<String>>	getRecordLimitsCache()
LockRecordResult	lockRecord(String pi, String sessionId, Integer limit)
boolean	removeLockForPiAndSessionId(String pi, String sessionId)
int	removeLocksForSessionId(String sessionId, List<String> skipPiList)
int	removeOldLocks(long maxAge)	Removes all record locks that are older that maxAge milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Details

RecordLockManager

public RecordLockManager()

Method Details

lockRecord

public LockRecordResult lockRecord(String pi,
 String sessionId,
 Integer limit)

Parameters:

pi - Record identifier

sessionId - HTTP session ID

limit - Optional number of concurrent views for the record

Returns:

a LockRecordResult, indicating that either a lock has been set, the lock limit was exceeded or that no action was necessary

Throws:

IllegalArgumentException - if the given pi is null

removeLocksForSessionId

public int removeLocksForSessionId(String sessionId,
 List<String> skipPiList)

Parameters:

sessionId - HTTP session ID

skipPiList - Optional list of identifiers to skip

Returns:

number of records if session id removed successfully

removeLockForPiAndSessionId

public boolean removeLockForPiAndSessionId(String pi,
 String sessionId)

Parameters:

pi -

sessionId -

Returns:

true if lock removed successfully; false otherwise

removeOldLocks

public int removeOldLocks(long maxAge)

Removes all record locks that are older that maxAge milliseconds. Can be used to periodically clean up locks that might have been missed by the web socket mechanism.

Parameters:

maxAge -

Returns:

Number of removed locks

emptyCacheForRecord

public void emptyCacheForRecord(String pi)

Parameters:

pi -

getRecordAccessConditionsCache

public Map<String,List<String>> getRecordAccessConditionsCache()

Returns:

the recordAccessConditionsCache

getRecordLimitsCache

public Map<String,List<String>> getRecordLimitsCache()

Returns:

the recordLimitsCache