org.springframework.integration.store

Class AbstractKeyValueMessageStore

java.lang.Object

org.springframework.integration.store.AbstractMessageGroupStore

org.springframework.integration.store.AbstractKeyValueMessageStore

All Implemented Interfaces:

Iterable<MessageGroup>, Aware, BeanFactoryAware, BasicMessageGroupStore, MessageGroupStore, MessageStore

Direct Known Subclasses:

GemfireMessageStore, RedisMessageStore

public abstract class AbstractKeyValueMessageStore
extends AbstractMessageGroupStore
implements MessageStore

Base class for implementations of Key/Value style MessageGroupStore and MessageStore

Since:

2.1

Author:

Oleg Zhurakousky

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 static String	CREATED_DATE
protected static String	MESSAGE_GROUP_KEY_PREFIX
protected static String	MESSAGE_KEY_PREFIX

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

logger

Constructor Summary

Constructors

Constructor and Description
AbstractKeyValueMessageStore()

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) Add a Message to the group with the provided group ID.
void	completeGroup(Object groupId) Completes this MessageGroup.
protected abstract Collection<?>	doListKeys(String keyPattern)
protected abstract Object	doRemove(Object id)
protected abstract Object	doRetrieve(Object id)
protected abstract void	doStore(Object id, Object objectToStore)
Message<?>	getMessage(UUID id)
long	getMessageCount() Optional attribute giving the number of messages in the store.
MessageGroup	getMessageGroup(Object groupId) Will create a new instance of SimpleMessageGroup if necessary.
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) Remove a Message from the group with the provided group ID.
void	removeMessageGroup(Object groupId) Remove the MessageGroup with the provided group ID.
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

expireMessageGroups, getMessageBuilderFactory, getMessageCountForAllMessageGroups, getMessageGroupCount, isTimeoutOnIdle, registerMessageGroupExpiryCallback, setBeanFactory, setExpiryCallbacks, setTimeoutOnIdle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGE_KEY_PREFIX

protected static final String MESSAGE_KEY_PREFIX

See Also:

Constant Field Values

MESSAGE_GROUP_KEY_PREFIX

protected static final String MESSAGE_GROUP_KEY_PREFIX

See Also:

Constant Field Values

CREATED_DATE

protected static final String CREATED_DATE

See Also:

Constant Field Values

Constructor Detail

AbstractKeyValueMessageStore

public AbstractKeyValueMessageStore()

Method Detail

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.

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

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

getMessageGroup

public MessageGroup getMessageGroup(Object groupId)

Will create a new instance of SimpleMessageGroup if necessary.

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)

Add a Message to the group with the provided group ID.

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)

Remove a Message from the group with the provided group ID.

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.

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.

removeMessageGroup

public void removeMessageGroup(Object groupId)

Remove the MessageGroup with the provided group ID.

Specified by:

removeMessageGroup in interface BasicMessageGroupStore

Parameters:

groupId - The id of the group to remove.

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.

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.

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.

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.

doRetrieve

protected abstract Object doRetrieve(Object id)

doStore

protected abstract void doStore(Object id,
           Object objectToStore)

doRemove

protected abstract Object doRemove(Object id)

doListKeys

protected abstract Collection<?> doListKeys(String keyPattern)