Package org.springframework.integration.jdbc.lock

Class JdbcLockRegistry

java.lang.Object

org.springframework.integration.jdbc.lock.JdbcLockRegistry

All Implemented Interfaces:

ExpirableLockRegistry, LockRegistry, RenewableLockRegistry

public class JdbcLockRegistry
extends Object
implements ExpirableLockRegistry, RenewableLockRegistry

An ExpirableLockRegistry using a shared database to co-ordinate the locks. Provides the same semantics as the DefaultLockRegistry, but the locks taken will be global, as long as the underlying database supports the "serializable" isolation level in its transactions.

Since:

4.3

Author:

Dave Syer, Artem Bilan, Vedran Pavic, Kai Zimmermann, Bartosz Rempuszewski, Gary Russell, Alexandre Strubel, Stefan Vassilev, Olivier Hubaut, Fran Aranda, Unseok Kim, Myeonghyeon Lee

Constructor Summary

Constructors

Constructor	Description
JdbcLockRegistry(LockRepository client)	Construct an instance based on the provided LockRepository.

Method Summary

Modifier and Type	Method	Description
void	expireUnusedOlderThan(long age)	Remove locks last acquired more than 'age' ago that are not currently locked.
Lock	obtain(Object lockKey)	Obtains the lock associated with the parameter object.
void	renewLock(Object lockKey)	Renew the time to live of the lock is associated with the parameter object.
void	setCacheCapacity(int cacheCapacity)	Set the capacity of cached locks.
void	setIdleBetweenTries(Duration idleBetweenTries)	Specify a @link Duration} to sleep between lock record insert/update attempts.

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcLockRegistry

public JdbcLockRegistry(LockRepository client)

Construct an instance based on the provided LockRepository.

Parameters:

client - the LockRepository to rely on.

Method Details

setIdleBetweenTries

public void setIdleBetweenTries(Duration idleBetweenTries)

Specify a @link Duration} to sleep between lock record insert/update attempts. Defaults to 100 milliseconds.

Parameters:

idleBetweenTries - the Duration to sleep between insert/update attempts.

Since:

5.1.8

setCacheCapacity

public void setCacheCapacity(int cacheCapacity)

Set the capacity of cached locks.

Parameters:

cacheCapacity - The capacity of cached lock, (default 100_000).

Since:

5.5.6

obtain

public Lock obtain(Object lockKey)

Description copied from interface: LockRegistry

Obtains the lock associated with the parameter object.

Specified by:

obtain in interface LockRegistry

Parameters:

lockKey - The object with which the lock is associated.

Returns:

The associated lock.

expireUnusedOlderThan

public void expireUnusedOlderThan(long age)

Description copied from interface: ExpirableLockRegistry

Remove locks last acquired more than 'age' ago that are not currently locked.

Specified by:

expireUnusedOlderThan in interface ExpirableLockRegistry

Parameters:

age - the time since the lock was last obtained.

renewLock

public void renewLock(Object lockKey)

Description copied from interface: RenewableLockRegistry

Renew the time to live of the lock is associated with the parameter object. The lock must be held by the current thread

Specified by:

renewLock in interface RenewableLockRegistry

Parameters:

lockKey - The object with which the lock is associated.