org.springframework.integration.jdbc

Class JdbcMessageStore

java.lang.Object

org.springframework.integration.store.AbstractBatchingMessageGroupStore

org.springframework.integration.store.AbstractMessageGroupStore

org.springframework.integration.jdbc.JdbcMessageStore

All Implemented Interfaces:

Iterable<MessageGroup>, Aware, BeanFactoryAware, InitializingBean, BasicMessageGroupStore, MessageGroupStore, MessageStore

public class JdbcMessageStore
extends AbstractMessageGroupStore
implements MessageStore, InitializingBean

Implementation of MessageStore 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. Notice: Starting with Spring Integration 3.0, this class will move to package: org.springframework.integration.jdbc.store. If you intend backing a MessageChannel using a JDBC-based Message Store, please consider using the channel-specific JdbcChannelMessageStore instead.

Since:

2.0

Author:

Dave Syer, Oleg Zhurakousky, Matt Stine, Gunnar Hillert, Will Schipp, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.store.MessageGroupStore

MessageGroupStore.MessageGroupCallback

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATED_DATE_KEY The name of the message header that stores a timestamp for the time the message was inserted.
static int	DEFAULT_LONG_STRING_LENGTH
static String	DEFAULT_TABLE_PREFIX Default value for the table prefix property.
static String	SAVED_KEY The name of the message header that stores a flag to indicate that the message has been saved.

Constructor Summary

Constructors

Constructor and Description
JdbcMessageStore() Convenient constructor for configuration use.
JdbcMessageStore(DataSource dataSource) Create a MessageStore with all mandatory properties.

Method Summary

Modifier and Type	Method and Description
<T> Message<T>	addMessage(Message<T> message) Put the provided Message into the MessageStore.
MessageGroup	addMessageToGroup(Object groupId, Message<?> message) Store a message with an association to a group id.
void	afterPropertiesSet()
void	completeGroup(Object groupId) Completes this MessageGroup.
protected Message<?>	doPollForMessage(String groupIdKey) This method executes a call to the DB to get the oldest Message in the MessageGroup Override this method if need to.
protected JdbcOperations	getJdbcOperations() To be used to get a reference to JdbcOperations in case this class is subclassed
Message<?>	getMessage(UUID id)
long	getMessageCount() Optional attribute giving the number of messages in the store.
int	getMessageCountForAllMessageGroups() Optional attribute giving the number of messages in the store over all groups.
MessageGroup	getMessageGroup(Object groupId) Return all Messages currently in the MessageStore that were stored using BasicMessageGroupStore.addMessageToGroup(Object, Message) with this group id.
int	getMessageGroupCount() Optional attribute giving the number of message groups.
protected String	getQuery(org.springframework.integration.jdbc.JdbcMessageStore.Query base) Replace patterns in the input to produce a valid SQL query.
Iterator<MessageGroup>	iterator()
int	messageGroupSize(Object groupId) Returns the size of this MessageGroup.
Message<?>	pollMessageFromGroup(Object groupId) Polls Message from this MessageGroup (in FIFO style if supported by the implementation) while also removing the polled Message
Message<?>	removeMessage(UUID id) Remove the Message with the given id from the MessageStore, if present, and return it.
MessageGroup	removeMessageFromGroup(Object groupId, Message<?> messageToRemove) Persist the deletion of a single message from the group.
void	removeMessageGroup(Object groupId) Remove the message group with this id.
void	removeMessagesFromGroup(Object groupId, Collection<Message<?>> messages) Persist the deletion of messages from the group.
void	setDataSource(DataSource dataSource) The JDBC DataSource to use when interacting with the database.
void	setDeserializer(Deserializer<? extends Message<?>> deserializer) A converter for deserializing byte arrays to messages.
void	setJdbcTemplate(JdbcOperations jdbcTemplate) The JdbcOperations to use when interacting with the database.
void	setLastReleasedSequenceNumberForGroup(Object groupId, int sequenceNumber) Allows you to set the sequence number of the last released Message.
void	setLobHandler(LobHandler lobHandler) Override the LobHandler that is used to create and unpack large objects in SQL queries.
void	setRegion(String region) A unique grouping identifier for all messages persisted with this store.
void	setSerializer(Serializer<? super Message<?>> serializer) A converter for serializing messages to byte arrays for storage.
void	setTablePrefix(String tablePrefix) Public setter for the table prefix property.

Methods inherited from class org.springframework.integration.store.AbstractMessageGroupStore

copy, expireMessageGroups, getGroupMetadata, getMessageBuilderFactory, getOneMessageFromGroup, isTimeoutOnIdle, registerMessageGroupExpiryCallback, removeMessagesFromGroup, setBeanFactory, setExpiryCallbacks, setTimeoutOnIdle

Methods inherited from class org.springframework.integration.store.AbstractBatchingMessageGroupStore

getRemoveBatchSize, setRemoveBatchSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_TABLE_PREFIX

public static final String DEFAULT_TABLE_PREFIX

Default value for the table prefix property.

See Also:

Constant Field Values

DEFAULT_LONG_STRING_LENGTH

public static final int DEFAULT_LONG_STRING_LENGTH

See Also:

Constant Field Values

SAVED_KEY

public static final String SAVED_KEY

The name of the message header that stores a flag to indicate that the message has been saved. This is an optimization for the put method.

CREATED_DATE_KEY

public static final String CREATED_DATE_KEY

The name of the message header that stores a timestamp for the time the message was inserted.

Constructor Detail

JdbcMessageStore

public JdbcMessageStore()

Convenient constructor for configuration use.

JdbcMessageStore

public JdbcMessageStore(DataSource dataSource)

Create a MessageStore with all mandatory properties.

Parameters:

dataSource - a DataSource

Method Detail

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

setDataSource

public void setDataSource(DataSource dataSource)

The JDBC DataSource to use when interacting with the database. Either this property can be set or the jdbcTemplate.

Parameters:

dataSource - a DataSource

setJdbcTemplate

public void setJdbcTemplate(JdbcOperations jdbcTemplate)

The JdbcOperations to use when interacting with the database. Either this property can be set or the dataSource.

Parameters:

jdbcTemplate - a JdbcOperations

setLobHandler

public void setLobHandler(LobHandler lobHandler)

Override the LobHandler that is used to create and unpack large objects in SQL queries. The default is fine for almost all platforms, but some Oracle drivers require a native implementation.

Parameters:

lobHandler - a LobHandler

setSerializer

public void setSerializer(Serializer<? super Message<?>> serializer)

A converter for serializing messages to byte arrays for storage.

Parameters:

serializer - the serializer to set

setDeserializer

public void setDeserializer(Deserializer<? extends Message<?>> deserializer)

A converter for deserializing byte arrays to messages.

Parameters:

deserializer - the deserializer to set

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

removeMessage

public Message<?> removeMessage(UUID id)

Description copied from interface: MessageStore

Remove the Message with the given id from the MessageStore, if present, and return it. If no Message with that id is present in the store, this will return null.

Specified by:

removeMessage in interface MessageStore

Parameters:

id - THe message identifier.

Returns:

The message.

getMessageCount

@ManagedAttribute
public long getMessageCount()

Description copied from interface: MessageStore

Optional attribute giving the number of messages in the store. Implementations may decline to respond by throwing an exception.

Specified by:

getMessageCount in interface MessageStore

Returns:

The number of messages.

getMessage

public Message<?> getMessage(UUID id)

Specified by:

getMessage in interface MessageStore

Parameters:

id - The message identifier.

Returns:

The Message with the given id, or null if no Message with that id exists in the MessageStore.

addMessage

public <T> Message<T> addMessage(Message<T> message)

Description copied from interface: MessageStore

Put the provided Message into the MessageStore. The store may need to mutate the message internally, and if it does then the return value can be different than the input. The id of the return value will be used as an index so that the MessageStore.getMessage(UUID) and MessageStore.removeMessage(UUID) behave properly. Since messages are immutable, putting the same message more than once is a no-op.

Specified by:

addMessage in interface MessageStore

Type Parameters:

T - The payload type.

Parameters:

message - The message.

Returns:

The message that was stored.

addMessageToGroup

public MessageGroup addMessageToGroup(Object groupId,
                                      Message<?> message)

Description copied from interface: BasicMessageGroupStore

Store a message with an association to a group id. This can be used to group messages together.

Specified by:

addMessageToGroup in interface BasicMessageGroupStore

Parameters:

groupId - The group id to store the message under.

message - A message.

Returns:

The message group.

getMessageGroupCount

@ManagedAttribute
public int getMessageGroupCount()

Description copied from interface: MessageGroupStore

Optional attribute giving the number of message groups. Implementations may decline to respond by throwing an exception.

Specified by:

getMessageGroupCount in interface MessageGroupStore

Overrides:

getMessageGroupCount in class AbstractMessageGroupStore

Returns:

the number message groups

getMessageCountForAllMessageGroups

@ManagedAttribute
public int getMessageCountForAllMessageGroups()

Description copied from interface: MessageGroupStore

Optional attribute giving the number of messages in the store over all groups. Implementations may decline to respond by throwing an exception.

Specified by:

getMessageCountForAllMessageGroups in interface MessageGroupStore

Overrides:

getMessageCountForAllMessageGroups in class AbstractMessageGroupStore

Returns:

the number of messages

messageGroupSize

@ManagedAttribute
public int messageGroupSize(Object groupId)

Description copied from interface: BasicMessageGroupStore

Returns the size of this MessageGroup.

Specified by:

messageGroupSize in interface BasicMessageGroupStore

Parameters:

groupId - The group identifier.

Returns:

The size.

getMessageGroup

public MessageGroup getMessageGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Return all Messages currently in the MessageStore that were stored using BasicMessageGroupStore.addMessageToGroup(Object, Message) with this group id.

Specified by:

getMessageGroup in interface BasicMessageGroupStore

Parameters:

groupId - The group identifier.

Returns:

A group of messages, empty if none exists for this key.

removeMessageFromGroup

public MessageGroup removeMessageFromGroup(Object groupId,
                                           Message<?> messageToRemove)

Description copied from interface: MessageGroupStore

Persist the deletion of a single message from the group. The group is modified to reflect that 'messageToRemove' is no longer present in the group.

Specified by:

removeMessageFromGroup in interface MessageGroupStore

Parameters:

groupId - The groupId for the group containing the message.

messageToRemove - The message to be removed.

Returns:

The message Group.

removeMessagesFromGroup

public void removeMessagesFromGroup(Object groupId,
                                    Collection<Message<?>> messages)

Description copied from interface: MessageGroupStore

Persist the deletion of messages from the group.

Specified by:

removeMessagesFromGroup in interface MessageGroupStore

Parameters:

groupId - The groupId for the group containing the message(s).

messages - The messages to be removed.

removeMessageGroup

public void removeMessageGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Remove the message group with this id.

Specified by:

removeMessageGroup in interface BasicMessageGroupStore

Parameters:

groupId - The id of the group to remove.

completeGroup

public void completeGroup(Object groupId)

Description copied from interface: MessageGroupStore

Completes this MessageGroup. Completion of the MessageGroup generally means that this group should not be allowing any more mutating operation to be performed on it. For example any attempt to add/remove new Message form the group should not be allowed.

Specified by:

completeGroup in interface MessageGroupStore

Parameters:

groupId - The group identifier.

setLastReleasedSequenceNumberForGroup

public void setLastReleasedSequenceNumberForGroup(Object groupId,
                                                  int sequenceNumber)

Description copied from interface: MessageGroupStore

Allows you to set the sequence number of the last released Message. Used for Resequencing use cases

Specified by:

setLastReleasedSequenceNumberForGroup in interface MessageGroupStore

Parameters:

groupId - The group identifier.

sequenceNumber - The sequence number.

pollMessageFromGroup

public Message<?> pollMessageFromGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Polls Message from this MessageGroup (in FIFO style if supported by the implementation) while also removing the polled Message

Specified by:

pollMessageFromGroup in interface BasicMessageGroupStore

Parameters:

groupId - The group identifier.

Returns:

The message.

iterator

public Iterator<MessageGroup> iterator()

Specified by:

iterator in interface Iterable<MessageGroup>

Specified by:

iterator in interface MessageGroupStore

Returns:

The iterator of currently accumulated MessageGroups.

getQuery

protected String getQuery(org.springframework.integration.jdbc.JdbcMessageStore.Query base)

Replace patterns in the input to produce a valid SQL query. This implementation lazily initializes a simple map-based cache, only replacing the table prefix on the first access to a named query. Further accesses will be resolved from the cache.

Parameters:

base - the SQL query to be transformed

Returns:

a transformed query with replacements

getJdbcOperations

protected JdbcOperations getJdbcOperations()

To be used to get a reference to JdbcOperations in case this class is subclassed

Returns:

the JdbcOperations implementation

doPollForMessage

protected Message<?> doPollForMessage(String groupIdKey)

This method executes a call to the DB to get the oldest Message in the MessageGroup Override this method if need to. For example if you DB supports advanced function such as FIRST etc.

Parameters:

groupIdKey - String representation of message group ID

Returns:

a message; could be null if query produced no Messages