Class RedisOutboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.redis.outbound.RedisOutboundGateway

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class RedisOutboundGateway
extends AbstractReplyProducingMessageHandler

The Gateway component implementation to perform Redis commands with provided arguments and to return command result.

Since:

4.0

Author:

Artem Bilan, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
RedisOutboundGateway(RedisConnectionFactory connectionFactory)
RedisOutboundGateway(RedisTemplate<?,?> redisTemplate)

Method Summary

Modifier and Type	Method	Description
protected void	doInit()
String	getComponentType()
protected @Nullable Object	handleRequestMessage(Message<?> requestMessage)	Subclasses must implement this method to handle the request Message.
void	setArgumentsSerializer(RedisSerializer<?> serializer)
void	setArgumentsStrategy(@Nullable ArgumentsStrategy argumentsStrategy)
void	setCommandExpression(Expression commandExpression)
void	setCommandExpressionString(String commandExpression)

Methods inherited from class AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class MessageHandlerSupport

buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

Methods inherited from class IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface IntegrationManagement

getThisAs

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Constructor Details

RedisOutboundGateway

public RedisOutboundGateway(RedisTemplate<?,?> redisTemplate)

RedisOutboundGateway

public RedisOutboundGateway(RedisConnectionFactory connectionFactory)

Method Details

setArgumentsSerializer

public void setArgumentsSerializer(RedisSerializer<?> serializer)

setCommandExpression

public void setCommandExpression(Expression commandExpression)

Parameters:

commandExpression - the String in SpEL syntax.

Since:

4.3

setCommandExpressionString

public void setCommandExpressionString(String commandExpression)

Parameters:

commandExpression - the String in SpEL syntax.

Since:

4.3

setArgumentsStrategy

public void setArgumentsStrategy(@Nullable ArgumentsStrategy argumentsStrategy)

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

doInit

protected void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected @Nullable Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.