Class RedisChannelPriorityMessageStore

java.lang.Object

org.springframework.integration.redis.store.RedisChannelMessageStore

org.springframework.integration.redis.store.RedisChannelPriorityMessageStore

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanNameAware, InitializingBean, BasicMessageGroupStore, ChannelMessageStore, PriorityCapableChannelMessageStore

public class RedisChannelPriorityMessageStore
extends RedisChannelMessageStore
implements PriorityCapableChannelMessageStore

Specialized Redis PriorityCapableChannelMessageStore that uses lists to back a QueueChannel. Messages are removed in priority order (IntegrationMessageHeaderAccessor.PRIORITY). Priorities 0-9 are supported (9 the highest); invalid priority values are treated with the same priority (none) as messages with no priority header (retrieved after any messages that have a priority).

Requires that groupId is a String.

Since:

4.0

Author:

Gary Russell, Artem Bilan

Constructor Summary

Constructors

Constructor	Description
RedisChannelPriorityMessageStore(RedisConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method	Description
MessageGroup	addMessageToGroup(Object groupId, Message<?> message)	Store a message with an association to a group id.
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()
boolean	isPriorityEnabled()
int	messageGroupSize(Object groupId)	Return the size of this MessageGroup.
@Nullable Message<?>	pollMessageFromGroup(Object groupId)	Poll 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.

Methods inherited from class RedisChannelMessageStore

afterPropertiesSet, getBeanName, getMessageGroupFactory, getRedisTemplate, setBeanClassLoader, setBeanName, setMessageGroupFactory, setValueSerializer

Methods inherited from class Object

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

Constructor Details

RedisChannelPriorityMessageStore

public RedisChannelPriorityMessageStore(RedisConnectionFactory connectionFactory)

Method Details

isPriorityEnabled

public boolean isPriorityEnabled()

Specified by:

isPriorityEnabled in interface PriorityCapableChannelMessageStore

Returns:

true if message priority is enabled in this channel message store.

messageGroupSize

@ManagedAttribute
public int messageGroupSize(Object groupId)

Description copied from interface: BasicMessageGroupStore

Return the size of this MessageGroup.

Specified by:

messageGroupSize in interface BasicMessageGroupStore

Overrides:

messageGroupSize in class RedisChannelMessageStore

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

Overrides:

getMessageGroup in class RedisChannelMessageStore

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

Overrides:

addMessageToGroup in class RedisChannelMessageStore

Parameters:

groupId - The group id to store the message under.

message - A message.

Returns:

The message group.

pollMessageFromGroup

public @Nullable Message<?> pollMessageFromGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Poll Message from this MessageGroup (in FIFO style if supported by the implementation) while also removing the polled Message.

Specified by:

pollMessageFromGroup in interface BasicMessageGroupStore

Overrides:

pollMessageFromGroup in class RedisChannelMessageStore

Parameters:

groupId - The group identifier.

Returns:

The message.

getMessageGroupCount

@ManagedAttribute
public int getMessageGroupCount()

Overrides:

getMessageGroupCount in class RedisChannelMessageStore

removeMessageGroup

public void removeMessageGroup(Object groupId)

Description copied from interface: BasicMessageGroupStore

Remove the message group with this id.

Specified by:

removeMessageGroup in interface BasicMessageGroupStore

Overrides:

removeMessageGroup in class RedisChannelMessageStore

Parameters:

groupId - The id of the group to remove.

getMessageCountForAllMessageGroups

@ManagedAttribute
public int getMessageCountForAllMessageGroups()

Overrides:

getMessageCountForAllMessageGroups in class RedisChannelMessageStore