org.springframework.integration.store

Interface MessageGroupStore

All Superinterfaces:

BasicMessageGroupStore

All Known Implementing Classes:

AbstractConfigurableMongoDbMessageStore, AbstractKeyValueMessageStore, AbstractMessageGroupStore, ConfigurableMongoDbMessageStore, GemfireMessageStore, JdbcMessageStore, MongoDbChannelMessageStore, MongoDbMessageStore, RedisMessageStore, SimpleMessageStore

public interface MessageGroupStore
extends BasicMessageGroupStore

Defines additional storage operations on groups of messages linked by a group id.

Since:

2.0

Author:

Dave Syer, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageGroupStore.MessageGroupCallback Invoked when a MessageGroupStore expires a group.

Method Summary

Modifier and Type	Method and Description
void	addMessagesToGroup(java.lang.Object groupId, org.springframework.messaging.Message<?>... messages) Store messages with an association to a group id.
void	completeGroup(java.lang.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.
MessageGroupMetadata	getGroupMetadata(java.lang.Object groupId) Obtain the group metadata without fetching any messages; must supply all other group properties; may include the id of the first message.
int	getMessageCountForAllMessageGroups() Optional attribute giving the number of messages in the store over all groups.
int	getMessageGroupCount() Optional attribute giving the number of message groups.
java.util.Collection<org.springframework.messaging.Message<?>>	getMessagesForGroup(java.lang.Object groupId) Retrieve messages for the provided group id.
org.springframework.messaging.Message<?>	getOneMessageFromGroup(java.lang.Object groupId) Return the one Message from MessageGroup.
java.util.Iterator<MessageGroup>	iterator()
void	registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback) Register a callback for when a message group is expired through expireMessageGroups(long).
MessageGroup	removeMessageFromGroup(java.lang.Object key, org.springframework.messaging.Message<?> messageToRemove) Deprecated. in favor of removeMessagesFromGroup(java.lang.Object, java.util.Collection<org.springframework.messaging.Message<?>>)
void	removeMessagesFromGroup(java.lang.Object key, java.util.Collection<org.springframework.messaging.Message<?>> messages) Persist the deletion of messages from the group.
void	removeMessagesFromGroup(java.lang.Object key, org.springframework.messaging.Message<?>... messages) Persist the deletion of messages from the group.
void	setLastReleasedSequenceNumberForGroup(java.lang.Object groupId, int sequenceNumber) Allows you to set the sequence number of the last released Message.

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

addMessageToGroup, getMessageGroup, messageGroupSize, pollMessageFromGroup, removeMessageGroup

Method Detail

getMessageCountForAllMessageGroups

@ManagedAttribute
int getMessageCountForAllMessageGroups()

Optional attribute giving the number of messages in the store over all groups. Implementations may decline to respond by throwing an exception.

Returns:

the number of messages

Throws:

java.lang.UnsupportedOperationException - if not implemented

getMessageGroupCount

@ManagedAttribute
int getMessageGroupCount()

Optional attribute giving the number of message groups. Implementations may decline to respond by throwing an exception.

Returns:

the number message groups

Throws:

java.lang.UnsupportedOperationException - if not implemented

removeMessageFromGroup

@Deprecated
MessageGroup removeMessageFromGroup(java.lang.Object key,
                                                org.springframework.messaging.Message<?> messageToRemove)

Deprecated. in favor of removeMessagesFromGroup(java.lang.Object, java.util.Collection<org.springframework.messaging.Message<?>>)

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.

Parameters:

key - The groupId for the group containing the message.

messageToRemove - The message to be removed.

Returns:

The message Group.

removeMessagesFromGroup

void removeMessagesFromGroup(java.lang.Object key,
                             java.util.Collection<org.springframework.messaging.Message<?>> messages)

Persist the deletion of messages from the group.

Parameters:

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

messages - The messages to be removed.

Since:

4.2

removeMessagesFromGroup

void removeMessagesFromGroup(java.lang.Object key,
                             org.springframework.messaging.Message<?>... messages)

Persist the deletion of messages from the group.

Parameters:

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

messages - The messages to be removed.

Since:

4.2

registerMessageGroupExpiryCallback

void registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback)

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

Parameters:

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

expireMessageGroups

@ManagedOperation
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. 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.

Parameters:

timeout - the timeout threshold to use

Returns:

the number of message groups expired

See Also:

registerMessageGroupExpiryCallback(MessageGroupCallback)

setLastReleasedSequenceNumberForGroup

void setLastReleasedSequenceNumberForGroup(java.lang.Object groupId,
                                           int sequenceNumber)

Allows you to set the sequence number of the last released Message. Used for Resequencing use cases

Parameters:

groupId - The group identifier.

sequenceNumber - The sequence number.

iterator

java.util.Iterator<MessageGroup> iterator()

Returns:

The iterator of currently accumulated MessageGroups.

completeGroup

void completeGroup(java.lang.Object groupId)

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.

Parameters:

groupId - The group identifier.

getGroupMetadata

MessageGroupMetadata getGroupMetadata(java.lang.Object groupId)

Obtain the group metadata without fetching any messages; must supply all other group properties; may include the id of the first message.

Parameters:

groupId - The group id.

Returns:

The metadata.

Since:

4.0

getOneMessageFromGroup

org.springframework.messaging.Message<?> getOneMessageFromGroup(java.lang.Object groupId)

Return the one Message from MessageGroup.

Parameters:

groupId - The group identifier.

Returns:

the Message.

Since:

4.0

addMessagesToGroup

void addMessagesToGroup(java.lang.Object groupId,
                        org.springframework.messaging.Message<?>... messages)

Store messages with an association to a group id. This can be used to group messages together.

Parameters:

groupId - The group id to store messages under.

messages - The messages to add.

Since:

4.3

getMessagesForGroup

java.util.Collection<org.springframework.messaging.Message<?>> getMessagesForGroup(java.lang.Object groupId)

Retrieve messages for the provided group id.

Parameters:

groupId - The group id to retrieve messages for.

Returns:

the messages for group.

Since:

4.3