JdbcMessageStore (Spring Integration 5.0.5.RELEASE API)

java.lang.Object
- org.springframework.integration.store.AbstractBatchingMessageGroupStore
- - org.springframework.integration.store.AbstractMessageGroupStore
  - - org.springframework.integration.jdbc.store.JdbcMessageStore

All Implemented Interfaces:

java.lang.Iterable<MessageGroup>, BasicMessageGroupStore, MessageGroupStore, MessageStore
```
public class JdbcMessageStore
extends AbstractMessageGroupStore
implements MessageStore
```
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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CREATED_DATE_KEY` Deprecated. since 5.0. This constant isn't used any more.
`static java.lang.String`	`DEFAULT_TABLE_PREFIX` Default value for the table prefix property.
`static java.lang.String`	`SAVED_KEY` Deprecated. since 5.0. This constant isn't used any more.

Constructor Summary

Constructors
Constructor and Description
`JdbcMessageStore(javax.sql.DataSource dataSource)` Create a `MessageStore` with all mandatory properties.
`JdbcMessageStore(org.springframework.jdbc.core.JdbcOperations jdbcOperations)` Create a `MessageStore` with all mandatory properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> org.springframework.messaging.Message<T>`	`addMessage(org.springframework.messaging.Message<T> message)` Put the provided Message into the MessageStore.
`void`	`addMessagesToGroup(java.lang.Object groupId, org.springframework.messaging.Message<?>... messages)` Store messages with an association to a group id.
`void`	`addWhiteListPatterns(java.lang.String... patterns)` Add patterns for packages/classes that are allowed to be deserialized.
`void`	`completeGroup(java.lang.Object groupId)` Completes this MessageGroup.
`protected org.springframework.messaging.Message<?>`	`doPollForMessage(java.lang.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 org.springframework.jdbc.core.JdbcOperations`	`getJdbcOperations()` To be used to get a reference to JdbcOperations in case this class is subclassed
`org.springframework.messaging.Message<?>`	`getMessage(java.util.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(java.lang.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.
`MessageMetadata`	`getMessageMetadata(java.util.UUID id)` Return a `MessageMetadata` for the `Message` by provided `id`.
`java.util.Collection<org.springframework.messaging.Message<?>>`	`getMessagesForGroup(java.lang.Object groupId)` Retrieve messages for the provided group id.
`org.springframework.messaging.Message<?>`	`getOneMessageFromGroup(java.lang.Object groupId)` Return the one `Message` from `MessageGroup`.
`protected java.lang.String`	`getQuery(org.springframework.integration.jdbc.store.JdbcMessageStore.Query base)` Replace patterns in the input to produce a valid SQL query.
`java.util.Iterator<MessageGroup>`	`iterator()`
`int`	`messageGroupSize(java.lang.Object groupId)` Returns the size of this MessageGroup.
`org.springframework.messaging.Message<?>`	`pollMessageFromGroup(java.lang.Object groupId)` Polls Message from this `MessageGroup` (in FIFO style if supported by the implementation) while also removing the polled `Message`
`org.springframework.messaging.Message<?>`	`removeMessage(java.util.UUID id)` Remove the Message with the given id from the MessageStore, if present, and return it.
`void`	`removeMessageGroup(java.lang.Object groupId)` Remove the message group with this id.
`void`	`removeMessagesFromGroup(java.lang.Object groupId, java.util.Collection<org.springframework.messaging.Message<?>> messages)` Persist the deletion of messages from the group.
`void`	`setDeserializer(org.springframework.core.serializer.Deserializer<? extends org.springframework.messaging.Message<?>> deserializer)` A converter for deserializing byte arrays to messages.
`void`	`setLastReleasedSequenceNumberForGroup(java.lang.Object groupId, int sequenceNumber)` Allows you to set the sequence number of the last released Message.
`void`	`setLobHandler(org.springframework.jdbc.support.lob.LobHandler lobHandler)` Override the `LobHandler` that is used to create and unpack large objects in SQL queries.
`void`	`setRegion(java.lang.String region)` A unique grouping identifier for all messages persisted with this store.
`void`	`setSerializer(org.springframework.core.serializer.Serializer<? super org.springframework.messaging.Message<?>> serializer)` A converter for serializing messages to byte arrays for storage.
`void`	`setTablePrefix(java.lang.String tablePrefix)` Public setter for the table prefix property.

Methods inherited from class org.springframework.integration.store.AbstractMessageGroupStore
addMessageToGroup, copy, expireMessageGroups, getGroupMetadata, 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 Detail
  - DEFAULT_TABLE_PREFIX
```
public static final java.lang.String DEFAULT_TABLE_PREFIX
```
    Default value for the table prefix property.
    
    See Also:
    
    Constant Field Values
  - SAVED_KEY
```
@Deprecated
public static final java.lang.String SAVED_KEY
```
    Deprecated. since 5.0. This constant isn't used any more.
    
    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
```
@Deprecated
public static final java.lang.String CREATED_DATE_KEY
```
    Deprecated. since 5.0. This constant isn't used any more.
    
    The name of the message header that stores a timestamp for the time the message was inserted.
- Constructor Detail
  - JdbcMessageStore
```
public JdbcMessageStore(javax.sql.DataSource dataSource)
```
    Create a MessageStore with all mandatory properties.
    
    Parameters:
    
    dataSource - a DataSource
  - JdbcMessageStore
```
public JdbcMessageStore(org.springframework.jdbc.core.JdbcOperations jdbcOperations)
```
    Create a MessageStore with all mandatory properties.
    
    Parameters:
    
    jdbcOperations - a JdbcOperations
    
    Since:
    
    4.3.9
- Method Detail
  - setTablePrefix
```
public void setTablePrefix(java.lang.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(java.lang.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
  - setLobHandler
```
public void setLobHandler(org.springframework.jdbc.support.lob.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(org.springframework.core.serializer.Serializer<? super org.springframework.messaging.Message<?>> serializer)
```
    A converter for serializing messages to byte arrays for storage.
    
    Parameters:
    
    serializer - the serializer to set
  - setDeserializer
```
public void setDeserializer(org.springframework.core.serializer.Deserializer<? extends org.springframework.messaging.Message<?>> deserializer)
```
    A converter for deserializing byte arrays to messages.
    
    Parameters:
    
    deserializer - the deserializer to set
  - addWhiteListPatterns
```
public void addWhiteListPatterns(java.lang.String... patterns)
```
    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:
    
    4.2.13
  - removeMessage
```
public org.springframework.messaging.Message<?> removeMessage(java.util.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 org.springframework.messaging.Message<?> getMessage(java.util.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.
  - getMessageMetadata
```
public MessageMetadata getMessageMetadata(java.util.UUID id)
```
    Description copied from interface: MessageStore
    
    Return a MessageMetadata for the Message by provided id.
    
    Specified by:
    
    getMessageMetadata in interface MessageStore
    
    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
```
public <T> org.springframework.messaging.Message<T> addMessage(org.springframework.messaging.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.
  - addMessagesToGroup
```
public void addMessagesToGroup(java.lang.Object groupId,
                               org.springframework.messaging.Message<?>... messages)
```
    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 interface MessageGroupStore
    
    Parameters:
    
    groupId - The group id to store messages under.
    
    messages - The messages to add.
  - 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(java.lang.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(java.lang.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.
  - removeMessagesFromGroup
```
public void removeMessagesFromGroup(java.lang.Object groupId,
                                    java.util.Collection<org.springframework.messaging.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(java.lang.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(java.lang.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(java.lang.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 org.springframework.messaging.Message<?> pollMessageFromGroup(java.lang.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.
  - getOneMessageFromGroup
```
public org.springframework.messaging.Message<?> getOneMessageFromGroup(java.lang.Object groupId)
```
    Description copied from interface: MessageGroupStore
    
    Return the one Message from MessageGroup.
    
    Specified by:
    
    getOneMessageFromGroup in interface MessageGroupStore
    
    Parameters:
    
    groupId - The group identifier.
    
    Returns:
    
    the Message.
  - getMessagesForGroup
```
public java.util.Collection<org.springframework.messaging.Message<?>> getMessagesForGroup(java.lang.Object groupId)
```
    Description copied from interface: MessageGroupStore
    
    Retrieve messages for the provided group id.
    
    Specified by:
    
    getMessagesForGroup in interface MessageGroupStore
    
    Parameters:
    
    groupId - The group id to retrieve messages for.
    
    Returns:
    
    the messages for group.
  - iterator
```
public java.util.Iterator<MessageGroup> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<MessageGroup>
    
    Specified by:
    
    iterator in interface MessageGroupStore
    
    Returns:
    
    The iterator of currently accumulated MessageGroups.
  - getQuery
```
protected java.lang.String getQuery(org.springframework.integration.jdbc.store.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 org.springframework.jdbc.core.JdbcOperations getJdbcOperations()
```
    To be used to get a reference to JdbcOperations in case this class is subclassed
    
    Returns:
    
    the JdbcOperations implementation
  - doPollForMessage
```
protected org.springframework.messaging.Message<?> doPollForMessage(java.lang.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 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

Class JdbcMessageStore

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_TABLE_PREFIX

SAVED_KEY

CREATED_DATE_KEY

Constructor Detail

JdbcMessageStore

JdbcMessageStore

Method Detail

setTablePrefix

setRegion

setLobHandler

setSerializer

setDeserializer

addWhiteListPatterns

removeMessage

getMessageCount

getMessage

getMessageMetadata

addMessage

addMessagesToGroup

getMessageGroupCount

getMessageCountForAllMessageGroups

messageGroupSize

getMessageGroup

removeMessagesFromGroup

removeMessageGroup

completeGroup

setLastReleasedSequenceNumberForGroup

pollMessageFromGroup

getOneMessageFromGroup

getMessagesForGroup

iterator

getQuery

getJdbcOperations

doPollForMessage