public class ConfigurableMongoDbMessageStore extends AbstractConfigurableMongoDbMessageStore implements MessageStore
MessageStore
and MessageGroupStore
which allows the user to
configure the instance of MongoTemplate
. The mechanism of storing the messages/group of messages
in the store is and is different from MongoDbMessageStore
. Since the store uses serialization of the
messages by default, all the headers, and the payload of the Message must implement Serializable
interfaceMessageGroupStore.MessageGroupCallback
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_COLLECTION_NAME |
applicationContext, collectionName, CREATED_DATE_KEY, logger, mappingMongoConverter, messageBuilderFactory, mongoDbFactory, mongoTemplate, SAVED_KEY, SEQUENCE_NAME
Constructor and Description |
---|
ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory) |
ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory,
org.springframework.data.mongodb.core.convert.MappingMongoConverter mappingMongoConverter) |
ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory,
org.springframework.data.mongodb.core.convert.MappingMongoConverter mappingMongoConverter,
java.lang.String collectionName) |
ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory,
java.lang.String collectionName) |
ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.core.MongoTemplate mongoTemplate) |
ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.core.MongoTemplate mongoTemplate,
java.lang.String collectionName) |
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.
|
MessageGroup |
addMessageToGroup(java.lang.Object groupId,
org.springframework.messaging.Message<?> message)
Store a message with an association to a group id.
|
void |
completeGroup(java.lang.Object groupId)
Completes this MessageGroup.
|
int |
expireMessageGroups(long timeout)
Extract all expired groups (whose timestamp is older than the current time less the threshold provided) and call
each of the registered callbacks on them in turn.
|
MessageGroupMetadata |
getGroupMetadata(java.lang.Object groupId)
Obtain the group metadata without fetching any messages; must supply all other
group properties; may include the id of the first message.
|
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.
|
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 . |
boolean |
isTimeoutOnIdle() |
java.util.Iterator<MessageGroup> |
iterator() |
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 |
void |
registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback)
Register a callback for when a message group is expired through
MessageGroupStore.expireMessageGroups(long) . |
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 |
removeMessagesFromGroup(java.lang.Object groupId,
java.util.Collection<org.springframework.messaging.Message<?>> messages)
Persist the deletion of messages from the group.
|
void |
removeMessagesFromGroup(java.lang.Object groupId,
org.springframework.messaging.Message<?>... messages)
Persist the deletion of messages from the group.
|
void |
setExpiryCallbacks(java.util.Collection<MessageGroupStore.MessageGroupCallback> expiryCallbacks)
Convenient injection point for expiry callbacks in the message store.
|
void |
setLastReleasedSequenceNumberForGroup(java.lang.Object groupId,
int sequenceNumber)
Allows you to set the sequence number of the last released Message.
|
void |
setTimeoutOnIdle(boolean timeoutOnIdle)
Allows you to override the rule for the timeout calculation.
|
addMessageDocument, afterPropertiesSet, getMessage, getMessageMetadata, getNextId, groupIdQuery, messageGroupSize, removeMessageGroup, setApplicationContext
copy, getMessageGroupFactory, setLazyLoadMessageGroups
getRemoveBatchSize, setMessageGroupFactory, setRemoveBatchSize
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMessage, getMessageMetadata
public static final java.lang.String DEFAULT_COLLECTION_NAME
public ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.core.MongoTemplate mongoTemplate)
public ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.core.MongoTemplate mongoTemplate, java.lang.String collectionName)
public ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory)
public ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory, org.springframework.data.mongodb.core.convert.MappingMongoConverter mappingMongoConverter)
public ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory, java.lang.String collectionName)
public ConfigurableMongoDbMessageStore(org.springframework.data.mongodb.MongoDbFactory mongoDbFactory, org.springframework.data.mongodb.core.convert.MappingMongoConverter mappingMongoConverter, java.lang.String collectionName)
public void setExpiryCallbacks(java.util.Collection<MessageGroupStore.MessageGroupCallback> expiryCallbacks)
MessageGroupStore.registerMessageGroupExpiryCallback(MessageGroupCallback)
.setExpiryCallbacks
in class AbstractMessageGroupStore
expiryCallbacks
- the expiry callbacks to addpublic boolean isTimeoutOnIdle()
isTimeoutOnIdle
in class AbstractMessageGroupStore
public void setTimeoutOnIdle(boolean timeoutOnIdle)
MessageGroup
was created. If you want the timeout to be based on the time
the MessageGroup
was idling (e.g., inactive from the last update) invoke this method with 'true'.
Default is 'false'.setTimeoutOnIdle
in class AbstractMessageGroupStore
timeoutOnIdle
- The boolean.public <T> org.springframework.messaging.Message<T> addMessage(org.springframework.messaging.Message<T> message)
MessageStore
MessageStore.getMessage(UUID)
and MessageStore.removeMessage(UUID)
behave properly. Since messages are
immutable, putting the same message more than once is a no-op.addMessage
in interface MessageStore
T
- The payload type.message
- The message.public org.springframework.messaging.Message<?> removeMessage(java.util.UUID id)
MessageStore
removeMessage
in interface MessageStore
id
- THe message identifier.public long getMessageCount()
MessageStore
getMessageCount
in interface MessageStore
public MessageGroup getMessageGroup(java.lang.Object groupId)
BasicMessageGroupStore
BasicMessageGroupStore.addMessageToGroup(Object, Message)
with this group id.getMessageGroup
in interface BasicMessageGroupStore
groupId
- The group identifier.public MessageGroup addMessageToGroup(java.lang.Object groupId, org.springframework.messaging.Message<?> message)
BasicMessageGroupStore
addMessageToGroup
in interface BasicMessageGroupStore
addMessageToGroup
in class AbstractMessageGroupStore
groupId
- The group id to store the message under.message
- A message.public void addMessagesToGroup(java.lang.Object groupId, org.springframework.messaging.Message<?>... messages)
MessageGroupStore
addMessagesToGroup
in interface MessageGroupStore
addMessagesToGroup
in class AbstractConfigurableMongoDbMessageStore
groupId
- The group id to store messages under.messages
- The messages to add.public void removeMessagesFromGroup(java.lang.Object groupId, java.util.Collection<org.springframework.messaging.Message<?>> messages)
MessageGroupStore
removeMessagesFromGroup
in interface MessageGroupStore
removeMessagesFromGroup
in class AbstractConfigurableMongoDbMessageStore
groupId
- The groupId for the group containing the message(s).messages
- The messages to be removed.public void removeMessagesFromGroup(java.lang.Object groupId, org.springframework.messaging.Message<?>... messages)
MessageGroupStore
removeMessagesFromGroup
in interface MessageGroupStore
removeMessagesFromGroup
in class AbstractMessageGroupStore
groupId
- The groupId for the group containing the message(s).messages
- The messages to be removed.public org.springframework.messaging.Message<?> pollMessageFromGroup(java.lang.Object groupId)
BasicMessageGroupStore
MessageGroup
(in FIFO style if supported by the implementation)
while also removing the polled Message
pollMessageFromGroup
in interface BasicMessageGroupStore
groupId
- The group identifier.public void setLastReleasedSequenceNumberForGroup(java.lang.Object groupId, int sequenceNumber)
MessageGroupStore
setLastReleasedSequenceNumberForGroup
in interface MessageGroupStore
setLastReleasedSequenceNumberForGroup
in class AbstractConfigurableMongoDbMessageStore
groupId
- The group identifier.sequenceNumber
- The sequence number.public void completeGroup(java.lang.Object groupId)
MessageGroupStore
completeGroup
in interface MessageGroupStore
completeGroup
in class AbstractConfigurableMongoDbMessageStore
groupId
- The group identifier.public java.util.Iterator<MessageGroup> iterator()
iterator
in interface java.lang.Iterable<MessageGroup>
iterator
in interface MessageGroupStore
iterator
in class AbstractConfigurableMongoDbMessageStore
MessageGroup
s.public void registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback)
MessageGroupStore
MessageGroupStore.expireMessageGroups(long)
.registerMessageGroupExpiryCallback
in interface MessageGroupStore
registerMessageGroupExpiryCallback
in class AbstractMessageGroupStore
callback
- A callback to execute when a message group is cleaned up.@ManagedOperation public int expireMessageGroups(long timeout)
MessageGroupStore
expireMessageGroups
in interface MessageGroupStore
expireMessageGroups
in class AbstractMessageGroupStore
timeout
- the timeout threshold to useMessageGroupStore.registerMessageGroupExpiryCallback(MessageGroupCallback)
@ManagedAttribute public int getMessageCountForAllMessageGroups()
MessageGroupStore
getMessageCountForAllMessageGroups
in interface MessageGroupStore
getMessageCountForAllMessageGroups
in class AbstractMessageGroupStore
@ManagedAttribute public int getMessageGroupCount()
MessageGroupStore
getMessageGroupCount
in interface MessageGroupStore
getMessageGroupCount
in class AbstractMessageGroupStore
public MessageGroupMetadata getGroupMetadata(java.lang.Object groupId)
MessageGroupStore
getGroupMetadata
in interface MessageGroupStore
getGroupMetadata
in class AbstractMessageGroupStore
groupId
- The group id.public org.springframework.messaging.Message<?> getOneMessageFromGroup(java.lang.Object groupId)
MessageGroupStore
Message
from MessageGroup
.getOneMessageFromGroup
in interface MessageGroupStore
getOneMessageFromGroup
in class AbstractConfigurableMongoDbMessageStore
groupId
- The group identifier.Message
.public java.util.Collection<org.springframework.messaging.Message<?>> getMessagesForGroup(java.lang.Object groupId)
MessageGroupStore
getMessagesForGroup
in interface MessageGroupStore
getMessagesForGroup
in class AbstractConfigurableMongoDbMessageStore
groupId
- The group id to retrieve messages for.