Package org.springframework.integration.jdbc.metadata

Class JdbcMetadataStore

java.lang.Object

org.springframework.integration.jdbc.metadata.JdbcMetadataStore

All Implemented Interfaces:

InitializingBean, ConcurrentMetadataStore, MetadataStore

public class JdbcMetadataStore
extends Object
implements ConcurrentMetadataStore, InitializingBean

Implementation of ConcurrentMetadataStore using a relational database via JDBC. SQL scripts to create the necessary tables are packaged as org/springframework/integration/jdbc/schema-*.sql, where * is the target database type.

The transaction management is required to use this ConcurrentMetadataStore.

Since:

5.0

Author:

Bojan Vukasovic, Artem Bilan, Gary Russell

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_TABLE_PREFIX	Default value for the table prefix property.

Constructor Summary

Constructors

Constructor	Description
JdbcMetadataStore(DataSource dataSource)	Instantiate a JdbcMetadataStore using provided dataSource DataSource.
JdbcMetadataStore(JdbcOperations jdbcOperations)	Instantiate a JdbcMetadataStore using provided jdbcOperations JdbcOperations.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
String	get(String key)	Reads a value for the given key from this MetadataStore.
void	put(String key, String value)	Writes a key value pair to this MetadataStore.
String	putIfAbsent(String key, String value)	Atomically insert the key into the store.
String	remove(String key)	Remove a value for the given key from this MetadataStore.
boolean	replace(String key, String oldValue, String newValue)	Atomically replace the value for the key in the store if the old value matches the oldValue argument.
void	setLockHint(String lockHint)	Specify a row lock hint for the query in the lock-based operations.
void	setRegion(String region)	A unique grouping identifier for all messages persisted with this store.
void	setTablePrefix(String tablePrefix)	Public setter for the table prefix property.

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

Constructor Details

JdbcMetadataStore

public JdbcMetadataStore(DataSource dataSource)

Instantiate a JdbcMetadataStore using provided dataSource DataSource.

Parameters:

dataSource - a DataSource

JdbcMetadataStore

public JdbcMetadataStore(JdbcOperations jdbcOperations)

Instantiate a JdbcMetadataStore using provided jdbcOperations JdbcOperations.

Parameters:

jdbcOperations - a JdbcOperations

Method Details

setTablePrefix

public void setTablePrefix(String tablePrefix)

Public setter for the table prefix property. This will be prefixed to all the table names before queries are executed. Defaults to DEFAULT_TABLE_PREFIX.

Parameters:

tablePrefix - the tablePrefix to set

setRegion

public void setRegion(String region)

A unique grouping identifier for all messages 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

setLockHint

public void setLockHint(String lockHint)

Specify a row lock hint for the query in the lock-based operations. Defaults to FOR UPDATE. Can be specified as an empty string, if the target RDBMS doesn't support locking on tables from queries. The value depends from RDBMS vendor, e.g. SQL Server requires WITH (ROWLOCK).

Parameters:

lockHint - the RDBMS vendor-specific lock hint.

Since:

5.0.7

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

putIfAbsent

@Transactional public String putIfAbsent(String key, String value)

Description copied from interface: ConcurrentMetadataStore

Atomically insert the key into the store.

Specified by:

putIfAbsent in interface ConcurrentMetadataStore

Parameters:

key - The key.

value - The value.

Returns:

null if successful, the old value otherwise.

replace

@Transactional public boolean replace(String key, String oldValue, String newValue)

Description copied from interface: ConcurrentMetadataStore

Atomically replace the value for the key in the store if the old value matches the oldValue argument.

Specified by:

replace in interface ConcurrentMetadataStore

Parameters:

key - The key.

oldValue - The old value.

newValue - The new value.

Returns:

true if successful.

put

@Transactional public void put(String key, String value)

Description copied from interface: MetadataStore

Writes a key value pair to this MetadataStore.

Specified by:

put in interface MetadataStore

Parameters:

key - The key.

value - The value.

get

@Transactional public String get(String key)

Description copied from interface: MetadataStore

Reads a value for the given key from this MetadataStore.

Specified by:

get in interface MetadataStore

Parameters:

key - The key.

Returns:

The value.

remove

@Transactional public String remove(String key)

Description copied from interface: MetadataStore

Remove a value for the given key from this MetadataStore.

Specified by:

remove in interface MetadataStore

Parameters:

key - The key.

Returns:

The previous value associated with key, or null if there was no mapping for key.