Class SimpleMessageStore
java.lang.Object
org.springframework.integration.store.AbstractBatchingMessageGroupStore
org.springframework.integration.store.AbstractMessageGroupStore
org.springframework.integration.store.SimpleMessageStore
- All Implemented Interfaces:
Iterable<MessageGroup>,BasicMessageGroupStore,ChannelMessageStore,MessageGroupStore,MessageStore
public class SimpleMessageStore
extends AbstractMessageGroupStore
implements MessageStore, ChannelMessageStore
Map-based in-memory implementation of
MessageStore and MessageGroupStore.
Enforces a maximum capacity for the store.- Since:
- 2.0
- Author:
- Iwein Fuld, Mark Fisher, Dave Syer, Oleg Zhurakousky, Gary Russell, Ryan Barker, Artem Bilan, Youbin Wu
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.integration.store.MessageGroupStore
MessageGroupStore.MessageGroupCallback -
Field Summary
Fields inherited from class org.springframework.integration.store.AbstractMessageGroupStore
INTERRUPTED_WHILE_OBTAINING_LOCK, logger -
Constructor Summary
ConstructorsConstructorDescriptionCreate a SimpleMessageStore with unlimited capacity.SimpleMessageStore(int capacity) Creates a SimpleMessageStore with the same capacity for individual and grouped messages.SimpleMessageStore(int individualCapacity, int groupCapacity) Creates a SimpleMessageStore with a maximum size limited by the given capacity, or unlimited size if the given capacity is less than 1.SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout) Create a SimpleMessageStore with a maximum size limited by the given capacity and the timeout in millisecond to wait for the empty slot in the store.SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout, LockRegistry<?> lockRegistry) Creates a SimpleMessageStore with a maximum size limited by the given capacity, the timeout in millisecond to wait for the empty slot in the store and LockRegistry for the message group operations concurrency.SimpleMessageStore(int individualCapacity, int groupCapacity, LockRegistry<?> lockRegistry) Creates a SimpleMessageStore with a maximum size limited by the given capacity and LockRegistry for the message group operations concurrency. -
Method Summary
Modifier and TypeMethodDescription<T> Message<T> addMessage(Message<T> message) Put the provided Message into the MessageStore.voidaddMessagesToGroup(Object groupId, Message<?>... messages) Store messages with an association to a group id.voidclearMessageGroup(Object groupId) protected MessageGroupcopy(MessageGroup group) Used by expireMessageGroups.protected voiddoAddMessagesToGroup(Object groupId, Message<?>... messages) protected voiddoCompleteGroup(Object groupId) protected @Nullable Message<?> doPollMessageFromGroup(Object groupId) protected booleandoRemoveMessageFromGroupById(Object groupId, UUID messageId) protected voiddoRemoveMessageGroup(Object groupId) protected voiddoRemoveMessagesFromGroup(Object groupId, Collection<Message<?>> messages) protected voiddoSetGroupCondition(Object groupId, String condition) protected voiddoSetLastReleasedSequenceNumberForGroup(Object groupId, int sequenceNumber) getGroupMetadata(Object groupId) Obtain the group metadata without fetching any messages; must supply all other group properties; may include the id of the first message.@Nullable Message<?> getMessage(UUID key) longOptional attribute giving the number of messages in the store.@Nullable Message<?> getMessageFromGroup(Object groupId, UUID messageId) Retrieve aMessagefrom a group by id.getMessageGroup(Object groupId) Return all Messages currently in the MessageStore that were stored usingBasicMessageGroupStore.addMessageToGroup(Object, Message)with this group id.@Nullable MessageMetadataCollection<Message<?>> getMessagesForGroup(Object groupId) Retrieve messages for the provided group id.@Nullable Message<?> getOneMessageFromGroup(Object groupId) Return the oneMessagefromMessageGroup.iterator()intmessageGroupSize(Object groupId) Return the size of this MessageGroup.@Nullable Message<?> removeMessage(UUID key) Remove the Message with the given id from the MessageStore, if present, and return it.voidsetCopyOnGet(boolean copyOnGet) Set as false to disable copying the group ingetMessageGroup(Object).voidsetLazyLoadMessageGroups(boolean lazyLoadMessageGroups) Specify if the result of theBasicMessageGroupStore.getMessageGroup(Object)should be wrapped to thePersistentMessageGroup- a lazy-load proxy for messages in group Defaults totrue.Methods inherited from class org.springframework.integration.store.AbstractMessageGroupStore
addMessageToGroup, completeGroup, executeLocked, executeLocked, expireMessageGroups, getLockRegistry, getMessageCountForAllMessageGroups, getMessageGroupCount, getMessageGroupFactory, isTimeoutOnIdle, pollMessageFromGroup, registerMessageGroupExpiryCallback, removeMessageFromGroupById, removeMessageGroup, removeMessagesFromGroup, removeMessagesFromGroup, setExpiryCallbacks, setGroupCondition, setLastReleasedSequenceNumberForGroup, setLockRegistry, setTimeoutOnIdleMethods inherited from class org.springframework.integration.store.AbstractBatchingMessageGroupStore
getRemoveBatchSize, setMessageGroupFactory, setRemoveBatchSizeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.springframework.integration.store.BasicMessageGroupStore
addMessageToGroup, pollMessageFromGroup, removeMessageGroupMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.springframework.integration.store.MessageGroupStore
streamMessagesForGroup
-
Constructor Details
-
SimpleMessageStore
public SimpleMessageStore(int individualCapacity, int groupCapacity) Creates a SimpleMessageStore with a maximum size limited by the given capacity, or unlimited size if the given capacity is less than 1. The capacities are applied independently to messages stored viaaddMessage(Message)and to those stored viaAbstractMessageGroupStore.addMessageToGroup(Object, Message). In both cases the capacity applies to the number of messages that can be stored, and once that limit is reached attempting to store another will result in an exception.- Parameters:
individualCapacity- The message capacity.groupCapacity- The capacity of each group.
-
SimpleMessageStore
public SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout) Create a SimpleMessageStore with a maximum size limited by the given capacity and the timeout in millisecond to wait for the empty slot in the store.- Parameters:
individualCapacity- The message capacity.groupCapacity- The capacity of each group.upperBoundTimeout- The time to wait if the store is at max capacity.- Since:
- 4.3
- See Also:
-
SimpleMessageStore
Creates a SimpleMessageStore with a maximum size limited by the given capacity and LockRegistry for the message group operations concurrency.- Parameters:
individualCapacity- The message capacity.groupCapacity- The capacity of each group.lockRegistry- The lock registry.- See Also:
-
SimpleMessageStore
public SimpleMessageStore(int individualCapacity, int groupCapacity, long upperBoundTimeout, LockRegistry<?> lockRegistry) Creates a SimpleMessageStore with a maximum size limited by the given capacity, the timeout in millisecond to wait for the empty slot in the store and LockRegistry for the message group operations concurrency.- Parameters:
individualCapacity- The message capacity.groupCapacity- The capacity of each group.upperBoundTimeout- The time to wait if the store is at max capacitylockRegistry- The lock registry.- Since:
- 4.3
-
SimpleMessageStore
public SimpleMessageStore(int capacity) Creates a SimpleMessageStore with the same capacity for individual and grouped messages.- Parameters:
capacity- The capacity.
-
SimpleMessageStore
public SimpleMessageStore()Create a SimpleMessageStore with unlimited capacity.
-
-
Method Details
-
setCopyOnGet
public void setCopyOnGet(boolean copyOnGet) Set as false to disable copying the group ingetMessageGroup(Object). Starting with 4.1, this is false by default.- Parameters:
copyOnGet- True to copy, false to not.- Since:
- 4.0.1
-
setLazyLoadMessageGroups
public void setLazyLoadMessageGroups(boolean lazyLoadMessageGroups) Description copied from class:AbstractMessageGroupStoreSpecify if the result of theBasicMessageGroupStore.getMessageGroup(Object)should be wrapped to thePersistentMessageGroup- a lazy-load proxy for messages in group Defaults totrue.The target logic is based on the
SimpleMessageGroupFactory.GroupType.PERSISTENT.- Overrides:
setLazyLoadMessageGroupsin classAbstractMessageGroupStore- Parameters:
lazyLoadMessageGroups- thebooleanflag to use.
-
getMessageCount
Description copied from interface:MessageStoreOptional attribute giving the number of messages in the store. Implementations may decline to respond by throwing an exception.- Specified by:
getMessageCountin interfaceMessageStore- Returns:
- The number of messages.
-
addMessage
Description copied from interface:MessageStorePut the provided Message into the MessageStore. The store may need to mutate the message internally, and if it does then the returned value can be different from the input. The id of the return value will be used as an index so that theMessageStore.getMessage(UUID)andMessageStore.removeMessage(UUID)behave properly. Since messages are immutable, putting the same message more than once is a no-op.- Specified by:
addMessagein interfaceMessageStore- Type Parameters:
T- The payload type.- Parameters:
message- The message.- Returns:
- The message that was stored.
-
getMessage
- Specified by:
getMessagein interfaceMessageStore- Parameters:
key- The message identifier.- Returns:
- The Message with the given id, or null if no Message with that id exists in the MessageStore.
-
getMessageMetadata
Description copied from interface:MessageStore- Specified by:
getMessageMetadatain interfaceMessageStore- Parameters:
id- The message identifier.- Returns:
- The MessageMetadata with the given id, or null if no Message with that id exists in the MessageStore or the message has no metadata (legacy message from an earlier version).
-
removeMessage
Description copied from interface:MessageStoreRemove 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 returnnull. If this method is implemented on aMessageGroupStore, the message is removed from the store only if no groups holding this message.- Specified by:
removeMessagein interfaceMessageStore- Parameters:
key- the message identifier.- Returns:
- the message (if any).
-
getMessageGroup
Description copied from interface:BasicMessageGroupStoreReturn all Messages currently in the MessageStore that were stored usingBasicMessageGroupStore.addMessageToGroup(Object, Message)with this group id.- Specified by:
getMessageGroupin interfaceBasicMessageGroupStore- Parameters:
groupId- The group identifier.- Returns:
- A group of messages, empty if none exists for this key.
-
copy
Description copied from class:AbstractMessageGroupStoreUsed by expireMessageGroups. We need to return a snapshot of the group at the time the reaper runs, so we can properly detect if the group changed between now and the attempt to expire the group. Not necessary for persistent stores, so the default behavior is to just return the group.- Overrides:
copyin classAbstractMessageGroupStore- Parameters:
group- The group.- Returns:
- The group, or a copy.
-
addMessagesToGroup
Description copied from interface:MessageGroupStoreStore messages with an association to a group id. This can be used to group messages together.- Specified by:
addMessagesToGroupin interfaceMessageGroupStore- Overrides:
addMessagesToGroupin classAbstractMessageGroupStore- Parameters:
groupId- The group id to store messages under.messages- The messages to add.
-
doAddMessagesToGroup
- Specified by:
doAddMessagesToGroupin classAbstractMessageGroupStore
-
doRemoveMessageGroup
- Specified by:
doRemoveMessageGroupin classAbstractMessageGroupStore
-
doRemoveMessagesFromGroup
- Specified by:
doRemoveMessagesFromGroupin classAbstractMessageGroupStore
-
getMessageFromGroup
Description copied from interface:MessageGroupStoreRetrieve aMessagefrom a group by id. Returnnullif message does not belong to the requested group.- Specified by:
getMessageFromGroupin interfaceMessageGroupStore- Parameters:
groupId- The groupId for the group containing the message.messageId- The message id.- Returns:
- message by id if it belongs to requested group.
-
doRemoveMessageFromGroupById
- Overrides:
doRemoveMessageFromGroupByIdin classAbstractMessageGroupStore
-
iterator
- Specified by:
iteratorin interfaceIterable<MessageGroup>- Specified by:
iteratorin interfaceMessageGroupStore- Returns:
- The iterator of currently accumulated
MessageGroups.
-
doSetGroupCondition
- Specified by:
doSetGroupConditionin classAbstractMessageGroupStore
-
doSetLastReleasedSequenceNumberForGroup
- Specified by:
doSetLastReleasedSequenceNumberForGroupin classAbstractMessageGroupStore
-
doCompleteGroup
- Specified by:
doCompleteGroupin classAbstractMessageGroupStore
-
doPollMessageFromGroup
- Specified by:
doPollMessageFromGroupin classAbstractMessageGroupStore
-
messageGroupSize
Description copied from interface:BasicMessageGroupStoreReturn the size of this MessageGroup.- Specified by:
messageGroupSizein interfaceBasicMessageGroupStore- Parameters:
groupId- The group identifier.- Returns:
- The size.
-
getGroupMetadata
Description copied from interface:MessageGroupStoreObtain the group metadata without fetching any messages; must supply all other group properties; may include the id of the first message.- Specified by:
getGroupMetadatain interfaceMessageGroupStore- Parameters:
groupId- The group id.- Returns:
- The metadata.
-
getOneMessageFromGroup
Description copied from interface:MessageGroupStoreReturn the oneMessagefromMessageGroup.- Specified by:
getOneMessageFromGroupin interfaceMessageGroupStore- Parameters:
groupId- The group identifier.- Returns:
- the
Message.
-
getMessagesForGroup
Description copied from interface:MessageGroupStoreRetrieve messages for the provided group id.- Specified by:
getMessagesForGroupin interfaceMessageGroupStore- Parameters:
groupId- The group id to retrieve messages for.- Returns:
- the messages for group.
-
clearMessageGroup
-