inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-10-08 14:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged 5.1-MNT1 (5.1.0) to HEAD (5.1)

Browse Source 
115548 adavis: Merged 5.1.N (5.1.1) to 5.1-MNT1 (5.1.0)
      112342 adavis: Merged 5.0.N (5.0.3) to 5.1.N (5.1.0)
         112260: MNT-14526 : JobLockService add getLock with refresh callback variant


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@115685 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Alan Davis
2015-10-30 00:16:08 +00:00
parent d505abcf14
commit 3434a81b7d
3 changed files with 170 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
source/java/org/alfresco/repo/lock/JobLockService.java
View File

@@ -141,10 +141,25 @@ public interface JobLockService
*/
String getLock(QName lockQName, long timeToLive, long retryWait, int retryCount);
/**
* Take a manually-managed lock and provide a callback to refresh it periodically.
* A convenience wrapper around {@link #getLock(QName,long)}
* and {@link #refreshLock(String,QName,long,JobLockRefreshCallback)}.
*
* @param lockQName the name of the lock to acquire
* @param timeToLive the time (in milliseconds) for the lock to remain valid.
* This value <b>must not</b> be larger than either the anticipated
* operation time or a server startup time. Typically, it should be
* a few seconds.
* @param callback the object that will be called at intervals of timeToLive/2 (about)
* @return Returns the newly-created lock token, or null if callback not active.
* @throws LockAcquisitionException if the lock could not be acquired
*/
String getLock(QName lockQName, long timeToLive, JobLockRefreshCallback callback);
/**
* Refresh the lock using a valid lock token.
*
* @param lockToken the lock token returned when the lock was acquired
* @param lockQName the name of the previously-acquired lock
* @param timeToLive the time (in milliseconds) for the lock to remain valid
* @throws LockAcquisitionException if the lock could not be refreshed or acquired
@@ -159,8 +174,9 @@ public interface JobLockService
* Since the lock is not actually refreshed by this method, there will be no LockAcquisitionException.
* <p/>
* The TTL (time to live) will be divided by two and the result used to trigger a timer thread
* to initiate the callback.
*
* to initiate the callback. The first refresh will occur after TTL/2 and no significant work
* should be done between acquiring a lock and calling this method, to prevent expiration.
*
* @param lockToken the lock token returned when the lock was acquired
* @param lockQName the name of the previously-acquired lock
* @param timeToLive the time (in milliseconds) for the lock to remain valid