Package org.springframework.integration.jdbc.lock

Class DefaultLockRepository

java.lang.Object

org.springframework.integration.jdbc.lock.DefaultLockRepository

All Implemented Interfaces:

Closeable, AutoCloseable, InitializingBean, LockRepository

@Repository
public class DefaultLockRepository
extends Object
implements LockRepository, InitializingBean

The default implementation of the LockRepository based on the table from the script presented in the org/springframework/integration/jdbc/schema-*.sql.

This repository can't be shared between different JdbcLockRegistry instances. Otherwise it opens a possibility to break Lock contract, where JdbcLockRegistry uses non-shared ReentrantLocks for local synchronizations.

Since:

4.3

Author:

Dave Syer, Artem Bilan, Glenn Renfro, Gary Russell, Alexandre Strubel, Ruslan Stelmachenko

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TABLE_PREFIX	Default value for the table prefix property.
static final int	DEFAULT_TTL	Default value for the time-to-live property.

Constructor Summary

Constructors

Constructor	Description
DefaultLockRepository(DataSource dataSource)	Constructor that initializes the client id that will be associated for all the locks persisted by the store instance to a random UUID.
DefaultLockRepository(DataSource dataSource, String id)	Constructor that allows the user to specify a client id that will be associated for all the locks persisted by the store instance.

Method Summary

Modifier and Type	Method	Description
boolean	acquire(String lock)
void	afterPropertiesSet()
void	close()
void	delete(String lock)
void	deleteExpired()
boolean	isAcquired(String lock)
boolean	renew(String lock)
void	setPrefix(String prefix)	Specify the prefix for target data base table used from queries.
void	setRegion(String region)	A unique grouping identifier for all locks persisted with this store.
void	setTimeToLive(int timeToLive)	Specify the time (in milliseconds) to expire dead locks.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TABLE_PREFIX

public static final String DEFAULT_TABLE_PREFIX

Default value for the table prefix property.

See Also:

• Constant Field Values

DEFAULT_TTL

public static final int DEFAULT_TTL

Default value for the time-to-live property.

See Also:

• Constant Field Values

Constructor Details

DefaultLockRepository

@Autowired
public DefaultLockRepository(DataSource dataSource)

Constructor that initializes the client id that will be associated for all the locks persisted by the store instance to a random UUID.

Parameters:

dataSource - the DataSource used to maintain the lock repository.

DefaultLockRepository

public DefaultLockRepository(DataSource dataSource,
 String id)

Constructor that allows the user to specify a client id that will be associated for all the locks persisted by the store instance.

Parameters:

dataSource - the DataSource used to maintain the lock repository.

id - the client id to be associated with locks handled by the repository.

Since:

4.3.13

Method Details

setRegion

public void setRegion(String region)

A unique grouping identifier for all locks persisted with this store. Using multiple regions allows the store to be partitioned (if necessary) for different purposes. Defaults to DEFAULT.

Parameters:

region - the region name to set

setPrefix

public void setPrefix(String prefix)

Specify the prefix for target data base table used from queries.

Parameters:

prefix - the prefix to set (default INT_).

setTimeToLive

public void setTimeToLive(int timeToLive)

Specify the time (in milliseconds) to expire dead locks.

Parameters:

timeToLive - the time to expire dead locks.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

close

@Transactional(propagation=REQUIRES_NEW)
public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface LockRepository

delete

@Transactional(propagation=REQUIRES_NEW)
public void delete(String lock)

Specified by:

delete in interface LockRepository

acquire

@Transactional(propagation=REQUIRES_NEW,
               isolation=SERIALIZABLE)
public boolean acquire(String lock)

Specified by:

acquire in interface LockRepository

isAcquired

@Transactional(propagation=REQUIRES_NEW,
               readOnly=true)
public boolean isAcquired(String lock)

Specified by:

isAcquired in interface LockRepository

deleteExpired

@Transactional(propagation=REQUIRES_NEW)
public void deleteExpired()

Specified by:

deleteExpired in interface LockRepository

renew

@Transactional(propagation=REQUIRES_NEW)
public boolean renew(String lock)

Specified by:

renew in interface LockRepository