org.springframework.integration.mongodb.store

Class ConfigurableMongoDbMessageStore

java.lang.Object

org.springframework.integration.mongodb.store.AbstractConfigurableMongoDbMessageStore

org.springframework.integration.mongodb.store.ConfigurableMongoDbMessageStore

All Implemented Interfaces:

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

public class ConfigurableMongoDbMessageStore
extends AbstractConfigurableMongoDbMessageStore
implements MessageStore, MessageGroupStore, Iterable<MessageGroup>

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

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	DEFAULT_COLLECTION_NAME

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

applicationContext, collectionName, CREATED_DATE_KEY, logger, mappingMongoConverter, messageBuilderFactory, mongoDbFactory, mongoTemplate, SAVED_KEY, SEQUENCE_NAME

Constructor Summary

Constructors

Constructor and Description
ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory)
ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter)
ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory, MappingMongoConverter mappingMongoConverter, String collectionName)
ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory, String collectionName)
ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate)
ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate, String collectionName)

Method Summary

Methods

Modifier and Type	Method and Description
<T> Message<T>	addMessage(Message<T> message) Put the provided Message into the MessageStore.
MessageGroup	addMessageToGroup(Object groupId, Message<?> message) Store a message with an association to a group id.
void	completeGroup(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.
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.
boolean	isTimeoutOnIdle()
Iterator<MessageGroup>	iterator()
Message<?>	pollMessageFromGroup(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).
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) Persist a deletion on a single message from the group.
void	setExpiryCallbacks(Collection<MessageGroupStore.MessageGroupCallback> expiryCallbacks) Convenient injection point for expiry callbacks in the message store.
void	setLastReleasedSequenceNumberForGroup(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.

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

addMessageDocument, afterPropertiesSet, getMessage, getNextId, groupIdQuery, messageGroupSize, removeMessageGroup, setApplicationContext

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.MessageStore

getMessage

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

messageGroupSize, removeMessageGroup

Field Detail

DEFAULT_COLLECTION_NAME

public static final String DEFAULT_COLLECTION_NAME

See Also:

Constant Field Values

Constructor Detail

ConfigurableMongoDbMessageStore

public ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate)

ConfigurableMongoDbMessageStore

public ConfigurableMongoDbMessageStore(MongoTemplate mongoTemplate,
                               String collectionName)

ConfigurableMongoDbMessageStore

public ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory)

ConfigurableMongoDbMessageStore

public ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory,
                               MappingMongoConverter mappingMongoConverter)

ConfigurableMongoDbMessageStore

public ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory,
                               String collectionName)

ConfigurableMongoDbMessageStore

public ConfigurableMongoDbMessageStore(MongoDbFactory mongoDbFactory,
                               MappingMongoConverter mappingMongoConverter,
                               String collectionName)

Method Detail

setExpiryCallbacks

public void setExpiryCallbacks(Collection<MessageGroupStore.MessageGroupCallback> expiryCallbacks)

Convenient injection point for expiry callbacks in the message store. Each of the callbacks provided will simply be registered with the store using MessageGroupStore.registerMessageGroupExpiryCallback(MessageGroupCallback).

Parameters:

expiryCallbacks - the expiry callbacks to add

isTimeoutOnIdle

public boolean isTimeoutOnIdle()

setTimeoutOnIdle

public void setTimeoutOnIdle(boolean timeoutOnIdle)

Allows you to override the rule for the timeout calculation. Typical timeout is based from the time the 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'.

Parameters:

timeoutOnIdle - The boolean.

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

Parameters:

groupId - The group id to store the message under.

message - A message.

Returns:

The message group.

removeMessageFromGroup

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

Description copied from interface: MessageGroupStore

Persist a deletion on 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.

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.

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.

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.

registerMessageGroupExpiryCallback

public void registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback)

Description copied from interface: MessageGroupStore

Register a callback for when a message group is expired through MessageGroupStore.expireMessageGroups(long).

Specified by:

registerMessageGroupExpiryCallback in interface MessageGroupStore

Parameters:

callback - A callback to execute when a message group is cleaned up.

expireMessageGroups

public int expireMessageGroups(long timeout)

Description copied from interface: MessageGroupStore

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. For example: call with a timeout of 100 to expire all groups that were created more than 100 milliseconds ago, and are not yet complete. Use a timeout of 0 (or negative to be on the safe side) to expire all message groups.

Specified by:

expireMessageGroups in interface MessageGroupStore

Parameters:

timeout - the timeout threshold to use

Returns:

the number of message groups expired

See Also:

MessageGroupStore.registerMessageGroupExpiryCallback(MessageGroupCallback)

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

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

Returns:

the number message groups