Package org.springframework.integration.store

Class AbstractKeyValueMessageStore

java.lang.Object

org.springframework.integration.store.AbstractBatchingMessageGroupStore

org.springframework.integration.store.AbstractMessageGroupStore

org.springframework.integration.store.AbstractKeyValueMessageStore

All Implemented Interfaces:

Iterable<MessageGroup>, BasicMessageGroupStore, MessageGroupStore, MessageStore

Direct Known Subclasses:

HazelcastMessageStore, 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, Gary Russell, Artem Bilan, Ngoc Nhan, Youbin Wu

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.store.MessageGroupStore

MessageGroupStore.MessageGroupCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	MESSAGE_GROUP_KEY_PREFIX
protected static final String	MESSAGE_KEY_PREFIX

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

GROUP_ID_MUST_NOT_BE_NULL, INTERRUPTED_WHILE_OBTAINING_LOCK, logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractKeyValueMessageStore()
protected	AbstractKeyValueMessageStore(String prefix)	Construct an instance based on the provided prefix for keys to distinguish between different store instances in the same target key-value database.

Method Summary

Modifier and Type	Method	Description
<T> Message<T>	addMessage(Message<T> message)	Put the provided Message into the MessageStore.
protected void	doAddMessage(Message<?> message)
protected void	doAddMessage(Message<?> message, Object groupId)
protected void	doAddMessagesToGroup(Object groupId, Message<?>... messages)
protected void	doCompleteGroup(Object groupId)
protected abstract Collection<?>	doListKeys(String keyPattern)
protected Message<?>	doPollMessageFromGroup(Object groupId)
protected abstract Object	doRemove(Object id)
protected abstract void	doRemoveAll(Collection<Object> ids)
protected boolean	doRemoveMessageFromGroupById(Object groupId, UUID messageId)
protected void	doRemoveMessageGroup(Object groupId)	Remove the MessageGroup with the provided group ID.
protected void	doRemoveMessagesFromGroup(Object groupId, Collection<Message<?>> messages)
protected abstract Object	doRetrieve(Object id)
protected void	doSetGroupCondition(Object groupId, String condition)
protected void	doSetLastReleasedSequenceNumberForGroup(Object groupId, int sequenceNumber)
protected abstract void	doStore(Object id, Object objectToStore)
protected abstract void	doStoreIfAbsent(Object id, Object objectToStore)
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.
String	getGroupPrefix()	Return the configured prefix for message group keys to distinguish between different store instances in the same target key-value database.
Message<?>	getMessage(UUID messageId)
long	getMessageCount()	Optional attribute giving the number of messages in the store.
Message<?>	getMessageFromGroup(Object groupId, UUID messageId)	Retrieve a Message from a group by id.
MessageGroup	getMessageGroup(Object groupId)	Will create a new instance of SimpleMessageGroup if necessary.
MessageMetadata	getMessageMetadata(UUID messageId)	Return a MessageMetadata for the Message by provided id.
String	getMessagePrefix()	Return the configured prefix for message keys to distinguish between different store instances in the same target key-value database.
Collection<Message<?>>	getMessagesForGroup(Object groupId)	Retrieve messages for the provided group id.
Message<?>	getOneMessageFromGroup(Object groupId)	Return the one Message from MessageGroup.
Iterator<MessageGroup>	iterator()
int	messageGroupSize(Object groupId)	Return the size of this MessageGroup.
Message<?>	removeMessage(UUID id)	Remove the Message with the given id from the MessageStore, if present, and return it.
Stream<Message<?>>	streamMessagesForGroup(Object groupId)	Return a stream for messages stored in the provided group.

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

addMessagesToGroup, addMessageToGroup, completeGroup, copy, executeLocked, executeLocked, expireMessageGroups, getLockRegistry, getMessageCountForAllMessageGroups, getMessageGroupCount, getMessageGroupFactory, isTimeoutOnIdle, pollMessageFromGroup, registerMessageGroupExpiryCallback, removeMessageFromGroupById, removeMessageGroup, removeMessagesFromGroup, removeMessagesFromGroup, setExpiryCallbacks, setGroupCondition, setLastReleasedSequenceNumberForGroup, setLazyLoadMessageGroups, setLockRegistry, setTimeoutOnIdle

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 java.lang.Iterable

forEach, spliterator

Field Details

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

Constructor Details

AbstractKeyValueMessageStore

protected AbstractKeyValueMessageStore()

AbstractKeyValueMessageStore

protected AbstractKeyValueMessageStore(String prefix)

Construct an instance based on the provided prefix for keys to distinguish between different store instances in the same target key-value database. Defaults to an empty string - no prefix. The actual prefix for messages is prefix + MESSAGE_; for message groups - prefix + GROUP_OF_MESSAGES_

Parameters:

prefix - the prefix to use

Since:

4.3.12

Method Details

getMessagePrefix

public String getMessagePrefix()

Return the configured prefix for message keys to distinguish between different store instances in the same target key-value database. Defaults to the "MESSAGE_" - without a custom prefix.

Returns:

the prefix for keys

Since:

4.3.12

getGroupPrefix

public String getGroupPrefix()

Return the configured prefix for message group keys to distinguish between different store instances in the same target key-value database. Defaults to the "GROUP_OF_MESSAGES_" - without custom prefix.

Returns:

the prefix for keys

Since:

4.3.12

getMessage

public Message<?> getMessage(UUID messageId)

Specified by:

getMessage in interface MessageStore

Parameters:

messageId - The message identifier.

Returns:

The Message with the given id, or null if no Message with that id exists in the MessageStore.

getMessageMetadata

public MessageMetadata getMessageMetadata(UUID messageId)

Description copied from interface: MessageStore

Return a MessageMetadata for the Message by provided id.

Specified by:

getMessageMetadata in interface MessageStore

Parameters:

messageId - 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).

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.

doAddMessage

protected void doAddMessage(Message<?> message)

doAddMessage

protected void doAddMessage(Message<?> message,
 @Nullable
 Object groupId)

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. If this method is implemented on a MessageGroupStore, the message is removed from the store only if no groups holding this message.

Specified by:

removeMessage in interface MessageStore

Parameters:

id - the message identifier.

Returns:

the message (if any).

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.

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

Overrides:

getGroupMetadata in class AbstractMessageGroupStore

Parameters:

groupId - The group id.

Returns:

The metadata.

doAddMessagesToGroup

protected void doAddMessagesToGroup(Object groupId,
 Message<?>... messages)

Specified by:

doAddMessagesToGroup in class AbstractMessageGroupStore

doRemoveMessagesFromGroup

protected void doRemoveMessagesFromGroup(Object groupId,
 Collection<Message<?>> messages)

Specified by:

doRemoveMessagesFromGroup in class AbstractMessageGroupStore

getMessageFromGroup

@Nullable
public Message<?> getMessageFromGroup(Object groupId,
 UUID messageId)

Description copied from interface: MessageGroupStore

Retrieve a Message from a group by id. Return null if message does not belong to the requested group.

Specified by:

getMessageFromGroup in interface MessageGroupStore

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

protected boolean doRemoveMessageFromGroupById(Object groupId,
 UUID messageId)

Overrides:

doRemoveMessageFromGroupById in class AbstractMessageGroupStore

doCompleteGroup

protected void doCompleteGroup(Object groupId)

Specified by:

doCompleteGroup in class AbstractMessageGroupStore

doRemoveMessageGroup

protected void doRemoveMessageGroup(Object groupId)

Remove the MessageGroup with the provided group ID.

Specified by:

doRemoveMessageGroup in class AbstractMessageGroupStore

doSetGroupCondition

protected void doSetGroupCondition(Object groupId,
 String condition)

Specified by:

doSetGroupCondition in class AbstractMessageGroupStore

doSetLastReleasedSequenceNumberForGroup

protected void doSetLastReleasedSequenceNumberForGroup(Object groupId,
 int sequenceNumber)

Specified by:

doSetLastReleasedSequenceNumberForGroup in class AbstractMessageGroupStore

doPollMessageFromGroup

protected Message<?> doPollMessageFromGroup(Object groupId)

Specified by:

doPollMessageFromGroup in class AbstractMessageGroupStore

getOneMessageFromGroup

public Message<?> getOneMessageFromGroup(Object groupId)

Description copied from interface: MessageGroupStore

Return the one Message from MessageGroup.

Specified by:

getOneMessageFromGroup in interface MessageGroupStore

Parameters:

groupId - The group identifier.

Returns:

the Message.

getMessagesForGroup

public Collection<Message<?>> getMessagesForGroup(Object groupId)

Description copied from interface: MessageGroupStore

Retrieve messages for the provided group id.

Specified by:

getMessagesForGroup in interface MessageGroupStore

Parameters:

groupId - The group id to retrieve messages for.

Returns:

the messages for group.

streamMessagesForGroup

public Stream<Message<?>> streamMessagesForGroup(Object groupId)

Description copied from interface: MessageGroupStore

Return a stream for messages stored in the provided group. The persistent implementations return a Stream which has to be closed once fully processed (e.g. through a try-with-resources clause). By default, it streams a result of MessageGroupStore.getMessagesForGroup(Object).

Specified by:

streamMessagesForGroup in interface MessageGroupStore

Parameters:

groupId - the group id to retrieve messages.

Returns:

the Stream for messages in this group.

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

Return 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)

doStoreIfAbsent

protected abstract void doStoreIfAbsent(Object id,
 Object objectToStore)

doRemove

protected abstract Object doRemove(Object id)

doRemoveAll

protected abstract void doRemoveAll(Collection<Object> ids)

doListKeys

protected abstract Collection<?> doListKeys(String keyPattern)