Class RedisQueueInboundChannelAdapterSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<RedisQueueInboundChannelAdapterSpec, RedisQueueMessageDrivenEndpoint>

org.springframework.integration.dsl.MessageProducerSpec<RedisQueueInboundChannelAdapterSpec, RedisQueueMessageDrivenEndpoint>

org.springframework.integration.redis.dsl.RedisQueueInboundChannelAdapterSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<RedisQueueMessageDrivenEndpoint>, InitializingBean, Lifecycle, Phased, SmartLifecycle

public class RedisQueueInboundChannelAdapterSpec
extends MessageProducerSpec<RedisQueueInboundChannelAdapterSpec, RedisQueueMessageDrivenEndpoint>

A MessageProducerSpec for a RedisQueueMessageDrivenEndpoint.

Since:

7.1

Author:

Jiandong Ma

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RedisQueueInboundChannelAdapterSpec(String queueName, RedisConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method	Description
RedisQueueInboundChannelAdapterSpec	expectMessage(boolean expectMessage)	Specify whether expects data from the Redis queue to contain entire Message instances.
RedisQueueInboundChannelAdapterSpec	receiveDuration(Duration receiveTimeout)	Specify the timeout for 'pop' operation to wait for a Redis message from the Redis Queue.
RedisQueueInboundChannelAdapterSpec	receiveTimeout(long receiveTimeout)	Specify the timeout for 'pop' operation to wait for a Redis message from the Redis Queue.
RedisQueueInboundChannelAdapterSpec	recoveryInterval(long recoveryInterval)	Specify the time in milliseconds for the underlying listening task should sleep after exceptions on the 'pop' operation.
RedisQueueInboundChannelAdapterSpec	rightPop(boolean rightPop)	Specify use "right pop" or "left pop" to read messages from the Redis Queue.
RedisQueueInboundChannelAdapterSpec	serializer(RedisSerializer<?> serializer)	Specify the RedisSerializer to deserialize the body of Redis messages.
RedisQueueInboundChannelAdapterSpec	taskExecutor(Executor taskExecutor)	Specify an Executor for the underlying listening task.

Methods inherited from class org.springframework.integration.dsl.MessageProducerSpec

autoStartup, errorChannel, errorChannel, errorMessageStrategy, id, observationConvention, outputChannel, outputChannel, phase, role, sendTimeout, shouldTrack

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Constructor Details

RedisQueueInboundChannelAdapterSpec

protected RedisQueueInboundChannelAdapterSpec(String queueName,
 RedisConnectionFactory connectionFactory)

Method Details

serializer

public RedisQueueInboundChannelAdapterSpec serializer(RedisSerializer<?> serializer)

Specify the RedisSerializer to deserialize the body of Redis messages.

Parameters:

serializer - the serializer

Returns:

the spec

See Also:

• RedisQueueMessageDrivenEndpoint.setSerializer(RedisSerializer)

expectMessage

public RedisQueueInboundChannelAdapterSpec expectMessage(boolean expectMessage)

Specify whether expects data from the Redis queue to contain entire Message instances.

Parameters:

expectMessage - the expectMessage

Returns:

the spec

See Also:

• RedisQueueMessageDrivenEndpoint.setExpectMessage(boolean)

receiveDuration

public RedisQueueInboundChannelAdapterSpec receiveDuration(Duration receiveTimeout)

Specify the timeout for 'pop' operation to wait for a Redis message from the Redis Queue.

Parameters:

receiveTimeout - the receiveTimeout

Returns:

the spec

See Also:

• RedisQueueMessageDrivenEndpoint.setReceiveDuration(Duration)

receiveTimeout

public RedisQueueInboundChannelAdapterSpec receiveTimeout(long receiveTimeout)

Specify the timeout for 'pop' operation to wait for a Redis message from the Redis Queue.

Parameters:

receiveTimeout - the receiveTimeout

Returns:

the spec

See Also:

• RedisQueueMessageDrivenEndpoint.setReceiveTimeout(long)

taskExecutor

public RedisQueueInboundChannelAdapterSpec taskExecutor(Executor taskExecutor)

Specify an Executor for the underlying listening task.

Parameters:

taskExecutor - the taskExecutor

Returns:

the spec

See Also:

• RedisQueueMessageDrivenEndpoint.setTaskExecutor(Executor)

recoveryInterval

public RedisQueueInboundChannelAdapterSpec recoveryInterval(long recoveryInterval)

Specify the time in milliseconds for the underlying listening task should sleep after exceptions on the 'pop' operation.

Parameters:

recoveryInterval - the recoveryInterval

Returns:

the spec

See Also:

• RedisQueueMessageDrivenEndpoint.setRecoveryInterval(long)

rightPop

public RedisQueueInboundChannelAdapterSpec rightPop(boolean rightPop)

Specify use "right pop" or "left pop" to read messages from the Redis Queue.

Parameters:

rightPop - the rightPop

Returns:

the spec

See Also:

• RedisQueueMessageDrivenEndpoint.setRightPop(boolean)