org.springframework.integration.store

Class AbstractMessageGroupStore

java.lang.Object

org.springframework.integration.store.AbstractBatchingMessageGroupStore

org.springframework.integration.store.AbstractMessageGroupStore

All Implemented Interfaces:

Iterable<MessageGroup>, BasicMessageGroupStore, MessageGroupStore

Direct Known Subclasses:

AbstractConfigurableMongoDbMessageStore, AbstractKeyValueMessageStore, JdbcMessageStore, MongoDbMessageStore, SimpleMessageStore

@ManagedResource
public abstract class AbstractMessageGroupStore
extends AbstractBatchingMessageGroupStore
implements MessageGroupStore, Iterable<MessageGroup>

Since:

2.0

Author:

Dave Syer, Oleg Zhurakousky, 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
protected Log	logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessageGroupStore()
protected	AbstractMessageGroupStore(boolean lazyLoadMessageGroups)

Method Summary

Modifier and Type	Method and Description
MessageGroup	addMessageToGroup(Object groupId, Message<?> message) Store a message with an association to a group id.
protected MessageGroup	copy(MessageGroup group) Used by expireMessageGroups.
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(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.
protected MessageGroupFactory	getMessageGroupFactory()
boolean	isTimeoutOnIdle()
void	registerMessageGroupExpiryCallback(MessageGroupStore.MessageGroupCallback callback) Register a callback for when a message group is expired through MessageGroupStore.expireMessageGroups(long).
void	removeMessagesFromGroup(Object key, Message<?>... messages) Persist the deletion of messages from the group.
void	setExpiryCallbacks(Collection<MessageGroupStore.MessageGroupCallback> expiryCallbacks) Convenient injection point for expiry callbacks in the message store.
void	setLazyLoadMessageGroups(boolean lazyLoadMessageGroups) Specify if the result of the BasicMessageGroupStore.getMessageGroup(Object) should be wrapped to the PersistentMessageGroup - a lazy-load proxy for messages in group Defaults to true.
void	setTimeoutOnIdle(boolean timeoutOnIdle) Allows you to override the rule for the timeout calculation.

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

addMessagesToGroup, completeGroup, getMessagesForGroup, getOneMessageFromGroup, iterator, removeMessagesFromGroup, setLastReleasedSequenceNumberForGroup

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

getMessageGroup, messageGroupSize, pollMessageFromGroup, removeMessageGroup

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

logger

protected final Log logger

Constructor Detail

AbstractMessageGroupStore

protected AbstractMessageGroupStore()

AbstractMessageGroupStore

protected AbstractMessageGroupStore(boolean lazyLoadMessageGroups)

Method Detail

getMessageGroupFactory

protected MessageGroupFactory getMessageGroupFactory()

Overrides:

getMessageGroupFactory in class AbstractBatchingMessageGroupStore

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.

setLazyLoadMessageGroups

public void setLazyLoadMessageGroups(boolean lazyLoadMessageGroups)

Specify if the result of the BasicMessageGroupStore.getMessageGroup(Object) should be wrapped to the PersistentMessageGroup - a lazy-load proxy for messages in group Defaults to true.

The target logic is based on the SimpleMessageGroupFactory.GroupType.PERSISTENT.

Parameters:

lazyLoadMessageGroups - the boolean flag to use.

Since:

4.3

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

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

copy

protected MessageGroup copy(MessageGroup group)

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

Parameters:

group - The group.

Returns:

The group, or a copy.

Since:

4.0.1

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

getGroupMetadata

public MessageGroupMetadata getGroupMetadata(Object groupId)

Description copied from interface: MessageGroupStore

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

Specified by:

getGroupMetadata in interface MessageGroupStore

Parameters:

groupId - The group id.

Returns:

The metadata.

removeMessagesFromGroup

public void removeMessagesFromGroup(Object key,
                                    Message<?>... messages)

Description copied from interface: MessageGroupStore

Persist the deletion of messages from the group.

Specified by:

removeMessagesFromGroup in interface MessageGroupStore

Parameters:

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

messages - The messages to be removed.

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.