Class RedisMessageStore

java.lang.Object

org.springframework.integration.store.AbstractBatchingMessageGroupStore

org.springframework.integration.store.AbstractMessageGroupStore

org.springframework.integration.store.AbstractKeyValueMessageStore

org.springframework.integration.redis.store.RedisMessageStore

All Implemented Interfaces:

Iterable<MessageGroup>, Aware, BeanClassLoaderAware, IntegrationPattern, BasicMessageGroupStore, MessageGroupStore, MessageStore

public class RedisMessageStore
extends AbstractKeyValueMessageStore
implements BeanClassLoaderAware

Redis implementation of the key/value style MessageStore and MessageGroupStore

Since:

2.1

Author:

Oleg Zhurakousky, Gary Russell, Artem Bilan, Michal Domagala, Yordan Tsintsov

Nested Class Summary

Nested classes/interfaces inherited from interface MessageGroupStore

MessageGroupStore.MessageGroupCallback

Field Summary

Fields inherited from class AbstractKeyValueMessageStore

MESSAGE_GROUP_KEY_PREFIX, MESSAGE_KEY_PREFIX

Fields inherited from class AbstractMessageGroupStore

INTERRUPTED_WHILE_OBTAINING_LOCK, logger

Constructor Summary

Constructors

Constructor	Description
RedisMessageStore(RedisConnectionFactory connectionFactory)	Construct RedisMessageStore based on the provided RedisConnectionFactory and default empty prefix.
RedisMessageStore(RedisConnectionFactory connectionFactory, String prefix)	Construct RedisMessageStore based on the provided RedisConnectionFactory and prefix.

Method Summary

Modifier and Type	Method	Description
protected Collection<?>	doListKeys(String keyPattern)
protected @Nullable Object	doRemove(Object id)
protected void	doRemoveAll(Collection<Object> ids)
protected @Nullable Object	doRetrieve(Object id)
protected void	doStore(Object id, Object objectToStore)
protected void	doStoreIfAbsent(Object id, Object objectToStore)
void	setBeanClassLoader(ClassLoader classLoader)
void	setUseUnlink(boolean useUnlink)	Configure the deletion strategy used when removing messages from the store.
void	setValueSerializer(RedisSerializer<?> valueSerializer)

Methods inherited from class AbstractKeyValueMessageStore

addMessage, doAddMessage, doAddMessage, doAddMessagesToGroup, doCompleteGroup, doPollMessageFromGroup, doRemoveMessageFromGroupById, doRemoveMessageGroup, doRemoveMessagesFromGroup, doSetGroupCondition, doSetLastReleasedSequenceNumberForGroup, getGroupMetadata, getGroupPrefix, getMessage, getMessageCount, getMessageFromGroup, getMessageGroup, getMessageMetadata, getMessagePrefix, getMessagesForGroup, getOneMessageFromGroup, iterator, messageGroupSize, removeMessage, streamMessagesForGroup

Methods inherited from class 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 AbstractBatchingMessageGroupStore

getRemoveBatchSize, setMessageGroupFactory, setRemoveBatchSize

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface MessageStore

getIntegrationPatternType

Constructor Details

RedisMessageStore

public RedisMessageStore(RedisConnectionFactory connectionFactory)

Construct RedisMessageStore based on the provided RedisConnectionFactory and default empty prefix.

Parameters:

connectionFactory - the RedisConnectionFactory to use

RedisMessageStore

public RedisMessageStore(RedisConnectionFactory connectionFactory,
 String prefix)

Construct RedisMessageStore based on the provided RedisConnectionFactory and prefix.

Parameters:

connectionFactory - the RedisConnectionFactory to use

prefix - the key prefix to use, allowing the same broker to be used for multiple stores.

Since:

4.3.12

See Also:

• AbstractKeyValueMessageStore(String)

Method Details

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setValueSerializer

public void setValueSerializer(RedisSerializer<?> valueSerializer)

setUseUnlink

public void setUseUnlink(boolean useUnlink)

Configure the deletion strategy used when removing messages from the store.

By default (false), the store uses the Redis GETDEL command (since Redis 6.2).

When set to true, the store uses GET + UNLINK.

Consider enabling this option when:

• Stored messages are large, and blocking deletes cause noticeable Redis latency
• Atomicity between get and delete is not required for your use case

Note: For small values, Redis may perform synchronous deletion even with UNLINK, so the benefit is primarily for larger payloads.

Parameters:

useUnlink - param to set deletion strategy.

Since:

7.1

See Also:

• GETDEL command
• UNLINK command

doRetrieve

protected @Nullable Object doRetrieve(Object id)

Specified by:

doRetrieve in class AbstractKeyValueMessageStore

doStore

protected void doStore(Object id,
 Object objectToStore)

Specified by:

doStore in class AbstractKeyValueMessageStore

doStoreIfAbsent

protected void doStoreIfAbsent(Object id,
 Object objectToStore)

Specified by:

doStoreIfAbsent in class AbstractKeyValueMessageStore

doRemove

protected @Nullable Object doRemove(Object id)

Specified by:

doRemove in class AbstractKeyValueMessageStore

doRemoveAll

protected void doRemoveAll(Collection<Object> ids)

Specified by:

doRemoveAll in class AbstractKeyValueMessageStore

doListKeys

protected Collection<?> doListKeys(String keyPattern)

Specified by:

doListKeys in class AbstractKeyValueMessageStore