org.springframework.integration.redis.store

Class RedisChannelMessageStore

java.lang.Object

org.springframework.integration.redis.store.RedisChannelMessageStore

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanNameAware, InitializingBean, BasicMessageGroupStore, ChannelMessageStore

Direct Known Subclasses:

RedisChannelPriorityMessageStore

public class RedisChannelMessageStore
extends Object
implements ChannelMessageStore, BeanNameAware, InitializingBean, BeanClassLoaderAware

Specialized Redis ChannelMessageStore that uses a list to back a QueueChannel.

Requires setBeanName(String) which is used as part of the key.

Since:

4.0

Author:

Gary Russell, Artem Bilan

Constructor Summary

Constructors

Constructor and Description
RedisChannelMessageStore(RedisConnectionFactory connectionFactory) Construct a message store that uses Java Serialization for messages.

Method Summary

Modifier and Type	Method and Description
MessageGroup	addMessageToGroup(Object groupId, Message<?> message) Store a message with an association to a group id.
void	afterPropertiesSet()
protected String	getBeanName()
int	getMessageCountForAllMessageGroups()
MessageGroup	getMessageGroup(Object groupId) Return all Messages currently in the MessageStore that were stored using BasicMessageGroupStore.addMessageToGroup(Object, Message) with this group id.
int	getMessageGroupCount()
protected MessageGroupFactory	getMessageGroupFactory()
protected RedisTemplate<Object,Message<?>>	getRedisTemplate()
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
void	removeMessageGroup(Object groupId) Remove the message group with this id.
void	setBeanClassLoader(ClassLoader classLoader)
void	setBeanName(String name)
void	setMessageGroupFactory(MessageGroupFactory messageGroupFactory) Specify the MessageGroupFactory to create MessageGroup object where it is necessary.
void	setValueSerializer(RedisSerializer<?> valueSerializer) Use a different serializer (default JdkSerializationRedisSerializer for the Message.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisChannelMessageStore

public RedisChannelMessageStore(RedisConnectionFactory connectionFactory)

Construct a message store that uses Java Serialization for messages.

Parameters:

connectionFactory - The redis connection factory.

Method Detail

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setValueSerializer

public void setValueSerializer(RedisSerializer<?> valueSerializer)

Use a different serializer (default JdkSerializationRedisSerializer for the Message.

Parameters:

valueSerializer - The value serializer.

setMessageGroupFactory

public void setMessageGroupFactory(MessageGroupFactory messageGroupFactory)

Specify the MessageGroupFactory to create MessageGroup object where it is necessary. Defaults to SimpleMessageGroupFactory.

Parameters:

messageGroupFactory - the MessageGroupFactory to use.

Since:

4.3

getMessageGroupFactory

protected MessageGroupFactory getMessageGroupFactory()

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

getBeanName

protected String getBeanName()

getRedisTemplate

protected RedisTemplate<Object,Message<?>> getRedisTemplate()

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

messageGroupSize

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

getMessageGroup

public MessageGroup getMessageGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Return all Messages currently in the MessageStore that were stored using BasicMessageGroupStore.addMessageToGroup(Object, Message) with this group id.

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)

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.

removeMessageGroup

public void removeMessageGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Remove the message group with this id.

Specified by:

removeMessageGroup in interface BasicMessageGroupStore

Parameters:

groupId - The id of the group to remove.

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.

getMessageCountForAllMessageGroups

@ManagedAttribute
public int getMessageCountForAllMessageGroups()

getMessageGroupCount

@ManagedAttribute
public int getMessageGroupCount()