Class RedisMetadataStore

java.lang.Object

org.springframework.integration.redis.metadata.RedisMetadataStore

All Implemented Interfaces:

ConcurrentMetadataStore, MetadataStore

public class RedisMetadataStore
extends Object
implements ConcurrentMetadataStore

Redis implementation of ConcurrentMetadataStore. Use this ConcurrentMetadataStore to achieve meta-data persistence across application restarts.

This implementation is based on the RedisProperties and its replace(String, String, String); it can't currently be used with a Redis cluster because the WATCH command is not supported.

Since:

3.0

Author:

Gunnar Hillert, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY

Constructor Summary

Constructors

Constructor	Description
RedisMetadataStore(RedisConnectionFactory connectionFactory)	Initializes the RedisProperties by provided RedisConnectionFactory and default hash key - KEY.
RedisMetadataStore(RedisConnectionFactory connectionFactory, String key)	Initializes the RedisProperties by provided RedisConnectionFactory and key.
RedisMetadataStore(RedisOperations<String,?> operations)	Initializes the RedisProperties by provided RedisConnectionFactory and default hash key - KEY.
RedisMetadataStore(RedisOperations<String,?> operations, String key)	Initializes the RedisProperties by provided RedisConnectionFactory and key.
RedisMetadataStore(RedisProperties properties)	Specifies the RedisProperties backend for this ConcurrentMetadataStore.

Method Summary

Modifier and Type	Method	Description
@Nullable String	get(String key)	Retrieve the persisted value for the provided key.
void	put(String key, String value)	Persists the provided key and value to Redis.
@Nullable String	putIfAbsent(String key, String value)	Atomically insert the key into the store.
@Nullable String	remove(String key)	Remove a value for the given key from this MetadataStore.
boolean	replace(String key, String oldValue, String newValue)	Atomically replace the value for the key in the store if the old value matches the oldValue argument.

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

Constructor Details

RedisMetadataStore

public RedisMetadataStore(RedisProperties properties)

Specifies the RedisProperties backend for this ConcurrentMetadataStore.

Parameters:

properties - The properties.

RedisMetadataStore

public RedisMetadataStore(RedisConnectionFactory connectionFactory)

Initializes the RedisProperties by provided RedisConnectionFactory and default hash key - KEY.

Parameters:

connectionFactory - The connection factory.

RedisMetadataStore

public RedisMetadataStore(RedisConnectionFactory connectionFactory,
 String key)

Initializes the RedisProperties by provided RedisConnectionFactory and key.

Parameters:

connectionFactory - The connection factory.

key - The key.

RedisMetadataStore

public RedisMetadataStore(RedisOperations<String,?> operations)

Initializes the RedisProperties by provided RedisConnectionFactory and default hash key - KEY.

Parameters:

operations - The Redis operations object.

RedisMetadataStore

public RedisMetadataStore(RedisOperations<String,?> operations,
 String key)

Initializes the RedisProperties by provided RedisConnectionFactory and key.

Parameters:

operations - The Redis operations object.

key - The key.

Method Details

put

public void put(String key,
 String value)

Persists the provided key and value to Redis.

Specified by:

put in interface MetadataStore

Parameters:

key - Must not be null

value - Must not be null

get

public @Nullable String get(String key)

Retrieve the persisted value for the provided key.

Specified by:

get in interface MetadataStore

Parameters:

key - Must not be null

Returns:

The value.

remove

public @Nullable String remove(String key)

Description copied from interface: MetadataStore

Remove a value for the given key from this MetadataStore.

Specified by:

remove in interface MetadataStore

Parameters:

key - The key.

Returns:

The previous value associated with key, or null if there was no mapping for key.

putIfAbsent

public @Nullable String putIfAbsent(String key,
 String value)

Description copied from interface: ConcurrentMetadataStore

Atomically insert the key into the store.

Specified by:

putIfAbsent in interface ConcurrentMetadataStore

Parameters:

key - The key.

value - The value.

Returns:

null if successful, the old value otherwise.

replace

public boolean replace(String key,
 String oldValue,
 String newValue)

Description copied from interface: ConcurrentMetadataStore

Atomically replace the value for the key in the store if the old value matches the oldValue argument.

Specified by:

replace in interface ConcurrentMetadataStore

Parameters:

key - The key.

oldValue - The old value.

newValue - The new value.

Returns:

true if successful.