org.springframework.integration.mongodb.store

Class MongoDbMessageStore

java.lang.Object

org.springframework.integration.store.AbstractBatchingMessageGroupStore

org.springframework.integration.store.AbstractMessageGroupStore

org.springframework.integration.mongodb.store.MongoDbMessageStore

All Implemented Interfaces:

Iterable<MessageGroup>, Aware, BeanClassLoaderAware, BeanFactoryAware, InitializingBean, ApplicationContextAware, BasicMessageGroupStore, MessageGroupStore, MessageStore

public class MongoDbMessageStore
extends AbstractMessageGroupStore
implements MessageStore, BeanClassLoaderAware, ApplicationContextAware, InitializingBean

An implementation of both the MessageStore and MessageGroupStore strategies that relies upon MongoDB for persistence.

Since:

2.1

Author:

Mark Fisher, Oleg Zhurakousky, Sean Brandt, Jodie StJohn, 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 String	CREATED_DATE_KEY The name of the message header that stores a timestamp for the time the message was inserted.
static String	SAVED_KEY The name of the message header that stores a flag to indicate that the message has been saved.
static String	SEQUENCE_NAME

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

logger

Constructor Summary

Constructors

Constructor and Description
MongoDbMessageStore(MongoDbFactory mongoDbFactory) Create a MongoDbMessageStore using the provided MongoDbFactory.and the default collection name.
MongoDbMessageStore(MongoDbFactory mongoDbFactory, String collectionName) Create a MongoDbMessageStore using the provided MongoDbFactory and collection name.

Method Summary

Modifier and Type	Method and 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.
void	afterPropertiesSet()
void	completeGroup(Object groupId) Completes this MessageGroup.
Message<?>	getMessage(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(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()
int	messageGroupSize(Object groupId) Returns the size of this MessageGroup.
Message<?>	pollMessageFromGroup(Object groupId) Polls 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.
MessageGroup	removeMessageFromGroup(Object groupId, Message<?> messageToRemove) Deprecated.
void	removeMessageGroup(Object groupId) Remove the message group with this id.
void	removeMessagesFromGroup(Object groupId, Collection<Message<?>> messages) Persist the deletion of messages from the group.
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanClassLoader(ClassLoader classLoader)
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, getMessageBuilderFactory, getMessageGroupFactory, isTimeoutOnIdle, registerMessageGroupExpiryCallback, removeMessagesFromGroup, setBeanFactory, 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

SEQUENCE_NAME

public static final String SEQUENCE_NAME

See Also:

Constant Field Values

SAVED_KEY

public static final String SAVED_KEY

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

public static final String CREATED_DATE_KEY

The name of the message header that stores a timestamp for the time the message was inserted.

Constructor Detail

MongoDbMessageStore

public MongoDbMessageStore(MongoDbFactory mongoDbFactory)

Create a MongoDbMessageStore using the provided MongoDbFactory.and the default collection name.

Parameters:

mongoDbFactory - The mongodb factory.

MongoDbMessageStore

public MongoDbMessageStore(MongoDbFactory mongoDbFactory,
                           String collectionName)

Create a MongoDbMessageStore using the provided MongoDbFactory and collection name.

Parameters:

mongoDbFactory - The mongodb factory.

collectionName - The collection name.

Method Detail

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

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.

getMessage

public Message<?> getMessage(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.

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.

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.

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.

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.

removeMessageFromGroup

@Deprecated
public MessageGroup removeMessageFromGroup(Object groupId,
                                                       Message<?> messageToRemove)

Deprecated.

Description copied from interface: MessageGroupStore

Persist the deletion of a single message from the group. The group is modified to reflect that 'messageToRemove' is no longer present in the group.

Specified by:

removeMessageFromGroup in interface MessageGroupStore

Parameters:

groupId - The groupId for the group containing the message.

messageToRemove - The message to be removed.

Returns:

The message Group.

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

Parameters:

groupId - The groupId for the group containing the message(s).

messages - The messages to be removed.

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.

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.

pollMessageFromGroup

public Message<?> pollMessageFromGroup(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.

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.

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.

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.

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.

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