Class RedisStoreOutboundChannelAdapterSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<RedisStoreOutboundChannelAdapterSpec, RedisStoreWritingMessageHandler>

org.springframework.integration.dsl.MessageHandlerSpec<RedisStoreOutboundChannelAdapterSpec, RedisStoreWritingMessageHandler>

org.springframework.integration.redis.dsl.RedisStoreOutboundChannelAdapterSpec

All Implemented Interfaces:

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

public class RedisStoreOutboundChannelAdapterSpec
extends MessageHandlerSpec<RedisStoreOutboundChannelAdapterSpec, RedisStoreWritingMessageHandler>

A MessageHandlerSpec for a RedisStoreWritingMessageHandler.

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	RedisStoreOutboundChannelAdapterSpec(RedisConnectionFactory connectionFactory)
protected	RedisStoreOutboundChannelAdapterSpec(RedisTemplate<String,?> redisTemplate)

Method Summary

Modifier and Type	Method	Description
RedisStoreOutboundChannelAdapterSpec	collectionType(RedisCollectionFactoryBean.CollectionType collectionType)	Specify the collection type.
RedisStoreOutboundChannelAdapterSpec	extractPayloadElements(boolean extractPayloadElements)	Specify whether payload elements should be extracted.
RedisStoreOutboundChannelAdapterSpec	key(String key)	Specify the key for the Redis store.
RedisStoreOutboundChannelAdapterSpec	keyExpression(String keyExpression)	Specify a SpEL Expression to be used to determine the key for the Redis store.
RedisStoreOutboundChannelAdapterSpec	keyExpression(Expression keyExpression)	Specify an Expression to be used to determine the key for the Redis store.
RedisStoreOutboundChannelAdapterSpec	keyFunction(Function<Message<?>, String> keyFunction)	Specify a KeyFunction to be used to determine the key for the Redis store.
RedisStoreOutboundChannelAdapterSpec	mapKeyExpression(String mapKeyExpression)	Specify the SPEL expression used as the key for Map and Properties entries.
RedisStoreOutboundChannelAdapterSpec	mapKeyExpression(Expression mapKeyExpression)	Specify the expression used as the key for Map and Properties entries.
RedisStoreOutboundChannelAdapterSpec	mapKeyFunction(Function<Message<?>, String> mapKeyFunction)	Specify the function used as the key for Map and Properties entries.
RedisStoreOutboundChannelAdapterSpec	zsetIncrementScoreExpression(String zsetIncrementScoreExpression)	Specify the SPEL expression used as the INCR flag for the ZADD command in case of ZSet collection.
RedisStoreOutboundChannelAdapterSpec	zsetIncrementScoreExpression(Expression zsetIncrementScoreExpression)	Specify the expression used as the INCR flag for the ZADD command in case of ZSet collection.
RedisStoreOutboundChannelAdapterSpec	zsetIncrementScoreFunction(Function<Message<?>, Boolean> zsetIncrementScoreFunction)	Specify the function used as the INCR flag for the ZADD command in case of ZSet collection.

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

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, 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

RedisStoreOutboundChannelAdapterSpec

protected RedisStoreOutboundChannelAdapterSpec(RedisTemplate<String,?> redisTemplate)

RedisStoreOutboundChannelAdapterSpec

protected RedisStoreOutboundChannelAdapterSpec(RedisConnectionFactory connectionFactory)

Method Details

key

public RedisStoreOutboundChannelAdapterSpec key(String key)

Specify the key for the Redis store.

Parameters:

key - the key

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setKey(String)

keyExpression

public RedisStoreOutboundChannelAdapterSpec keyExpression(String keyExpression)

Specify a SpEL Expression to be used to determine the key for the Redis store.

Parameters:

keyExpression - the keyExpression

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setKeyExpressionString(String)

keyExpression

public RedisStoreOutboundChannelAdapterSpec keyExpression(Expression keyExpression)

Specify an Expression to be used to determine the key for the Redis store.

Parameters:

keyExpression - the keyExpression

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setKeyExpression(Expression)

keyFunction

public RedisStoreOutboundChannelAdapterSpec keyFunction(Function<Message<?>, String> keyFunction)

Specify a KeyFunction to be used to determine the key for the Redis store.

Parameters:

keyFunction - the keyFunction

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setKeyExpression(Expression)

collectionType

public RedisStoreOutboundChannelAdapterSpec collectionType(RedisCollectionFactoryBean.CollectionType collectionType)

Specify the collection type. supported collections are LIST, SET, ZSET, PROPERTIES, and MAP.

Parameters:

collectionType - the collectionType

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setCollectionType(CollectionType)

extractPayloadElements

public RedisStoreOutboundChannelAdapterSpec extractPayloadElements(boolean extractPayloadElements)

Specify whether payload elements should be extracted.

Parameters:

extractPayloadElements - the extractPayloadElements

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setExtractPayloadElements(boolean)

mapKeyExpression

public RedisStoreOutboundChannelAdapterSpec mapKeyExpression(String mapKeyExpression)

Specify the SPEL expression used as the key for Map and Properties entries.

Parameters:

mapKeyExpression - the mapKeyExpression

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setMapKeyExpressionString(String)

mapKeyExpression

public RedisStoreOutboundChannelAdapterSpec mapKeyExpression(Expression mapKeyExpression)

Specify the expression used as the key for Map and Properties entries.

Parameters:

mapKeyExpression - the mapKeyExpression

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setMapKeyExpression(Expression)

mapKeyFunction

public RedisStoreOutboundChannelAdapterSpec mapKeyFunction(Function<Message<?>, String> mapKeyFunction)

Specify the function used as the key for Map and Properties entries.

Parameters:

mapKeyFunction - the mapKeyFunction

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setMapKeyExpression(Expression)

zsetIncrementScoreExpression

public RedisStoreOutboundChannelAdapterSpec zsetIncrementScoreExpression(String zsetIncrementScoreExpression)

Specify the SPEL expression used as the INCR flag for the ZADD command in case of ZSet collection.

Parameters:

zsetIncrementScoreExpression - the zsetIncrementScoreExpression

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setZsetIncrementExpressionString(String)

zsetIncrementScoreExpression

public RedisStoreOutboundChannelAdapterSpec zsetIncrementScoreExpression(Expression zsetIncrementScoreExpression)

Specify the expression used as the INCR flag for the ZADD command in case of ZSet collection.

Parameters:

zsetIncrementScoreExpression - the zsetIncrementScoreExpression

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setZsetIncrementExpression(Expression)

zsetIncrementScoreFunction

public RedisStoreOutboundChannelAdapterSpec zsetIncrementScoreFunction(Function<Message<?>, Boolean> zsetIncrementScoreFunction)

Specify the function used as the INCR flag for the ZADD command in case of ZSet collection.

Parameters:

zsetIncrementScoreFunction - the zsetIncrementScoreFunction

Returns:

the spec

See Also:

• RedisStoreWritingMessageHandler.setZsetIncrementExpression(Expression)