Class JdbcMessageStore
java.lang.Object
org.springframework.integration.store.AbstractBatchingMessageGroupStore
org.springframework.integration.store.AbstractMessageGroupStore
org.springframework.integration.jdbc.store.JdbcMessageStore
- All Implemented Interfaces:
Iterable<MessageGroup>
,Aware
,BeanClassLoaderAware
,BasicMessageGroupStore
,MessageGroupStore
,MessageStore
public class JdbcMessageStore
extends AbstractMessageGroupStore
implements MessageStore, BeanClassLoaderAware
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.
If you intend backing a MessageChannel
using a JDBC-based Message Store,
please consider using the channel-specific JdbcChannelMessageStore
instead.
This implementation is intended for correlation components (e.g. <aggregator>
),
<delayer>
and similar.
- Since:
- 2.0
- Author:
- Dave Syer, Oleg Zhurakousky, Matt Stine, Gunnar Hillert, Will Schipp, Gary Russell, Artem Bilan
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.integration.store.MessageGroupStore
MessageGroupStore.MessageGroupCallback
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Default value for the table prefix property.Fields inherited from class org.springframework.integration.store.AbstractMessageGroupStore
logger
-
Constructor Summary
ConstructorDescriptionJdbcMessageStore
(DataSource dataSource) Create aMessageStore
with all mandatory properties.JdbcMessageStore
(JdbcOperations jdbcOperations) Create aMessageStore
with all mandatory properties. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAllowedPatterns
(String... patterns) Add patterns for packages/classes that are allowed to be deserialized.<T> Message<T>
addMessage
(Message<T> message) Put the provided Message into the MessageStore.void
addMessagesToGroup
(Object groupId, Message<?>... messages) Store messages with an association to a group id.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.getGroupMetadata
(Object groupId) Obtain the group metadata without fetching any messages; must supply all other group properties; may include the id of the first message.protected JdbcOperations
To be used to get a reference to JdbcOperations in case this class is subclassed.Message<?>
getMessage
(UUID id) long
Optional attribute giving the number of messages in the store.int
Optional attribute giving the number of messages in the store over all groups.getMessageGroup
(Object groupId) Return all Messages currently in the MessageStore that were stored usingBasicMessageGroupStore.addMessageToGroup(Object, Message)
with this group id.int
Optional attribute giving the number of message groups.Collection<Message<?>>
getMessagesForGroup
(Object groupId) Retrieve messages for the provided group id.Message<?>
getOneMessageFromGroup
(Object groupId) Return the oneMessage
fromMessageGroup
.protected String
getQuery
(org.springframework.integration.jdbc.store.JdbcMessageStore.Query base) Replace patterns in the input to produce a valid SQL query.iterator()
int
messageGroupSize
(Object groupId) Return the size of this MessageGroup.Message<?>
pollMessageFromGroup
(Object groupId) Poll Message from thisMessageGroup
(in FIFO style if supported by the implementation) while also removing the polledMessage
.Message<?>
removeMessage
(UUID id) Remove the Message with the given id from the MessageStore, if present, and return it.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
setBeanClassLoader
(ClassLoader classLoader) void
setDeserializer
(Deserializer<? extends Message<?>> deserializer) A converter for deserializing byte arrays to message.void
setGroupCondition
(Object groupId, String condition) Add a condition sentence into the group.void
setLastReleasedSequenceNumberForGroup
(Object groupId, int sequenceNumber) Allows you to set the sequence number of the last released Message.void
setLobHandler
(LobHandler lobHandler) Override theLobHandler
that is used to create and unpack large objects in SQL queries.void
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.streamMessagesForGroup
(Object groupId) Return a stream for messages stored in the provided group.Methods inherited from class org.springframework.integration.store.AbstractMessageGroupStore
addMessageToGroup, copy, expireMessageGroups, getMessageGroupFactory, isTimeoutOnIdle, registerMessageGroupExpiryCallback, removeMessagesFromGroup, setExpiryCallbacks, setLazyLoadMessageGroups, setTimeoutOnIdle
Methods inherited from class org.springframework.integration.store.AbstractBatchingMessageGroupStore
getRemoveBatchSize, setMessageGroupFactory, 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 Details
-
DEFAULT_TABLE_PREFIX
Default value for the table prefix property.- See Also:
-
-
Constructor Details
-
JdbcMessageStore
Create aMessageStore
with all mandatory properties.- Parameters:
dataSource
- aDataSource
-
JdbcMessageStore
Create aMessageStore
with all mandatory properties.- Parameters:
jdbcOperations
- aJdbcOperations
- Since:
- 4.3.9
-
-
Method Details
-
setBeanClassLoader
- Specified by:
setBeanClassLoader
in interfaceBeanClassLoaderAware
-
setTablePrefix
Public setter for the table prefix property. This will be prefixed to all the table names before queries are executed. Defaults toDEFAULT_TABLE_PREFIX
.- Parameters:
tablePrefix
- the tablePrefix to set
-
setRegion
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 toDEFAULT
.- Parameters:
region
- the region name to set
-
setLobHandler
Override theLobHandler
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
- aLobHandler
-
setSerializer
A converter for serializing messages to byte arrays for storage.- Parameters:
serializer
- the serializer to set
-
setDeserializer
A converter for deserializing byte arrays to message.- Parameters:
deserializer
- the deserializer to set
-
addAllowedPatterns
Add patterns for packages/classes that are allowed to be deserialized. A class can be fully qualified or a wildcard '*' is allowed at the beginning or end of the class name. Examples:com.foo.*
,*.MyClass
.- Parameters:
patterns
- the patterns.- Since:
- 5.4
-
removeMessage
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 interfaceMessageStore
- Parameters:
id
- THe message identifier.- Returns:
- The message.
-
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 interfaceMessageStore
- Returns:
- The number of messages.
-
getMessage
- Specified by:
getMessage
in interfaceMessageStore
- Parameters:
id
- The message identifier.- Returns:
- The Message with the given id, or null if no Message with that id exists in the MessageStore.
-
getMessageMetadata
Description copied from interface:MessageStore
- Specified by:
getMessageMetadata
in interfaceMessageStore
- Parameters:
id
- The message identifier.- Returns:
- The MessageMetadata with the given id, or null if no Message with that id exists in the MessageStore or the message has no metadata (legacy message from an earlier version).
-
addMessage
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 theMessageStore.getMessage(UUID)
andMessageStore.removeMessage(UUID)
behave properly. Since messages are immutable, putting the same message more than once is a no-op.- Specified by:
addMessage
in interfaceMessageStore
- Type Parameters:
T
- The payload type.- Parameters:
message
- The message.- Returns:
- The message that was stored.
-
addMessagesToGroup
Description copied from interface:MessageGroupStore
Store messages with an association to a group id. This can be used to group messages together.- Specified by:
addMessagesToGroup
in interfaceMessageGroupStore
- Parameters:
groupId
- The group id to store messages under.messages
- The messages to add.
-
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 interfaceMessageGroupStore
- Overrides:
getMessageGroupCount
in classAbstractMessageGroupStore
- Returns:
- the number message groups
-
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 interfaceMessageGroupStore
- Overrides:
getMessageCountForAllMessageGroups
in classAbstractMessageGroupStore
- Returns:
- the number of messages
-
messageGroupSize
Description copied from interface:BasicMessageGroupStore
Return the size of this MessageGroup.- Specified by:
messageGroupSize
in interfaceBasicMessageGroupStore
- Parameters:
groupId
- The group identifier.- Returns:
- The size.
-
getMessageGroup
Description copied from interface:BasicMessageGroupStore
Return all Messages currently in the MessageStore that were stored usingBasicMessageGroupStore.addMessageToGroup(Object, Message)
with this group id.- Specified by:
getMessageGroup
in interfaceBasicMessageGroupStore
- Parameters:
groupId
- The group identifier.- Returns:
- A group of messages, empty if none exists for this key.
-
getGroupMetadata
Description copied from interface:MessageGroupStore
Obtain the group metadata without fetching any messages; must supply all other group properties; may include the id of the first message.- Specified by:
getGroupMetadata
in interfaceMessageGroupStore
- Overrides:
getGroupMetadata
in classAbstractMessageGroupStore
- Parameters:
groupId
- The group id.- Returns:
- The metadata.
-
removeMessagesFromGroup
Description copied from interface:MessageGroupStore
Persist the deletion of messages from the group.- Specified by:
removeMessagesFromGroup
in interfaceMessageGroupStore
- Parameters:
groupId
- The groupId for the group containing the message(s).messages
- The messages to be removed.
-
removeMessageGroup
Description copied from interface:BasicMessageGroupStore
Remove the message group with this id.- Specified by:
removeMessageGroup
in interfaceBasicMessageGroupStore
- Parameters:
groupId
- The id of the group to remove.
-
completeGroup
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 interfaceMessageGroupStore
- Parameters:
groupId
- The group identifier.
-
setGroupCondition
Description copied from interface:MessageGroupStore
Add a condition sentence into the group. Can be used later on for making some decisions for group, e.g. release strategy for correlation handler can consult this condition instead of iterating all the messages in group.- Specified by:
setGroupCondition
in interfaceMessageGroupStore
- Parameters:
groupId
- The group identifier.condition
- The condition to store into the group.
-
setLastReleasedSequenceNumberForGroup
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 interfaceMessageGroupStore
- Parameters:
groupId
- The group identifier.sequenceNumber
- The sequence number.
-
pollMessageFromGroup
Description copied from interface:BasicMessageGroupStore
Poll Message from thisMessageGroup
(in FIFO style if supported by the implementation) while also removing the polledMessage
.- Specified by:
pollMessageFromGroup
in interfaceBasicMessageGroupStore
- Parameters:
groupId
- The group identifier.- Returns:
- The message.
-
getOneMessageFromGroup
Description copied from interface:MessageGroupStore
Return the oneMessage
fromMessageGroup
.- Specified by:
getOneMessageFromGroup
in interfaceMessageGroupStore
- Parameters:
groupId
- The group identifier.- Returns:
- the
Message
.
-
getMessagesForGroup
Description copied from interface:MessageGroupStore
Retrieve messages for the provided group id.- Specified by:
getMessagesForGroup
in interfaceMessageGroupStore
- Parameters:
groupId
- The group id to retrieve messages for.- Returns:
- the messages for group.
-
streamMessagesForGroup
Description copied from interface:MessageGroupStore
Return a stream for messages stored in the provided group. The persistent implementations return a Stream which has to be closed once fully processed (e.g. through a try-with-resources clause). By default, it streams a result ofMessageGroupStore.getMessagesForGroup(Object)
.- Specified by:
streamMessagesForGroup
in interfaceMessageGroupStore
- Parameters:
groupId
- the group id to retrieve messages.- Returns:
- the
Stream
for messages in this group.
-
iterator
- Specified by:
iterator
in interfaceIterable<MessageGroup>
- Specified by:
iterator
in interfaceMessageGroupStore
- Returns:
- The iterator of currently accumulated
MessageGroup
s.
-
getQuery
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
To be used to get a reference to JdbcOperations in case this class is subclassed.- Returns:
- the JdbcOperations implementation
-
doPollForMessage
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 your 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
-