Package org.springframework.integration.mongodb.store

Class AbstractConfigurableMongoDbMessageStore

java.lang.Object

org.springframework.integration.store.AbstractBatchingMessageGroupStore

org.springframework.integration.store.AbstractMessageGroupStore

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, Adama Sorho, Youbin Wu

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 final String	collectionName
protected final Log	logger
protected final MongoDatabaseFactory	mongoDbFactory
static final String	SEQUENCE_NAME

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

GROUP_ID_MUST_NOT_BE_NULL, INTERRUPTED_WHILE_OBTAINING_LOCK

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	afterPropertiesSet()
protected void	createIndexes()
protected void	doAddMessagesToGroup(Object groupId, Message<?>... messages)
protected void	doCompleteGroup(Object groupId)
protected void	doRemoveMessageGroup(Object groupId)
protected void	doRemoveMessagesFromGroup(Object key, Collection<Message<?>> messages)
protected void	doSetGroupCondition(Object groupId, String condition)
protected void	doSetLastReleasedSequenceNumberForGroup(Object groupId, int sequenceNumber)
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)	Return the size of this MessageGroup.
void	setApplicationContext(ApplicationContext applicationContext)
void	setCreateIndexes(boolean createIndexes)	Define the option to auto create indexes or not.

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

addMessagesToGroup, addMessageToGroup, completeGroup, copy, doPollMessageFromGroup, doRemoveMessageFromGroupById, executeLocked, executeLocked, expireMessageGroups, getGroupMetadata, getLockRegistry, getMessageCountForAllMessageGroups, getMessageGroupCount, getMessageGroupFactory, isTimeoutOnIdle, pollMessageFromGroup, registerMessageGroupExpiryCallback, removeMessageFromGroupById, removeMessageGroup, removeMessagesFromGroup, removeMessagesFromGroup, setExpiryCallbacks, setGroupCondition, setLastReleasedSequenceNumberForGroup, setLazyLoadMessageGroups, setLockRegistry, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

getMessageFromGroup, 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

setCreateIndexes

public void setCreateIndexes(boolean createIndexes)

Define the option to auto create indexes or not.

Parameters:

createIndexes - a boolean.

Since:

6.0.8.

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

createIndexes

protected void createIndexes()

getMessage

public Message<?> getMessage(UUID id)

getMessageMetadata

public MessageMetadata getMessageMetadata(UUID id)

doRemoveMessageGroup

protected void doRemoveMessageGroup(Object groupId)

Specified by:

doRemoveMessageGroup in class AbstractMessageGroupStore

messageGroupSize

public int messageGroupSize(Object groupId)

Description copied from interface: BasicMessageGroupStore

Return 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)

doRemoveMessagesFromGroup

protected void doRemoveMessagesFromGroup(Object key,
 Collection<Message<?>> messages)

Specified by:

doRemoveMessagesFromGroup in class AbstractMessageGroupStore

doSetGroupCondition

protected void doSetGroupCondition(Object groupId,
 String condition)

Specified by:

doSetGroupCondition in class AbstractMessageGroupStore

doSetLastReleasedSequenceNumberForGroup

protected void doSetLastReleasedSequenceNumberForGroup(Object groupId,
 int sequenceNumber)

Specified by:

doSetLastReleasedSequenceNumberForGroup in class AbstractMessageGroupStore

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.

doCompleteGroup

protected void doCompleteGroup(Object groupId)

Specified by:

doCompleteGroup in class AbstractMessageGroupStore

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.

doAddMessagesToGroup

protected void doAddMessagesToGroup(Object groupId,
 Message<?>... messages)

Specified by:

doAddMessagesToGroup in class AbstractMessageGroupStore

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.