Class RedisMessageSendingTemplate

java.lang.Object

org.springframework.messaging.core.AbstractMessageSendingTemplate<ChannelTopic>

org.springframework.data.redis.messaging.RedisMessageSendingTemplate

All Implemented Interfaces:

RedisMessageSendingOperations, DestinationResolvingMessageSendingOperations<ChannelTopic>, MessageSendingOperations<ChannelTopic>

public class RedisMessageSendingTemplate
extends AbstractMessageSendingTemplate<ChannelTopic>
implements RedisMessageSendingOperations

Message-oriented template for publishing to Redis Pub/Sub channels through RedisOperations.

This template bridges Spring Messaging's Message abstraction to Redis Pub/Sub. Destinations are resolved through a DestinationResolver backed by a TopicResolver, and channel names are written by using a String serializer.

In contrast to RedisOperations.convertAndSend(String, Object), which uses the configured value serializer of the underlying RedisOperations, this template delegates payload conversion to a MessageConverter. The default converter is created through RedisMessageConverters.createMessageConverter() and selects a suitable conversion strategy according to the payload type and, if present, the contentType header.

Redis Pub/Sub transmits only the serialized message body. Message headers participate in conversion before publication and are not written to Redis.

Since:

4.1

Author:

Mark Paluch

See Also:

• RedisMessageConverters
• TopicResolver
• TopicDestinationResolver
• MessageHeaders.CONTENT_TYPE

Field Summary

Fields inherited from class AbstractMessageSendingTemplate

CONVERSION_HINT_HEADER, logger

Constructor Summary

Constructors

Modifier	Constructor	Description
	RedisMessageSendingTemplate(RedisOperations<?,?> redisOperations)	Create a new RedisMessageSendingTemplate for the given RedisOperations.
protected	RedisMessageSendingTemplate(RedisOperations<?,?> redisOperations, RedisSerializer<String> stringSerializer)

Method Summary

Modifier and Type	Method	Description
<T> void	convertAndSend(String destinationName, T payload)
<T> void	convertAndSend(String destinationName, T payload, @Nullable Map<String,Object> headers)
<T> void	convertAndSend(String destinationName, T payload, @Nullable Map<String,Object> headers, @Nullable MessagePostProcessor postProcessor)
<T> void	convertAndSend(String destinationName, T payload, @Nullable MessagePostProcessor postProcessor)
protected void	doSend(ChannelTopic destination, Message<?> message)
@Nullable DestinationResolver<ChannelTopic>	getDestinationResolver()	Return the configured destination resolver.
protected final ChannelTopic	resolveDestination(String destinationName)
void	send(String destinationName, Message<?> message)
void	setDestinationResolver(@Nullable DestinationResolver<ChannelTopic> destinationResolver)	Configure the DestinationResolver to use to resolve String destination names into actual destinations of type ChannelTopic.

Methods inherited from class AbstractMessageSendingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, doConvert, getDefaultDestination, getMessageConverter, getRequiredDefaultDestination, processHeadersToSend, send, send, setDefaultDestination, setMessageConverter

Methods inherited from class Object

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

Methods inherited from interface MessageSendingOperations

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, send, send

Constructor Details

RedisMessageSendingTemplate

public RedisMessageSendingTemplate(RedisOperations<?,?> redisOperations)

Create a new RedisMessageSendingTemplate for the given RedisOperations.

Uses the configured string RedisSerializer of RedisTemplate, if available, and otherwise falls back to RedisSerializer.string() for channel serialization.

Parameters:

redisOperations - the Redis operations to use. Must not be null.

RedisMessageSendingTemplate

protected RedisMessageSendingTemplate(RedisOperations<?,?> redisOperations,
 RedisSerializer<String> stringSerializer)

Method Details

setDestinationResolver

public void setDestinationResolver(@Nullable DestinationResolver<ChannelTopic> destinationResolver)

Configure the DestinationResolver to use to resolve String destination names into actual destinations of type ChannelTopic.

Defaults to a TopicDestinationResolver backed by TopicResolver.channel(). Set this property to null only if destination-name based operations are not used.

Parameters:

destinationResolver - the destination resolver to use.

getDestinationResolver

public @Nullable DestinationResolver<ChannelTopic> getDestinationResolver()

Return the configured destination resolver.

Returns:

the configured destination resolver.

send

public void send(String destinationName,
 Message<?> message)
          throws MessagingException

Specified by:

send in interface DestinationResolvingMessageSendingOperations<ChannelTopic>

Throws:

MessagingException

convertAndSend

public <T> void convertAndSend(String destinationName,
 T payload)
                        throws MessagingException

Specified by:

convertAndSend in interface DestinationResolvingMessageSendingOperations<ChannelTopic>

Throws:

MessagingException

convertAndSend

public <T> void convertAndSend(String destinationName,
 T payload,
 @Nullable Map<String,Object> headers)
                        throws MessagingException

Specified by:

convertAndSend in interface DestinationResolvingMessageSendingOperations<ChannelTopic>

Throws:

MessagingException

convertAndSend

public <T> void convertAndSend(String destinationName,
 T payload,
 @Nullable MessagePostProcessor postProcessor)
                        throws MessagingException

Specified by:

convertAndSend in interface DestinationResolvingMessageSendingOperations<ChannelTopic>

Throws:

MessagingException

convertAndSend

public <T> void convertAndSend(String destinationName,
 T payload,
 @Nullable Map<String,Object> headers,
 @Nullable MessagePostProcessor postProcessor)
                        throws MessagingException

Specified by:

convertAndSend in interface DestinationResolvingMessageSendingOperations<ChannelTopic>

Throws:

MessagingException

doSend

protected void doSend(ChannelTopic destination,
 Message<?> message)

Specified by:

doSend in class AbstractMessageSendingTemplate<ChannelTopic>

resolveDestination

protected final ChannelTopic resolveDestination(String destinationName)