org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore

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

Direct Known Subclasses:: ConfigurableMongoDbMessageStore, MongoDbChannelMessageStore

public abstract class AbstractConfigurableMongoDbMessageStore
extends AbstractMessageGroupStore
implements InitializingBean, ApplicationContextAware

The abstract MongoDB AbstractMessageGroupStore implementation to provide configuration for common options for implementations of this class.

Since:: 4.0
Author:: 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 Description

protected String collectionName

protected Log logger

protected MongoDatabaseFactory mongoDbFactory

static String SEQUENCE_NAME

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`protected void`	`addMessageDocument(MessageDocument document)`
`void`	`addMessagesToGroup(Object groupId, Message<?>... messages)`	Store messages with an association to a group id.
`void`	`afterPropertiesSet()`
`void`	`completeGroup(Object groupId)`	Completes this MessageGroup.
`protected ApplicationContext`	`getApplicationContext()`
`protected MappingMongoConverter`	`getMappingMongoConverter()`
`Message<?>`	`getMessage(UUID id)`
`protected MessageBuilderFactory`	`getMessageBuilderFactory()`
`MessageMetadata`	`getMessageMetadata(UUID id)`
`Collection<Message<?>>`	`getMessagesForGroup(Object groupId)`	Retrieve messages for the provided group id.
`protected MongoTemplate`	`getMongoTemplate()`
`protected long`	`getNextId()`	Perform MongoDB `INC` operation for the document, which contains the `MessageDocument` `sequence`, and return the new incremented value for the new `MessageDocument`.
`Message<?>`	`getOneMessageFromGroup(Object groupId)`	Return the one `Message` from `MessageGroup`.
`protected static Query`	`groupIdQuery(Object groupId)`
`Iterator<MessageGroup>`	`iterator()`
`int`	`messageGroupSize(Object groupId)`	Returns the size of this MessageGroup.
`void`	`removeMessageGroup(Object groupId)`	Remove the message group with this id.
`void`	`removeMessagesFromGroup(Object key, Collection<Message<?>> messages)`	Persist the deletion of messages from the group.
`void`	`setApplicationContext(ApplicationContext applicationContext)`
`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.

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

addMessageToGroup, copy, expireMessageGroups, getGroupMetadata, getMessageCountForAllMessageGroups, getMessageGroupCount, 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 org.springframework.integration.store.BasicMessageGroupStore

getMessageGroup, pollMessageFromGroup

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

streamMessagesForGroup

Field Details
- SEQUENCE_NAME
  
  public static final String SEQUENCE_NAME
  
  See Also:
  
  Constant Field Values
- logger
  
  protected final Log logger
- collectionName
  
  protected final String collectionName
- mongoDbFactory
  
  protected final MongoDatabaseFactory mongoDbFactory
Constructor Details
- AbstractConfigurableMongoDbMessageStore
  
  public AbstractConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate, String collectionName)
- AbstractConfigurableMongoDbMessageStore
  
  public AbstractConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, String collectionName)
- AbstractConfigurableMongoDbMessageStore
  
  public AbstractConfigurableMongoDbMessageStore(MongoDatabaseFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter, String collectionName)
Method Details
- setApplicationContext
  
  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
  
  Specified by:
  
  setApplicationContext in interface ApplicationContextAware
  
  Throws:
  
  BeansException
- getMongoTemplate
  
  protected MongoTemplate getMongoTemplate()
- getMappingMongoConverter
  
  protected MappingMongoConverter getMappingMongoConverter()
- getApplicationContext
  
  protected ApplicationContext getApplicationContext()
- getMessageBuilderFactory
  
  protected MessageBuilderFactory getMessageBuilderFactory()
- afterPropertiesSet
  
  public void afterPropertiesSet()
  
  Specified by:
  
  afterPropertiesSet in interface InitializingBean
- getMessage
  
  public Message<?> getMessage(UUID id)
- getMessageMetadata
  
  public MessageMetadata getMessageMetadata(UUID id)
- 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.
- messageGroupSize
  
  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.
- getNextId
  
  protected long getNextId()
  
  Perform MongoDB INC operation for the document, which contains the MessageDocument sequence, and return the new incremented value for the new MessageDocument. The SEQUENCE_NAME document is created on demand.
  
  Returns:
  
  the next sequence value.
- addMessageDocument
  
  protected void addMessageDocument(MessageDocument document)
- groupIdQuery
  
  protected static Query groupIdQuery(Object groupId)
- removeMessagesFromGroup
  
  public void removeMessagesFromGroup(Object key, Collection<Message<?>> messages)
  
  Description copied from interface: MessageGroupStore
  
  Persist the deletion of messages from the group.
  
  Specified by:
  
  removeMessagesFromGroup in interface MessageGroupStore
  
  Parameters:
  
  key - The groupId for the group containing the message(s).
  
  messages - The messages to be removed.
- 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
  
  Parameters:
  
  groupId - The group identifier.
  
  condition - The condition to store into the group.
- 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.
- 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.
- 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.
- getOneMessageFromGroup
  
  public Message<?> getOneMessageFromGroup(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.
- 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
  
  Parameters:
  
  groupId - The group id to store messages under.
  
  messages - The messages to add.
- 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
  
  Parameters:
  
  groupId - The group id to retrieve messages for.
  
  Returns:
  
  the messages for group.

Modifier and Type	Field	Description
`protected String`	`collectionName`
`protected Log`	`logger`
`protected MongoDatabaseFactory`	`mongoDbFactory`
`static String`	`SEQUENCE_NAME`

Class AbstractConfigurableMongoDbMessageStore

Nested Class Summary

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

Field Summary