org.springframework.integration.mongodb.store.ConfigurableMongoDbMessageStore

All Implemented Interfaces:: Iterable<MessageGroup>, Aware, InitializingBean, ApplicationContextAware, BasicMessageGroupStore, MessageGroupStore, MessageStore

public class ConfigurableMongoDbMessageStore
extends AbstractConfigurableMongoDbMessageStore
implements MessageStore

An alternate MongoDB 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 interface

Since:: 3.0
Author:: Amol Nayak, Artem Bilan, 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 Description

static String DEFAULT_COLLECTION_NAME

Fields inherited from class org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore
collectionName, logger, mongoDbFactory, SEQUENCE_NAME

Constructor Summary

Constructors
Constructor	Description
`ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate)`
`ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate, String collectionName)`
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory)`
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, String collectionName)`
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter)`
`ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter, String collectionName)`

Method Summary

Modifier and Type	Method	Description
`<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.
`MessageGroup`	`addMessageToGroup(Object groupId, Message<?> message)`	Store a message with an association to a group id.
`void`	`completeGroup(Object groupId)`	Completes this MessageGroup.
`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.
`Collection<Message<?>>`	`getMessagesForGroup(Object groupId)`	Retrieve messages for the provided group id.
`Message<?>`	`getOneMessageFromGroup(Object groupId)`	Return the one `Message` from `MessageGroup`.
`Iterator<MessageGroup>`	`iterator()`
`Message<?>`	`pollMessageFromGroup(Object groupId)`	Poll 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.
`void`	`removeMessagesFromGroup(Object groupId, Collection<Message<?>> messages)`	Persist the deletion of messages from the group.
`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.
`Stream<Message<?>>`	`streamMessagesForGroup(Object groupId)`	Return a stream for messages stored in the provided group.

Methods inherited from class org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore

addMessageDocument, afterPropertiesSet, getApplicationContext, getMappingMongoConverter, getMessage, getMessageBuilderFactory, getMessageMetadata, getMongoTemplate, getNextId, groupIdQuery, messageGroupSize, removeMessageGroup, setApplicationContext

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

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

Methods inherited from interface org.springframework.integration.store.MessageStore

getMessage, getMessageMetadata

Field Details
- DEFAULT_COLLECTION_NAME
  
  public static final String DEFAULT_COLLECTION_NAME
  
  See Also:
  
  Constant Field Values
Constructor Details
- ConfigurableMongoDbMessageStore
  
  public ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate)
- ConfigurableMongoDbMessageStore
  
  public ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate, String collectionName)
- ConfigurableMongoDbMessageStore
  
  public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory)
- ConfigurableMongoDbMessageStore
  
  public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter)
- ConfigurableMongoDbMessageStore
  
  public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, String collectionName)
- ConfigurableMongoDbMessageStore
  
  public ConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter, String collectionName)
Method Details
- 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.
- 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
  
  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.
- 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.
- 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
  
  Overrides:
  
  addMessageToGroup in class AbstractMessageGroupStore
  
  Parameters:
  
  groupId - The group id to store the message under.
  
  message - A message.
  
  Returns:
  
  The message group.
- addMessagesToGroup
  
  public void addMessagesToGroup(Object groupId, 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
  
  Overrides:
  
  addMessagesToGroup in class AbstractConfigurableMongoDbMessageStore
  
  Parameters:
  
  groupId - The group id to store messages under.
  
  messages - The messages to add.
- 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
  
  Overrides:
  
  removeMessagesFromGroup in class AbstractConfigurableMongoDbMessageStore
  
  Parameters:
  
  groupId - The groupId for the group containing the message(s).
  
  messages - The messages to be removed.
- pollMessageFromGroup
  
  public Message<?> pollMessageFromGroup(Object groupId)
  
  Description copied from interface: BasicMessageGroupStore
  
  Poll 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.
- 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
  
  Overrides:
  
  setLastReleasedSequenceNumberForGroup in class AbstractConfigurableMongoDbMessageStore
  
  Parameters:
  
  groupId - The group identifier.
  
  sequenceNumber - The sequence number.
- setGroupCondition
  
  public void setGroupCondition(Object groupId, String condition)
  
  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 interface MessageGroupStore
  
  Overrides:
  
  setGroupCondition in class AbstractConfigurableMongoDbMessageStore
  
  Parameters:
  
  groupId - The group identifier.
  
  condition - The condition to store into the group.
- 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
  
  Overrides:
  
  completeGroup in class AbstractConfigurableMongoDbMessageStore
  
  Parameters:
  
  groupId - The group identifier.
- iterator
  
  public Iterator<MessageGroup> iterator()
  
  Specified by:
  
  iterator in interface Iterable<MessageGroup>
  
  Specified by:
  
  iterator in interface MessageGroupStore
  
  Overrides:
  
  iterator in class AbstractConfigurableMongoDbMessageStore
  
  Returns:
  
  The iterator of currently accumulated MessageGroups.
- 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
- 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
- getOneMessageFromGroup
  
  public Message<?> getOneMessageFromGroup(Object groupId)
  
  Description copied from interface: MessageGroupStore
  
  Return the one Message from MessageGroup.
  
  Specified by:
  
  getOneMessageFromGroup in interface MessageGroupStore
  
  Overrides:
  
  getOneMessageFromGroup in class AbstractConfigurableMongoDbMessageStore
  
  Parameters:
  
  groupId - The group identifier.
  
  Returns:
  
  the Message.
- getMessagesForGroup
  
  public Collection<Message<?>> getMessagesForGroup(Object groupId)
  
  Description copied from interface: MessageGroupStore
  
  Retrieve messages for the provided group id.
  
  Specified by:
  
  getMessagesForGroup in interface MessageGroupStore
  
  Overrides:
  
  getMessagesForGroup in class AbstractConfigurableMongoDbMessageStore
  
  Parameters:
  
  groupId - The group id to retrieve messages for.
  
  Returns:
  
  the messages for group.
- streamMessagesForGroup
  
  public Stream<Message<?>> streamMessagesForGroup(Object groupId)
  
  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 of MessageGroupStore.getMessagesForGroup(Object).
  
  Specified by:
  
  streamMessagesForGroup in interface MessageGroupStore
  
  Parameters:
  
  groupId - the group id to retrieve messages.
  
  Returns:
  
  the Stream for messages in this group.

Class ConfigurableMongoDbMessageStore

Nested Class Summary

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

Field Summary

Fields inherited from class org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore