org.springframework.integration.redis.inbound

Class RedisQueueMessageDrivenEndpoint

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.redis.inbound.RedisQueueMessageDrivenEndpoint

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, MessageProducer, NamedComponent, TrackableComponent

@ManagedResource
 @IntegrationManagedResource
public class RedisQueueMessageDrivenEndpoint
extends MessageProducerSupport
implements ApplicationEventPublisherAware, BeanClassLoaderAware

Since:

3.0

Author:

Mark Fisher, Gunnar Hillert, Artem Bilan, Gary Russell, Rainer Frey, Matthias Jeschke

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_RECEIVE_TIMEOUT
static long	DEFAULT_RECOVERY_INTERVAL

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
RedisQueueMessageDrivenEndpoint(String queueName, RedisConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method and Description
void	clearQueue() Clear the Redis Queue specified by boundListOperations.
protected void	doStart() Takes no action by default.
protected void	doStop() Takes no action by default.
protected void	doStop(Runnable callback) Stop the component and invoke callback.
String	getComponentType() Subclasses may implement this method to provide component type information.
long	getQueueSize() Returns the size of the Queue specified by boundListOperations.
boolean	isListening()
protected void	onInit() Subclasses may implement this for initialization logic.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setBeanClassLoader(ClassLoader beanClassLoader)
void	setExpectMessage(boolean expectMessage) When data is retrieved from the Redis queue, does the returned data represent just the payload for a Message, or does the data represent a serialized Message?.
void	setReceiveTimeout(long receiveTimeout) This timeout (milliseconds) is used when retrieving elements from the queue specified by boundListOperations.
void	setRecoveryInterval(long recoveryInterval)
void	setRightPop(boolean rightPop) Specify if POP operation from Redis List should be BRPOP or BLPOP.
void	setSerializer(RedisSerializer<?> serializer)
void	setTaskExecutor(Executor taskExecutor)

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getMessagingTemplate, getOutputChannel, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

destroy, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Field Detail

DEFAULT_RECEIVE_TIMEOUT

public static final long DEFAULT_RECEIVE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_RECOVERY_INTERVAL

public static final long DEFAULT_RECOVERY_INTERVAL

See Also:

Constant Field Values

Constructor Detail

RedisQueueMessageDrivenEndpoint

public RedisQueueMessageDrivenEndpoint(String queueName,
                                       RedisConnectionFactory connectionFactory)

Parameters:

queueName - Must not be an empty String

connectionFactory - Must not be null

Method Detail

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setSerializer

public void setSerializer(RedisSerializer<?> serializer)

setExpectMessage

public void setExpectMessage(boolean expectMessage)

When data is retrieved from the Redis queue, does the returned data represent just the payload for a Message, or does the data represent a serialized Message?. expectMessage defaults to false. This means the retrieved data will be used as the payload for a new Spring Integration Message. Otherwise, the data is deserialized as Spring Integration Message.

Parameters:

expectMessage - Defaults to false

setReceiveTimeout

public void setReceiveTimeout(long receiveTimeout)

This timeout (milliseconds) is used when retrieving elements from the queue specified by boundListOperations.

If the queue does contain elements, the data is retrieved immediately. However, if the queue is empty, the Redis connection is blocked until either an element can be retrieved from the queue or until the specified timeout passes.

A timeout of zero can be used to block indefinitely. If not set explicitly the timeout value will default to 1000

See also: https://redis.io/commands/brpop

Parameters:

receiveTimeout - Must be non-negative. Specified in milliseconds.

setTaskExecutor

public void setTaskExecutor(Executor taskExecutor)

setRecoveryInterval

public void setRecoveryInterval(long recoveryInterval)

setRightPop

public void setRightPop(boolean rightPop)

Specify if POP operation from Redis List should be BRPOP or BLPOP.

Parameters:

rightPop - the BRPOP flag. Defaults to true.

Since:

4.3

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessageProducerSupport

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class IntegrationObjectSupport

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class MessageProducerSupport

doStop

protected void doStop(Runnable callback)

Description copied from class: AbstractEndpoint

Stop the component and invoke callback.

Overrides:

doStop in class AbstractEndpoint

Parameters:

callback - the Runnable to invoke.

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Takes no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class MessageProducerSupport

isListening

public boolean isListening()

getQueueSize

@ManagedMetric
public long getQueueSize()

Returns the size of the Queue specified by boundListOperations. The queue is represented by a Redis list. If the queue does not exist 0 is returned. See also https://redis.io/commands/llen

Returns:

Size of the queue. Never negative.

clearQueue

@ManagedOperation
public void clearQueue()

Clear the Redis Queue specified by boundListOperations.